[📑 Docs] Epic: Expand Community Documentation #1622
Description
What Dev Docs changes are you proposing?
Create Onboarding Contributor Guides & Expand Community Docs as a part of the AsyncAPI Mentor/Maintainership Program 2024
Why the need?
The AsyncAPI documentation lacks a persona-driven journey for diverse roles, such as documentation contributors, code contributors, ambassadors, maintainers, etc. Consequently, the AsyncAPI onboarding experience is not as efficient as it could be for new contributors, often resulting in onboarding calls being perceived as bottlenecks.
Program Scope
The scope includes, but not limited to creating the following documentation:
Contributor Onboarding (8 ✅ out of 8)
- ✅ Contribution Flow
- Create a step-by-step guide for new contributors on what to do before submitting a PR.
- ✅ Role-based guides
- ✅ Code Contributor: docs: add onboarding code contributor guide #1725 (@SaxenaAnushka102)
- ✅ Maintainer:
- ✅ Ambassador:
- ✅ Recommended tools
- ✅ Conventional Commits
- Document commit message conventions to maintain a clear repository history.
- PR: docs: expand community docs - Following Conventional Commits #1733 (@Aahil13)
- ✅ Identifying Good First Issues
- Guide contributors on finding beginner-friendly issues and interpreting issue labels.
- PR: docs: add onboarding guide for identifying good first issues #1815 (@SaxenaAnushka102)
- ✅ Git Workflow
- Outline best practices for branching, rebasing, and handling PR reviews effectively.
- PR: docs: make steps in git workflow more beginner-friendly #1772 (@bandantonio)
Maintainer Guidelines (3 ✅ out of 3)
- ✅ Utilizing GitHub Actions
- Document how to set up and optimize workflows using automation tools.
- Reference: https://github.com/asyncapi/.github
- PR: docs: add GitHub Actions guide #1872 (@Aahil13)
- ✅ Recognizing Contributors & Appointing New Maintainers
- Define selection criteria, nomination process, and onboarding checklist for new maintainers.
- ❗️Requires community input and research.
- PR: docs: add recognizing contributor and appointing new maintainers guide #1964 (@Aahil13)
- ✅ Mentoring New Maintainers
- Develop strategies for knowledge transfer to support new maintainers.
- ❗️Requires community input and research.
- PR: docs: add mentoring new maintainers document #1863 (@ezinneanne)
Community Health and Engagement (2 ✅ out of 2)
- ✅ Adhering to Slack Etiquette
- Establish best practices for respectful and effective communication on Slack.
- Base the document on existing etiquette and provide links to Slack guidelines.
- PR docs: add slack etiquette #1965 docs: add Slack etiquette guide #1942 (@Aahil13)
- ✅ Upholding the Code of Conduct
- Ensure contributors understand the Code of Conduct.
- Provide guidelines on reporting discrimination and conflict resolution processes.
- Reference the existing CoC documentation.
- PR docs: add Upholding Code of Conduct document #1923 (@ezinneanne)
Out of Scope
Governance and Transparency (1 ✅ out of 3)
- ✅ Understanding the TSC (Technical Steering Committee) (@bandantonio)
- Document the role and responsibilities of the TSC.
- Reference:
- Organizing Meetings
- Provide guidelines for structuring, scheduling, and running effective meetings.
- Restream Onboarding
- Document the onboarding process for using Restream for community events.
Documentation structure and organization (1 ✅ out of 1)
The scope of creating new and updating/refactoring the existing documentation triggered a parallel stream of work related to revising the documentation structure within the community repository:
This stream focuses on providing a streamlined experience for both newcomers and existing community members to explore documentation efficiently within the repository, and effectively follow them during their contribution journeys.
Measuring Success
To gauge user engagement, success will be measured through various metrics, including the number of views, sessions, and unique users. Additionally, continuous monitoring of user feedback will be vital for further improving our community documentation and onboarding guides.
Code of Conduct
- I agree to follow this project's Code of Conduct