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.

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

Write better documentation #21

Closed
mikhailswift opened this issue Dec 9, 2021 · 4 comments
Closed

Write better documentation #21

mikhailswift opened this issue Dec 9, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@mikhailswift
Copy link
Collaborator

The root README should be updated with a project description and relevant information. it can still include the CLI documentation or we can create a separate md in a docs folder detailing the CLI.

We should also create some examples of using witness.

@mikhailswift mikhailswift added the documentation Improvements or additions to documentation label Dec 9, 2021
@colek42
Copy link
Member

colek42 commented Dec 10, 2021

I'd like to do the following

Main Readme:

  • Link to GitHub pages site
  • Witness Logo
  • Gif of witness example
  • Text of the commands in the example gif
  • Generated CLI documentation

Documentation:
We can start with just a /docs folder but would like to have a githubpages site ready to go at launch.

I've had good luck with docusaurus in the past, but open to options. https://docusaurus.io/docs/deployment#deploying-to-github-pages

@colek42 colek42 added this to the Initial Release milestone Dec 10, 2021
@flickerfly
Copy link
Contributor

I'm especially interested in the gitlab docs and some sort of architecture diagram. For example, I'm trying to figure out if there is a central server that stores the attestation details or anything like that or if I need to build a workload around managing that, especially in an air gap space.

@colek42
Copy link
Member

colek42 commented Dec 11, 2021

It depends on your trust model. Using keyless signing would require some sort of timestamp authority. In our current model, we use rekor (https://log.testifysec.io) for transparency and timestamping. These attestations are json objects that can be airgapped and verified in the target environment. The trust is maintained by the certificate authority, as long as you have a trusted CA on both ends you should be good.

I've created an issue here to track air-gapped verification.

@flickerfly
Copy link
Contributor

Thanks @colek42

@colek42 colek42 closed this as completed Feb 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants