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

Update project thread issue template to mention using docs.openverse.org links for plans #2011

Open
zackkrida opened this issue May 3, 2023 · 2 comments · May be fixed by #5185
Open

Update project thread issue template to mention using docs.openverse.org links for plans #2011

zackkrida opened this issue May 3, 2023 · 2 comments · May be fixed by #5185
Assignees
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 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

@zackkrida
Copy link
Member

zackkrida commented May 3, 2023

Problem

Currently in our project thread issue bodies we link to the pull requests for implementation plans and project plans.

If documents are given addendums, as discussed in #2009, these references will be out of date.

Description

After project and implementation plans are approved, update the project thread to use the docs.openverse.org links for these documents.

We need to add documentation for this where appropriate, likely in the issue template for project threads:

https://github.com/WordPress/openverse/blob/main/.github/ISSUE_TEMPLATE/project_thread.md

Namely, some text similar to the following in a comment:

Once a document is merged, please update the link to point at the published document on our documentation site: https://docs.openverse.org/projects/index.html

@zackkrida zackkrida added 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing user-facing feature labels May 3, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Openverse Backlog May 3, 2023
@zackkrida zackkrida added 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: documentation Related to Sphinx documentation and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing user-facing feature labels May 3, 2023
@AetherUnbound AetherUnbound added good first issue New-contributor friendly help wanted Open to participation from the community labels Oct 16, 2023
@SadiyahK
Copy link

Hi, I'm looking to start contributing to open-source. This looks like a manageable first issue for me, please can I be assigned?

@dhruvkb
Copy link
Member

dhruvkb commented Nov 25, 2024

Sure @SadiyahK, please go ahead!

@openverse-bot openverse-bot moved this from 📋 Backlog to 📅 To Do in Openverse Backlog Nov 25, 2024
@openverse-bot openverse-bot moved this from 📅 To Do to 🏗 In Progress in Openverse Backlog Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 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
Status: 🏗 In Progress
Development

Successfully merging a pull request may close this issue.

4 participants