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

doc cleanup in progress #2151

Closed
sam-github opened this issue Jan 29, 2020 · 5 comments
Closed

doc cleanup in progress #2151

sam-github opened this issue Jan 29, 2020 · 5 comments
Labels

Comments

@sam-github
Copy link
Contributor

Just a note, after @AshCripps centralized admin processes into GOVERNANCE.md, I did a search of the repo for other docs, and found some I'd never even realized existed. I think the READMEs deep in the repo that are strongly associated with a specific tool are reasonable, ditto for the ansible docs in ansible/, but in the absence of a strong reason for the contrary, its generally better to have our docs in one place for ease of discovery and maintenance.

Its probably worth having a TOC in the top-level README.md, I might take a shot at that once these PRs have landed and the layout is more stable.

@richardlau
Copy link
Member

+1 to a TOC.

I don't object to things being documented in separate files where it makes sense to do so as long as there's no duplication and they are referenced/indexed from the top-level README/GOVERNANCE.

@sam-github
Copy link
Contributor Author

Note that what I have a problem with isn't seperate files, its the indistinguishable-from-random location of those files. I'm not sure how I could justify the organizational guidelines which leads to doc/jenkins-guide.md and jenkins/doc/add-worker-firewall-entry.md and jenkins/jobs.md being in three different directories.

The locations are just historical, and no longer helpful.

@mhdawson
Copy link
Member

+1 for a TOC and moving docs into a better structure. I'm sure it made sense when each was added forr some reason, but we can probably better organize now.

@sam-github
Copy link
Contributor Author

also: #2156

@github-actions
Copy link

github-actions bot commented Dec 1, 2020

This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants