Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README and docs restructure #362

Merged
merged 61 commits into from
Jan 25, 2024
Merged

README and docs restructure #362

merged 61 commits into from
Jan 25, 2024

Conversation

ChaosInTheCRD
Copy link
Collaborator

What this PR does / why we need it

It tidies up and fleshes out the documentation in the repository. It is by no means finished, but progress made on what currently is in the upstream.

@ChaosInTheCRD
starting proposed restructure
41335ef 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding latest changes to README
43375bd 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
fixed link to contributing md
0a0280f 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
made title title heading size
03fada4 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
named the file wrong - doh
96ab9df 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
resizing headings at top
68c38e1 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
added spacing
ab1628f 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
a few more fixes
142a017 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding background section
03cd875 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
removing bullet
a5c2cec 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
final neatening
d70b8a0 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
updated docs further - tutorial not working
545e3b0 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding demo gif
0c0618d 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding docusaurus stuff and more progress
bbee6c2 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
saving progress, including docusaurus website
7603bf2 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
changing logo
c643b9d 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding snowfall
1922341 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding the concepts section
a335e30 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
Adding the contributing.md from archivista (in-toto#327)
1ca4e7f 
* adding the contributing.md from archivista

* dont need jq

Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD ChaosInTheCRD force-pushed the readme-docs-restructure branch from 8c5f81f to 2e51cd2 Compare January 19, 2024 12:10
ChaosInTheCRD and others added 10 commits January 19, 2024 12:12
@ChaosInTheCRD @jkjell
Migrating go module (in-toto#328)
5fc24e7 
* added all imports

* fixing go sum

* changing go-witness back for now, makes more sense

---------

Co-authored-by: John Kjell <[email protected]>
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
Migrating to the use of in-toto/go-witness module (in-toto#331)
b2c373d 
* added all imports

* fixing go sum

* changing go-witness back for now, makes more sense

* moved witness to using new in-toto/go-witness module

Signed-off-by: chaosinthecrd <[email protected]>

* adding change to test now following newer version of policy

* running docgen as changes found from use of new module

* pinning to v0.2.0 of archivista and go-witness

Signed-off-by: chaosinthecrd <[email protected]>

---------

Signed-off-by: chaosinthecrd <[email protected]>
Signed-off-by: Tom Meadows <[email protected]>
@ChaosInTheCRD
Bumping Go version for goreleaser (in-toto#333)
f900d61 
bumping go version for goreleaser

Signed-off-by: chaosinthecrd <[email protected]>
@dependabot @ChaosInTheCRD
chore: bump actions/download-artifact from 3.0.2 to 4.0.0 (in-toto#335)
5506a27 
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 3.0.2 to 4.0.0.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@9bc31d5...7a1cd32)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @jkjell @ChaosInTheCRD
chore: bump github/codeql-action from 2.22.9 to 3.22.11 (in-toto#336)
b7c9ba5 
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2.22.9 to 3.22.11.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@c0d1daa...b374143)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: John Kjell <[email protected]>
@dependabot @jkjell @ChaosInTheCRD
chore: bump actions/upload-artifact from 3.1.3 to 4.0.0 (in-toto#337)
31591ec 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3.1.3 to 4.0.0.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@a8a3f3a...c7d193f)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: John Kjell <[email protected]>
@dependabot @ChaosInTheCRD
chore: bump github/codeql-action from 3.22.11 to 3.22.12 (in-toto#343)
4f669ed 
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.22.11 to 3.22.12.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@b374143...012739e)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @ChaosInTheCRD
chore: bump actions/download-artifact from 4.0.0 to 4.1.0 (in-toto#342)
25f7c82 
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@7a1cd32...f44cd7b)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@ChaosInTheCRD
moving config doc
ffecc71 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
adding latest changes
604c3cb 
Signed-off-by: chaosinthecrd <[email protected]>
jkjell and others added 3 commits January 19, 2024 12:12
@ChaosInTheCRD ChaosInTheCRD force-pushed the readme-docs-restructure branch from 2e51cd2 to aa0d833 Compare January 19, 2024 12:16
ChaosInTheCRD and others added 11 commits January 19, 2024 12:17
@ChaosInTheCRD
Add signing to goreleaser and Best Practices badge to readme.
9983e7f 
Signed-off-by: John Kjell <[email protected]>
Signed-off-by: chaosinthecrd <[email protected]>
@jkjell @ChaosInTheCRD
Add cosign install
1942218 
Signed-off-by: John Kjell <[email protected]>
@jkjell @ChaosInTheCRD
Update cloudflare/circl due to dependabot failure (in-toto#352)
7d0ae70 
Signed-off-by: John Kjell <[email protected]>
@ChaosInTheCRD
updated package json
5ee544d 
Signed-off-by: chaosinthecrd <[email protected]>
@dependabot @ChaosInTheCRD
chore: bump actions/cache from 3.3.2 to 3.3.3 (in-toto#355)
c3af51d 
Bumps [actions/cache](https://github.com/actions/cache) from 3.3.2 to 3.3.3.
- [Release notes](https://github.com/actions/cache/releases)
- [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
- [Commits](actions/cache@704facf...e12d46a)

---
updated-dependencies:
- dependency-name: actions/cache
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @ChaosInTheCRD
chore: bump actions/upload-artifact from 4.0.0 to 4.1.0 (in-toto#356)
87ff0e1 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@c7d193f...1eb3cb2)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @ChaosInTheCRD
chore: bump github/codeql-action from 3.22.12 to 3.23.0 (in-toto#357)
249e5aa 
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.22.12 to 3.23.0.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@012739e...e5f05b8)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @ChaosInTheCRD
chore: bump actions/download-artifact from 4.1.0 to 4.1.1 (in-toto#358)
647b6dd 
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@f44cd7b...6b208ae)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@jkjell @ChaosInTheCRD
Initial attempt at PR and Issue templates (in-toto#351)
604b6b4 
* Initial attempt at PR and Issue templates

Signed-off-by: John Kjell <[email protected]>

* Address some review feedback

Signed-off-by: John Kjell <[email protected]>

---------

Signed-off-by: John Kjell <[email protected]>
Co-authored-by: Tom Meadows <[email protected]>
@ChaosInTheCRD
Checking attestors for duplicates (in-toto#361)
8c7b796 
* prevents duplicate attestors
* adding tests
* modified help for attestations flag
---------

Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
removing witness website for now
b15e4e6 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD ChaosInTheCRD force-pushed the readme-docs-restructure branch from aa0d833 to b15e4e6 Compare January 19, 2024 12:17
@ChaosInTheCRD
Merge branch 'main' of github.com:in-toto/witness into readme-docs-re…
8478623 
…structure

Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
editing image links
c51520f 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
updating docgen
ee81560 
Signed-off-by: chaosinthecrd <[email protected]>
@ChaosInTheCRD
fixing docgen
07490b1 
Signed-off-by: chaosinthecrd <[email protected]>
jkjell
jkjell reviewed Jan 23, 2024
View reviewed changes
Copy link
Member

@jkjell jkjell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a great improvement! Just a couple questions. I didn't take a close read or try the tutorials so, let me know if we need an extra look at those.

docgen/docs.go
Comment on lines +52 to +53
// Write the combined markdown content to a file
err := os.WriteFile(fmt.Sprintf("%s/commands.md", directory), []byte(mdContent), 0644)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does having separate files make rendering on the new docs website easier?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So again docs website related. I actually felt it was neater to present all the commands on a single page. This is something we can discuss / consider further though 😄 .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. Ship it for now, and we can revisit based on feedback after the new site is up.

@ChaosInTheCRD
fixed ellipsis
c8b4137 
Signed-off-by: chaosinthecrd <[email protected]>
@jkjell
Copy link
Member

jkjell commented Jan 24, 2024

@ChaosInTheCRD I'll let you merge to give this a coherent commit message. 😅

@ChaosInTheCRD ChaosInTheCRD merged commit b90f41b into in-toto:main Jan 25, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkjell jkjell jkjell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ChaosInTheCRD @jkjell