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

Suggested doc: Documentation home best practices #93

Open
nate-double-u opened this issue Dec 7, 2021 · 0 comments
Open

Suggested doc: Documentation home best practices #93

nate-double-u opened this issue Dec 7, 2021 · 0 comments
Labels
documentation Improvements or additions to the TechDocs documentation e2-days Effort: < 5 days

Comments

@nate-double-u
Copy link
Member

Where should documentation be housed in reference to a project's code repository?

  1. Documentation should be separate from the code, preferably in it's own website repository. Avoid duplication, source of truth for documentation is the website
  2. Documentation should be stored in the primary code repo, closest to the system being documented. Monorepo-style tools/organization can be used to generate a website from there
  3. Other(?)

I think that the TechDocs team tends towards option a., but each project is unique and other options are valid. I think we should put together a document that outlines our arguments for and against different strategies so we can refer to it as we're helping projects make decisions around how to setup their docs repositories.

@nate-double-u nate-double-u added documentation Improvements or additions to the TechDocs documentation e2-days Effort: < 5 days best practices labels Dec 7, 2021
@settings settings bot removed the best practices label Jan 27, 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 the TechDocs documentation e2-days Effort: < 5 days
Projects
None yet
Development

No branches or pull requests

1 participant