Skip to content

docs: remove contribution guidelines for expressjs.com in contributing page #1925

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

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

bjohansebas
Copy link
Member

It's a nice attempt, but there are other ways for people to help with the documentation. In the end, this is a document that should be split into multiple pages, since it's quite long and very few people actually read it because of its length (especially if we add something specific from the documentation repo)

I'll leave the script logic here in case we need it in the future.

Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
@bjohansebas bjohansebas requested review from a team as code owners May 28, 2025 03:34
Copy link

netlify bot commented May 28, 2025

Deploy Preview for expressjscom-preview ready!

Name Link
🔨 Latest commit 06c427b
🔍 Latest deploy log https://app.netlify.com/projects/expressjscom-preview/deploys/68377924566afb0008d95fdb
😎 Deploy Preview https://deploy-preview-1925--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@bjohansebas bjohansebas changed the title docs: remove contribution guidelines for expressjs.com docs: remove contribution guidelines for expressjs.com in contributing page May 28, 2025
@chrisdel101
Copy link
Contributor

chrisdel101 commented May 28, 2025

hey @bjohansebas, i haven’t been around for awhile just saw this and was a bit confused. how do you know nobody reads it? or that it’s too long?
how can documentation be too long?

It was a lot of work to create this content. I’d hope you have good reasons for just removing it completely :)

@bjohansebas
Copy link
Member Author

Hi @chrisdel101,

I'm just removing it from that page because it's quite long. I know you did a great job improving that section, and it’s definitely been helpful (thank you!), but that part will only be read by someone specifically interested in contributing to the website (and if they want to contribute, they’ll find the info here: https://github.com/expressjs/expressjs.com/blob/gh-pages/CONTRIBUTING.md). Also, this page should focus more on contributing to Express and its overall ecosystem rather than the website itself (although, honestly, this page should probably be split into multiple pages anyway) plus, it adds more content to translate via Crowdin.

I'm just trying to make the website content as useful and simple as possible. WDYT?

@ShubhamOulkar
Copy link
Member

this page should probably be split into multiple pages anyway) plus, it adds more content to translate via Crowdin.

I am agreed.

It was a lot of work to create this content. I’d hope you have good reasons for just removing it completely :)

I don't think we need to remove all content, we need to update content with newer changes and creating new pages.

@chrisdel101
Copy link
Contributor

chrisdel101 commented May 28, 2025

Ahh okay. It sounds like you have some specific ideas and I might just be misunderstanding while thinking the same.

Having it moved to a different URL for the website alone would be great - or not? Is what you were thinking?

Having it in repo alone is fine but we have a website so we should use it, no?
Optimally (in my mind) the website would have it's own contributing page. I mean, I contribute to the website and not express itself (much) and so I'm an example of someone that this would appeal to.

This approach (website contributing page) was shut down before, hence the need to put in the same file as the express contrib and use that complicated script to key things dry.

If you want to actually cut the CONTRIBUTING.md itself from the repo (which is what I thought you meant) you could revert to the version before that PR. It was much more concise.

Make sure to remove the link at the top of the contributing.html page as it is now dead.

@bjohansebas
Copy link
Member Author

If you want to actually cut the CONTRIBUTING.md itself from the repo (which is what I thought you meant) you could revert to the version before that PR. It was much more concise

The file located here i don’t intend to delete it and it shouldn’t be deleted, but I think it’s unnecessary to have it on the website page.

The content of this file is actually fine, it has what’s needed and helps new contributors understand how the website is developed, the previous version was missing some things.

Optimally (in my mind) the website would have it's own contributing page. I mean, I contribute to the website and not express itself (much) and so I'm an example of someone that this would appeal to.

I really don’t think we should have a dedicated section on the website for contributing to the page. It makes sense to have it in the repository, but not on the website. If someone wants to contribute, they will go to the repository.

Anyway, if you don’t agree, you can block the PR and reach a consensus.

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