docs(community): update latest community documentation #3787
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
WalkthroughA new document has been added outlining the onboarding process for AsyncAPI maintainers. This guide details roles, responsibilities, and the steps to transition from contributor to maintainer, including issue selection, PR submissions, discussion participation, and mentorship. It also provides resources and links to facilitate proactive engagement and adherence to coding standards within the AsyncAPI ecosystem. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
❌ Deploy Preview for asyncapi-website failed.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
markdown/docs/community/onboarding-guide/Onboarding-maintainer-guide.md (4)
11-21: Detailed Roles and Responsibilities
The bullet list comprehensively describes the key responsibilities. For clarity, consider rephrasing "Enforcing relevant and up-to-date documentation" to "Ensuring documentation remains current and relevant." This minor tweak can improve readability.
28-31: Introducing the Steps to Becoming a Maintainer
The transition to the step-by-step process is smooth and well-introduced. You might consider a brief note here to set expectations about the journey ahead.
40-42: Note Formatting Enhancement
The note effectively highlights a critical caution regarding issues marked "Do-not-merge." For added emphasis, consider bolding "Do-not-merge" within the note to align with the formatting used elsewhere in the document.
68-68: Final Line Consistency
There is a standalone line numbered "68" without any content. Please verify if this is intentional or if content was inadvertently omitted.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/onboarding-guide/Onboarding-maintainer-guide.md(1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (8)
markdown/docs/community/onboarding-guide/Onboarding-maintainer-guide.md (8)
1-2: Title Clarity
The title clearly communicates the document’s purpose. Consider adding a version number or a short subtitle in future revisions if the guide is updated frequently.
3-8: Welcoming Introduction
The introductory section is engaging and sets a positive tone for new maintainers. The language is friendly and clearly explains the document's purpose.
9-10: Section Header – Maintainer Definition
The heading "Who is an AsyncAPI Maintainer?" is clear and appropriately draws the reader’s attention to the criteria and responsibilities of a maintainer.
22-27: Emphasizing Broader Leadership Qualities
The paragraphs effectively expand on the non-technical aspects of being a maintainer, such as leadership and mentorship. The motivational tone is well-suited to inspire potential maintainers.
32-39: Step 1 – Pick an Issue
The guidelines for picking an issue are clear and actionable. You could also mention checking closed issues or archived discussions in less active repositories to broaden the options.
43-54: Step 2 – Opening a PR
The section provides clear instructions on forking, making changes, and submitting a PR. It might be beneficial to add a quick reminder to review the project's contribution guidelines to ensure full compliance with coding standards, if applicable.
55-62: Step 3 – Getting your PR Merged
The process is outlined cleanly with mention of the review process and the importance of passing checks. Reinforcing the need to address all reviewer comments before merging could further enhance clarity.
63-67: Step 4 – Invitation to Become a Maintainer
The invitation step is motivational and detailed. It clearly explains what consistent contributions and leadership look like. Adding a brief disclaimer that the invitation process might vary based on the current team’s capacity or project priorities could provide additional context.
|
front matter missing |
Markdown Check ResultsWe found issues in the following markdown files: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3787 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 20 21 +1
Lines 732 667 -65
Branches 0 113 +113
==========================================
- Hits 732 667 -65 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
akshatnema
deleted the
update-community-docs-2767343b7cb4bf7a02b966a8c68787959c538db1
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit