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

Request for Clarification and Streamlining of Documentation Update Process on GitHub #35961

Closed
1 task done
Mmabiaa opened this issue Jan 16, 2025 · 4 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs

Comments

@Mmabiaa
Copy link

Mmabiaa commented Jan 16, 2025

Code of Conduct

What article on docs.github.com is affected?

Affected Article: The article that requires updating is the GitHub documentation on How to update documentation for the current release.

What part(s) of the article would you like to see updated?

Requested Updates:

•Sections to Update: Clarify the steps for checking if documentation updates are needed and streamline the process for raising issues.

•Reason for Change: Current instructions can be confusing, leading to redundant issues. Clearer guidelines will help users efficiently contribute and reduce duplicated efforts.

•Expected Outcome: Improved user understanding and participation in documentation updates.

Additional information

Additional Information:
• The issue occurs frequently as many users struggle with the existing process. This affects all contributors looking to update documentation. Clearer instructions will enhance collaboration and efficiency in maintaining documentation.

@Mmabiaa Mmabiaa added the content This issue or pull request belongs to the Docs Content team label Jan 16, 2025
Copy link

welcome bot commented Jan 16, 2025

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 16, 2025
@Mmabiaa
Copy link
Author

Mmabiaa commented Jan 16, 2025

Thank you for the prompt acknowledgment! I appreciate the guidance and will review the contributing guidelines to ensure my suggestions align with the team’s expectations. I look forward to any feedback from the GitHub docs team regarding my issue. If there are any specific areas you’d like me to elaborate on or if further details are needed, please let me know!

@nguyenalex836 nguyenalex836 added contributing docs Content related to our contributing docs and removed triage Do not begin working on this issue until triaged by the team labels Jan 16, 2025
@nguyenalex836
Copy link
Contributor

@Mmabiaa Welcome to the GitHub Docs! 👋 We appreciate your willingness to contribute to our community!

Regarding the points you raised in your issue, we would strongly recommend reading our contributing docs as well as our GitHub Docs README! These serve as base resources regarding topics such as how to contribute efficiently, what our content model looks like, and specifics regarding our house writing style ✨

If after reading these docs you have questions, or would like to request an update to any of our docs, please feel free to raise an issue. If you're looking for an issue to pick up, take a look at our help wanted section to find open issues you can work on 🚀

Welcome again to GitHub Docs - we look forward to seeing your contributions!

@Mmabiaa
Copy link
Author

Mmabiaa commented Jan 17, 2025

Alright thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs
Projects
None yet
Development

No branches or pull requests

2 participants