Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Aug 4, 2025

Updated community documentation is available and this PR introduces update to community folder on the website

Summary by CodeRabbit

  • New Features

    • Introduced extensive new community documentation, including onboarding guides, contribution guidelines, governance policies, project vision and goals, mentorship programs, meeting organization, and marketing resources.
    • Added detailed guides for contributing, maintaining repositories, participating in mentorship programs, and engaging with AsyncAPI community initiatives.
    • Published AsyncAPI governance documents such as the Technical Charter, governance board structure, voting procedures, and funding information.
    • Launched new program documentation for the Ambassador Program, Bounty Program, and various mentorship and open-source participation tracks.
  • Documentation

    • Updated and standardized metadata, ordering, and internal links across community documentation.
    • Added placeholder and under-construction notices to sections where content is still being developed.
    • Improved clarity and accessibility with new section overviews, templates, and best practice guides.
  • Refactor

    • Removed outdated section metadata files and updated front matter formatting for consistency.
  • Style

    • Applied consistent capitalization, formatting, and metadata structure to documentation files for improved navigation and readability.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 4, 2025

Warning

Rate limit exceeded

@asyncapi-bot has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9f66a85 and eea1c26.

📒 Files selected for processing (105)
  • config/edit-page-config.json (1 hunks)
  • markdown/docs/community/000-onboarding/_section.md (1 hunks)
  • markdown/docs/community/000-onboarding/ambassador-guide.md (2 hunks)
  • markdown/docs/community/000-onboarding/docs-onboarding-checklist.md (1 hunks)
  • markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md (1 hunks)
  • markdown/docs/community/000-onboarding/github-actions.md (1 hunks)
  • markdown/docs/community/000-onboarding/how-to-contribute.md (1 hunks)
  • markdown/docs/community/000-onboarding/index.md (1 hunks)
  • markdown/docs/community/000-onboarding/maintainer-guide.md (2 hunks)
  • markdown/docs/community/000-onboarding/upholding-code-of-conduct.md (1 hunks)
  • markdown/docs/community/000-onboarding/where-to-contribute.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/_section.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md (3 hunks)
  • markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/contribute-to-docs.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/contribution-flow.md (3 hunks)
  • markdown/docs/community/010-contribution-guidelines/conventional-commits.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/create-new-docs-directories.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/git-workflow.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/index.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md (2 hunks)
  • markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/prerequisite-knowledge.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/technical-writer-contributor-responsibilities.md (1 hunks)
  • markdown/docs/community/010-contribution-guidelines/tools-and-setup.md (2 hunks)
  • markdown/docs/community/011-styleguide/_section.md (1 hunks)
  • markdown/docs/community/011-styleguide/content-buckets.md (1 hunks)
  • markdown/docs/community/011-styleguide/formatting.md (1 hunks)
  • markdown/docs/community/011-styleguide/glossary.md (1 hunks)
  • markdown/docs/community/011-styleguide/grammar.md (2 hunks)
  • markdown/docs/community/011-styleguide/inclusive-language.md (1 hunks)
  • markdown/docs/community/011-styleguide/index.md (1 hunks)
  • markdown/docs/community/011-styleguide/links.md (1 hunks)
  • markdown/docs/community/011-styleguide/localization.md (1 hunks)
  • markdown/docs/community/011-styleguide/numbers.md (2 hunks)
  • markdown/docs/community/011-styleguide/punctuation.md (1 hunks)
  • markdown/docs/community/011-styleguide/seo-guide.md (1 hunks)
  • markdown/docs/community/011-styleguide/styling.md (1 hunks)
  • markdown/docs/community/011-styleguide/version-control.md (1 hunks)
  • markdown/docs/community/011-styleguide/voice-and-tone.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/AMBASSADOR_PROGRAM.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/CHARTER.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/GOVERNANCE.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/_section.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/donating-projects.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/index.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (1 hunks)
  • markdown/docs/community/020-governance-and-policies/voting.md (1 hunks)
  • markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (1 hunks)
  • markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (1 hunks)
  • markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md (1 hunks)
  • markdown/docs/community/030-project-vision-strategy-goals/_section.md (1 hunks)
  • markdown/docs/community/030-project-vision-strategy-goals/index.md (1 hunks)
  • markdown/docs/community/040-guides/_section.md (1 hunks)
  • markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1 hunks)
  • markdown/docs/community/040-guides/index.md (1 hunks)
  • markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/_section.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentoring-initiatives.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2022-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2022-project-ideas.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2023-project-ideas.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2024-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-2024-project-ideas.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/asyncapi-mentorship-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/index.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/seasonofdocs-2022-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/seasonofdocs-2023-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/seasonofdocs-2023-project-ideas.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-2021-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-2023-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-2024-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-2024-asyncapi-gsoc-ideas-page.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-2025-asyncapi-gsoc-ideas-page.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-README.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-application-template.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/summerofcode-mentors-guideline.md (1 hunks)
  • markdown/docs/community/050-mentorship-program/winterofcode-2023-README.md (1 hunks)
  • markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1 hunks)
  • markdown/docs/community/060-meetings-and-communication/_section.md (1 hunks)
  • markdown/docs/community/060-meetings-and-communication/docs-community.md (1 hunks)
  • markdown/docs/community/060-meetings-and-communication/index.md (1 hunks)
  • markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (1 hunks)
  • markdown/docs/community/070-marketing/_section.md (1 hunks)
  • markdown/docs/community/070-marketing/index.md (1 hunks)
  • markdown/docs/community/070-marketing/social-media-communication-guidelines.md (1 hunks)
  • markdown/docs/community/070-marketing/webinar_planning_template.md (1 hunks)
  • markdown/docs/community/070-marketing/webinar_series_initiative.md (1 hunks)
  • markdown/docs/community/COC-incident-resolution-procedures.md (1 hunks)
  • markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1 hunks)
  • markdown/docs/community/_section.md (1 hunks)
  • markdown/docs/community/community-glossary.md (1 hunks)
  • markdown/docs/community/index.md (1 hunks)
  • markdown/docs/community/onboarding-guide/_section.md (0 hunks)
  • markdown/docs/community/styleguide/_section.md (0 hunks)

