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

Documentation working group #1506

Open
crandmck opened this issue May 2, 2024 · 15 comments
Open

Documentation working group #1506

crandmck opened this issue May 2, 2024 · 15 comments
Labels

Comments

@crandmck
Copy link
Member

crandmck commented May 2, 2024

We have an existing team @expressjs/expressjs-com-collaborators for people who want to help with Express docs and which has triage rights in the repo.

I'd like to invite @chrisdel101 and @inigomarquinez to join this team, as they recently had PRs merged. Please reply in the comments to this issue if you're interested and I'll add you!

Anyone else who has recently had a PR merged is also welcome--please just speak up. As we land PRs from others, we can invite them as well.

Also--the current team name expressjs/expressjs-com-collaborators is somewhat unwieldy and doesn't come up easily in the GH typeahead match. So I'd like to change the name of the team to expressjs/docs-wg. I don't imagine that anyone will object to that, but I'll wait a while before renaming it to make sure.

@chrisdel101
Copy link
Contributor

Yeah I'll help with this!

@inigomarquinez
Copy link
Member

Hi @crandmck !

I'll also try to help with this :)

@crandmck
Copy link
Member Author

crandmck commented May 6, 2024

Welcome!

@crandmck
Copy link
Member Author

As promised, I changed the name of the team to @expressjs/docs-wg

@annuk123
Copy link

I also want to work on this

@crandmck
Copy link
Member Author

Hi @annuk123! Thanks for your interest. The best way to get involved is to find an open issue and open a PR to address it. Then we'll be happy to invite you to the docs wg. If you need any further guidance, feel free to ask here or in a separate issue if it's appropriate.

@carlosstenzel
Copy link
Contributor

congratulations @chrisdel101 @inigomarquinez

@bjohansebas
Copy link
Member

I want to join

@crandmck
Copy link
Member Author

crandmck commented Aug 5, 2024

Welcome @bjohansebas !

@bjohansebas
Copy link
Member

Thanks for this opportunity

@carlosstenzel
Copy link
Contributor

I want to join too _

@crandmck
Copy link
Member Author

Welcome @carlosstenzel !
Sorry for the delay, I've been on vacation ...

@chrisdel101
Copy link
Contributor

I think we should add a changes to the contributing page stating that features should be proposed and approved first via issues, before they are made as PRs.

This is because people are putting in effort with great intentions, but then sometimes their work does not match with an immediate need in the application and cannot be used. Nobody likes to have wasted time on a PR that doesn't get merged.

Maybe we can make this clear in the CONTRIBUTING.md? Just wanted to see if there was consensus.
If so, I can add something to start and we can refine it.

@crandmck
Copy link
Member Author

crandmck commented Aug 25, 2024

I think that's a great idea, @chrisdel101 ... something that has indeed come up repeatedly. I just haven't had the bandwidth to address it, so I would appreciate it if you would!

Also, I think we should either link to or incorporate the contents of https://github.com/expressjs/expressjs.com/blob/gh-pages/CONTRIBUTING.md into a "Contributing to documentation" section in https://expressjs.com/en/resources/contributing.html.

@juliogarciape
Copy link

juliogarciape commented Sep 16, 2024

@crandmck I would love to join this team. This year I discovered the hobby of contributing to open source projects and it feels rewarding to have your code used by thousands of people.

I recently contributed bugfixes and translations for the official documentation repositories of React, Docker, and Quicksilver where my PRs were merged.

I hope to help a lot if they manage to accept me.

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

7 participants