[📑 Docs]: [Draft] Epic: Expand Community Documentation

[bandantonio]

What Dev Docs changes are you proposing?

Create Onboarding Contributor Guides & Expand Community Docs.

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.

First project: Onboarding Contributor Guides

Based on the initial project idea mentioned in this discussion

To address the problem described above, the AsyncAPI documentation needs to create a set of onboarding guides to automate onboarding sessions for new contributors.

• Onboarding Code Contributor Guide
• Onboarding Ambassador Guide
• Onboarding Maintainer Guide
• Onboarding TSC Guide (YouTube onboarding video)

Project's scope

Streamline the onboarding process for new contributors by creating comprehensive guides tailored to their roles, automating the onboarding sessions effectively.

Where should the project live?

Proposed location - community/docs/onboarding-guide/

Tasks to be assigned

• docs: Onboarding Contributor Guides: Code Contributor (Assignee: @SaxenaAnushka102)
• docs: Onboarding Contributor Guides: Ambassador (Assignee: @ezinneanne)
• docs: Onboarding Contributor Guides: Maintainer (Assignee: @Aahil13)
• docs: Onboarding Contributor Guides: Technical Steering Committee (TSC) (YouTube onboarding video) (Assignee: @bandantonio)
  • related PR: docs: improve writing style of TSC membership #1547

Second project: Expand Community Docs

Based on the initial project idea mentioned in this discussion

Automating the AsyncAPI onboarding experience also involves documenting important workflows and processes for community members involved.

Contributor

• Simple Contribution Flow
• Identifying Good First Issues
• Following Conventional Commits
• Utilizing GitHub Tricks and Workflows
• Recommended Tools
• Path to Becoming a Maintainer
• Recommended Git Workflow
• Becoming a Technical Steering Committee (TSC) Member

Maintainer

• Utilizing GitHub Actions
• Implementing Global and Local Workflows
• Appointing New Maintainers
• Mentoring New Maintainers
• Recognizing Contributors

Ambassadors

• Ambassador Contributions
• Guidelines for Becoming an Ambassador

Gratifications

• Distribution of Swags
• Participation in the Mentorship Program
• Involvement in the Bounty Program

Governance and Transparency

• Understanding the Technical Steering Committee (TSC)
• Participation in Voting Processes
• Organizing and Participating in Meetings
  Utilizing Communication Channels Effectively
  Managing Project Finances

Community Health

• Adhering to Slack Etiquette
• Understanding and Upholding the Code of Conduct

Project's scope

Document essential workflows and processes for community members involved to enhance the AsyncAPI onboarding experience.

Where should the project live?

Proposed location - community

Tasks

Assignee: @SaxenaAnushka102

• docs: Expand Community Docs: Contributor - Identifying Good First Issues
• docs: Expand Community Docs: Contributor - Recommended Git Workflow

Assignee: @Aahil13

• docs: Expand Community Docs: Contributor - Following Conventional Commits
• docs: Expand Community Docs: Contributor - Utilizing GitHub Tricks and Workflows
• docs: Expand Community Docs: Contributor - Path to Becoming a Maintainer

Assignee: @ezinneanne

• docs: Expand Community Docs: Contributor - Simple Contribution Flow
• docs: Expand Community Docs: Contributor - Recommended Tools

Assignee: @bandantonio

• docs: Expand Community Docs: Contributor - Becoming a Technical Steering Committee (TSC) Member (PR is on review)

More tasks will be added later

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

[thulieblack]

Hi, @bandantonio thanks. Let's start with the Onboarding Contributor Guides first and then we can work move to Expand AsyncAPI Community Docs. I think we can draw some inspiration from @quetzalliwrites proposal https://github.com/orgs/asyncapi/discussions/1136

For the Epic, maybe we can also adopt something we had for the AsyncAPI Style Guide: asyncapi/website#1240. It'll be useful for our case as well.

cc @quetzalliwrites @wise4rmgod