Walkthrough

This update introduces a comprehensive overhaul and expansion of AsyncAPI community documentation. It adds new structured sections for onboarding, contribution guidelines, style guides, governance, project vision, guides, mentorship, meetings, marketing, and community programs. Numerous new markdown files provide detailed guides, procedures, policies, templates, and program overviews, while configuration files are updated to reflect the new documentation structure.

Changes

Cohort / File(s) Change Summary
Config and Structure Updates
config/edit-page-config.json, markdown/docs/community/_section.md, markdown/docs/community/index.md, markdown/docs/community/onboarding-guide/_section.md, markdown/docs/community/styleguide/_section.md
Extended JSON config with new community doc entries; fixed front matter in section file; updated intro and weights; deleted obsolete section files.
Onboarding Section
markdown/docs/community/000-onboarding/*
Added/updated onboarding docs: new section, guides (ambassador, documentarian, maintainer, how/where to contribute), onboarding checklist, GitHub Actions, Code of Conduct, index, and updated links/weights.
Contribution Guidelines
markdown/docs/community/010-contribution-guidelines/*
Added/updated contribution docs: new section, guides for maintainers, blog posts, issue identification, git workflow, contributor recognition, technical writer roles, tools/setup, and index; updated links, weights, and formatting.
Style Guide Section
markdown/docs/community/011-styleguide/*
Added/updated style guide: new section, guides for localization, styling, version control; updated weights, formatting, and links in existing style docs.
Governance and Policies
markdown/docs/community/020-governance-and-policies/*
Added new governance docs: charter, board membership, funding, TSC membership, voting, working groups, project donation, spec change process, incident procedures, code of conduct committee, and section/index files.
Project Vision, Strategy, Goals
markdown/docs/community/030-project-vision-strategy-goals/*
Added new project vision section, goals for 2025, marketing strategy, roadmap, and index; includes placeholders for future content.
Guides Section
markdown/docs/community/040-guides/*
Added guides section and documents for tool addition, repository consistency, and general how-to guides.
Mentorship Program
markdown/docs/community/050-mentorship-program/*
Added mentorship section, program overviews, annual program READMEs, project ideas, application templates, mentor guidelines, and participant statistics.
Meetings and Communication
markdown/docs/community/060-meetings-and-communication/*
Added meetings/communication section, detailed meeting organization guide, Slack etiquette, and index; updated meeting links and weights.
Marketing Section
markdown/docs/community/070-marketing/*
Added marketing section, index, social media guidelines (placeholder), webinar template, and webinar initiative docs.
Community Glossary
markdown/docs/community/community-glossary.md
Added new placeholder file for the community glossary.

Sequence Diagram(s)

sequenceDiagram
  participant Contributor
  participant DocsWebsite
  participant Maintainers
  participant CommunityPrograms
  participant GovernanceBoard

  Contributor->>DocsWebsite: Access onboarding/contribution guides
  Contributor->>DocsWebsite: Find project vision, policies, style guides
  Contributor->>CommunityPrograms: Join mentorship, ambassador, or working group
  Contributor->>GovernanceBoard: Review governance, voting, CoC procedures
  Maintainers->>DocsWebsite: Update or reference guides, policies, templates
  DocsWebsite->>Contributor: Provide structured documentation/resources
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40–60 minutes

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • TRohit20
  • Aahil13
  • VaishnaviNandakumar
  • asyncapi-bot-eve

Poem

🐇
In burrows deep, docs multiply,
Onboarding, guides, and rules nearby.
Governance blooms, the vision grows,
Mentors and meetings—how knowledge flows!
From carrots to code, the garden expands,
With every new doc, we lend helping hands.
Hop on, dear friends, to our AsyncAPI lands!

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-community-docs-6e74be03eac16fb0e296901f7d0c8bdf183c7932

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify
Copy link

netlify bot commented Aug 4, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit eea1c26
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/6890e1ca083d8d00082f88d0
😎 Deploy Preview https://deploy-preview-4308--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@codecov
Copy link

codecov bot commented Aug 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9f66a85) to head (eea1c26).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4308   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          778       778           
  Branches       144       144           
=========================================
  Hits           778       778           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@asyncapi-bot asyncapi-bot merged commit c166eaa into master Aug 4, 2025
29 of 30 checks passed
@asyncapi-bot asyncapi-bot deleted the update-community-docs-6e74be03eac16fb0e296901f7d0c8bdf183c7932 branch August 4, 2025 16:42
@asyncapi-bot
Copy link
Contributor Author

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 42
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-4308--asyncapi-website.netlify.app/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants