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

Move documentation to the Admin repository #5512

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sheplu
Copy link
Member

@sheplu sheplu commented Feb 29, 2024

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)

@@ -115,6 +115,10 @@ $ npm install
$ node examples/content-negotiation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@wesleytodd
Copy link
Member

wesleytodd commented Feb 29, 2024

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?

@sheplu
Copy link
Member Author

sheplu commented Feb 29, 2024

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)

Copy link
Member

@UlisesGascon UlisesGascon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Screenshot 2024-03-01 at 09 59 37

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 :-)

@wesleytodd
Copy link
Member

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:

The Express project is made up of many components, we use s centralized copy of the CoC found here.

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

Successfully merging this pull request may close these issues.

3 participants