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 CONTRIBUTING.md to documentation site #2008

Closed
AetherUnbound opened this issue May 3, 2023 · 7 comments · Fixed by #2030
Closed

Move CONTRIBUTING.md to documentation site #2008

AetherUnbound opened this issue May 3, 2023 · 7 comments · Fixed by #2030
Assignees
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation

Comments

@AetherUnbound
Copy link
Contributor

Description

Our current contributing guide exists locally in the repository: https://github.com/WordPress/openverse/blob/523a3599c34463275ce57c4e4ce6c14de1baefbd/CONTRIBUTING.md

It would be ideal to move this into the documentation site at docs.openverse.org, where most of our other quickstart/contributor information exists!

Note: When we convert this into Sphinx, we should also emphasize further the verbiage about choosing more than one good first issue - https://github.com/WordPress/openverse/blob/209cd44abed611ae4a2ef97ea77e8d2b0b612a53/CONTRIBUTING.md#friendly-notes (we've had a few folks ask about this, so it seems useful to highlight it better).

This would involve moving the file from it's current position into documentation/general, adding a callout for the above using a MyST callout, and then linking from the current CONTRIBUTING.md to the new location on the docs site.

@AetherUnbound AetherUnbound added good first issue New-contributor friendly help wanted Open to participation from the community 📄 aspect: text Concerns the textual material in the repository 🟩 priority: low Low priority and doesn't need to be rushed 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: documentation Related to Sphinx documentation labels May 3, 2023
@shivamganwani
Copy link
Contributor

@AetherUnbound I'd like to pick this up

@zackkrida
Copy link
Member

Thanks, @shivamganwani! Please just ping @WordPress/openverse-maintainers here if you have any questions 😄

@shivamganwani
Copy link
Contributor

@WordPress/openverse-maintainers
I think I found an issue, not sure.
In the Contributing section of the Readme there is this line See the [CONTRIBUTING.md](https://github.com/WordPress/openverse/blob/main/CONTRIBUTING.md) file for details.

Now I click on the link and it takes me to contributing guidelines page. All good till now.
Now I scroll down and there is a part where the below links are present

[GitHub contribution practices](https://docs.openverse.org/reference/github_contribution_practices.html)
[Dev flow](https://docs.openverse.org/reference/dev_flow.html)
[General setup guide](https://docs.openverse.org/guides/general_setup.html)
[Quickstart guide](https://docs.openverse.org/guides/quickstart.html)

Here comes the issue, all these links take me to 404 Not found. Can someone explain if this is really an issue or am I doing something wrong.

@AetherUnbound
Copy link
Contributor Author

Ah, great find @shivamganwani! We recently restructured our documentation (#1846) and that probably caused all those links to break. Here are the new ones:

[GitHub contribution practices](https://docs.openverse.org/meta/github_contribution_practices.html)
[Dev flow](https://docs.openverse.org/meta/dev_flow.html)
[General setup guide](https://docs.openverse.org/general/general_setup.html)
[Quickstart guide](https://docs.openverse.org/general/quickstart.html)

@shivamganwani
Copy link
Contributor

@AetherUnbound so we're making a separate ticket or fixing this in this one?

@AetherUnbound
Copy link
Contributor Author

Do you mind including that in your changes in #2030? 😄

@shivamganwani
Copy link
Contributor

Not at all @AetherUnbound

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants