Move documentation to the Admin repository #5512
Conversation
| @@ -115,6 +115,10 @@ $ npm install | |||
| $ node examples/content-negotiation | |||
There was a problem hiding this comment.
Am I missing it in here or are we not linking all the docs? Are we consolidating them in the admin repo so we don't need to link them all individually?
There was a problem hiding this comment.
this folder is full of examples with multiple implementations (and with different modules). I think it would be great to move all that in the https://github.com/expressjs/examples (or somewhere else)
There was a problem hiding this comment.
sorry, that was not meant as a comment on the line specifically but the entire change in this file. I don't see all the docs linked, just a couple. Are we going to simplify them in the new repo? Or do we need to add more links to this readme change?
There was a problem hiding this comment.
I am reviewing that, but for most of them they are linked between them with only 2-3 entrypoints.
But we may also use this occasion to see if there is some changes in all the documents that we need to implement (even if this would be easier to merge that without changes, and then apply the changes in the docs/charters in a following PR)
|
Actually one other question, there may be some foundation wide guidance on where the charter and CoC at least goes, maybe we can leave those here for now? |
Good point! I will ask and see what would be the recommendation (or requirement - maybe the CoC need to be part of all projects for example) |
There was a problem hiding this comment.
I am a +1 with the change, just a minor comment from my side...
If we remove certain files like Security.md or Code-Of-Conduct.md we might end up loosing this quick access links from the navbar:
Also this might have a negative impact in other tooling used to evaluate OSS project health, this can be easily mitigated with this change: expressjs/Admin#2 (review)
I will suggest to don't merge this PR before expressjs/Admin#2 is landed :-)
|
Strong agree that we cannot merge this until we have things sorted and stable over there. I also still think that for the Charter, contributing, and maybe even CoC we need a skeleton doc in every repo which links out to the main content ones. Something like:
|
As per expressjs/discussions#200, moving all the documents that explain how the Express.js project is handled to a specific Admin repository. This will allow the organization to have one setup of the files (documentation, charters...), lowering the maintenance needed for update.
Blocked by: expressjs/Admin#2 (to validate the files organization)