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

Revise and consolidate documentation #284

Closed
lukpueh opened this issue May 8, 2019 · 0 comments · Fixed by #369
Closed

Revise and consolidate documentation #284

lukpueh opened this issue May 8, 2019 · 0 comments · Fixed by #369

Comments

@lukpueh
Copy link
Member

lukpueh commented May 8, 2019

Description of issue or feature request:
In addition to #276, which deals with a technical overhaul of the documentation, we should also revise and consolidate in-toto documentation and supporting material which is scattered across multiple repos of the in-toto GitHub organization.

This issue is motivated by feedback from @ultrasaurus in in-toto/specification#15 (comment).

Current behavior:
in-toto documentation is available in various places, most notably:

Expected behavior:
Revise up-to-dateness and suitedness of different docs for their respective purposes.

From in-toto/specification#15 (comment):

  • add contextual information and a strong narrative around a typical use case
  • spell out demo simple workflow (e.g. with numbered list: checkin code, run tests, release software artifact)
  • re-think role names (Alice, Bob and Carl)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant