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

Develop a reference doc contribution policy #28

Closed
3 tasks
Tracked by #221
jbogarthyde opened this issue Feb 2, 2024 · 3 comments · Fixed by #32
Closed
3 tasks
Tracked by #221

Develop a reference doc contribution policy #28

jbogarthyde opened this issue Feb 2, 2024 · 3 comments · Fixed by #32
Labels
documentation Improvements or additions to documentation

Comments

@jbogarthyde
Copy link

jbogarthyde commented Feb 2, 2024

UPDATE 05/27/2024 (transfer issue from in-toto/docs)

  • Specify how and where developers provide reference docs for new implementations.
    Reference documentation should go with the implementation repo in GitHub, with sources and generation information in a doc subdirectory.
  • Specify what to document for an implementation.
    Use the Python Reference Implementation's reference docs to see what needs to be documented.
    These are generated using source files and a makefile in the implementation's doc subdirectory.
  • Add the policy to https://github.com/in-toto/community/blob/main/CONTRIBUTING.md
@JustinCappos JustinCappos added the documentation Improvements or additions to documentation label Mar 19, 2024
@lukpueh lukpueh transferred this issue from in-toto/specification May 27, 2024
@lukpueh
Copy link
Member

lukpueh commented May 27, 2024

... with sources and generation information in a doc subdirectory.

There might be programming language-specific best practices for setting up reference documentation.

I think we don't need a policy for where a subproject hosts their docs, but instead recommend that a link to the docs should be included in project wide docs.

@Ayush9026
Copy link

@lukpueh sir will raise PR for this issue.

@DarikshaAnsari
Copy link
Contributor

@lukpueh doc subdirectory link is broken

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

Successfully merging a pull request may close this issue.

5 participants