Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Jul 15, 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 governance, contribution guidelines, mentorship programs, onboarding guides, style guides, project vision, marketing strategies, and meeting organization.
    • Added detailed guides for contributing, maintaining repositories, recognizing contributors, and upholding community standards.
    • Published comprehensive documentation for AsyncAPI programs such as mentorship, ambassador, and bounty initiatives, as well as processes for voting, project funding, and working group formation.
  • Documentation

    • Added numerous new markdown files covering onboarding, contribution, governance, style, guides, mentorship, meetings, marketing, and code of conduct procedures.
    • Updated and corrected formatting in existing documentation for clarity and consistency.
    • Included placeholders for upcoming documents to signal future content expansion.

@netlify
Copy link

netlify bot commented Jul 15, 2025

Deploy Preview for asyncapi-website failed.

Name Link
🔨 Latest commit 9193ddb
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/6876cdb7fa6fdc000841e74e

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 15, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a large set of new and revised documentation files to the AsyncAPI community repository. It covers onboarding, contribution guidelines, governance, project vision, guides, mentorship, meetings, marketing, code of conduct, and style guides. The changes include new policies, process descriptions, templates, and placeholder documents, as well as minor formatting and link corrections.

Changes

File(s) Change Summary
config/edit-page-config.json Added new entries under "community" for onboarding, contribution, styleguide, governance, vision, guides, mentorship, meetings, and marketing documentation.
markdown/docs/community/000-onboarding/docs-onboarding-checklist.md Updated two checklist links to new relative paths.
markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md
markdown/docs/community/000-onboarding/how-to-contribute.md
markdown/docs/community/000-onboarding/where-to-contribute.md
markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md
markdown/docs/community/070-marketing/social-media-communication-guidelines.md
markdown/docs/community/community-glossary.md
Added new placeholder documents indicating content is under construction.
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md Added detailed AsyncAPI Bounty Program documentation.
markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md Added guide for becoming a maintainer in an existing project.
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md Added guide for contributing blog posts to the AsyncAPI blog.
markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md Removed trailing newline (formatting only).
markdown/docs/community/010-contribution-guidelines/contribution-flow.md Updated "conventional commits guide" link to absolute GitHub URL.
markdown/docs/community/010-contribution-guidelines/git-workflow.md Added comprehensive Git workflow guide for contributors.
markdown/docs/community/010-contribution-guidelines/mentoring-maintainers.md Fixed minor formatting issue (removed extra hyphen).
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md Added documentation on recognizing contributors using All Contributors specification.
markdown/docs/community/010-contribution-guidelines/recognizing-contributors-and-appointing-new-maintainers.md Added guide on contributor recognition and maintainer appointment process.
markdown/docs/community/011-styleguide/grammar.md
markdown/docs/community/011-styleguide/numbers.md
Fixed minor formatting/whitespace issues.
markdown/docs/community/011-styleguide/styling.md Added comprehensive style guide for CSS, typography, Markdown, images, tables, and diagrams.
markdown/docs/community/020-governance-and-policies/CHARTER.md Added AsyncAPI Technical Charter defining governance and operational rules.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md Added documentation outlining AsyncAPI funding and sponsorship policy.
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md Added guide on becoming a Technical Steering Committee (TSC) member.
markdown/docs/community/020-governance-and-policies/TSC_VOTING_OVERVIEW.md Added auto-generated table tracking TSC voting participation and outcomes.
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md Added documentation defining Working Groups and their operations.
markdown/docs/community/020-governance-and-policies/donating-projects.md Added guide for donating projects to AsyncAPI.
markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md Added process documentation for introducing changes to the AsyncAPI spec.
markdown/docs/community/020-governance-and-policies/voting.md Added documentation on voting governance and procedures.
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md Added AsyncAPI community goals and objectives for 2025.
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md Added comprehensive AsyncAPI community marketing strategy for 2025.
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md Added guide for adding new AsyncAPI tools to the website.
markdown/docs/community/040-guides/keep-repository-settings-consistent.md Added guide for maintaining consistent repository settings.
markdown/docs/community/050-mentorship-program/README.md Added overview of AsyncAPI mentoring initiatives and statistics.
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md Added documentation on the AsyncAPI Ambassador Program.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/README.md
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/project-ideas.md
Added documentation for AsyncAPI mentorship program years 2022, 2023, and 2024, including project ideas and accepted projects.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md Added comprehensive AsyncAPI Mentorship Program guidelines.
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md
markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md
Added documentation for AsyncAPI's participation in Google Season of Docs 2022 and 2023.
markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md Added documentation for AsyncAPI Summer of Code 2021 projects and timeline.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md Added AsyncAPI Google Summer of Code 2023 documentation, including projects and proposals.
markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md
markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md
Added AsyncAPI Google Summer of Code 2024 documentation and project ideas.
markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md Added AsyncAPI Google Summer of Code 2025 project ideas.
markdown/docs/community/050-mentorship-program/summerofcode/README.md Added GSoC getting started guide for AsyncAPI contributors.
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md Added AsyncAPI GSoC application template.
markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md Added GSoC mentor's guideline documentation.
markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md Added documentation for AsyncAPI Winter of Code 2023 program.
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md Added comprehensive guide to meetings organization and podcast publishing.
markdown/docs/community/060-meetings-and-communication/slack-etiquette.md Added AsyncAPI Slack etiquette guidelines.
markdown/docs/community/070-marketing/webinar_planning_template.md Added webinar planning template.
markdown/docs/community/070-marketing/webinar_series_initiative.md Added AsyncAPI Webinar Series Initiative documentation.
markdown/docs/community/COC-incident-resolution-procedures.md Added Code of Conduct incident resolution procedures.
markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md Added documentation on the AsyncAPI Code of Conduct Committee.
markdown/docs/community/community-glossary.md Added placeholder for community glossary document.
markdown/docs/community/onboarding-guide/github-actions.md Added onboarding guide for utilizing GitHub Actions.
markdown/docs/community/onboarding-guide/identifying-good-first-issues.md Added onboarding guide for identifying good first issues.
markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md Added onboarding guide for upholding the Code of Conduct.
markdown/docs/community/styleguide/version-control.md Added version control guidelines for AsyncAPI documentation.

Sequence Diagram(s)

sequenceDiagram
    participant Contributor
    participant Community Docs
    participant Maintainer
    participant TSC
    participant Bot

    Contributor->>Community Docs: Reads onboarding and contribution guidelines
    Contributor->>Maintainer: Submits PR or issue (e.g., for bounty, mentorship, etc.)
    Maintainer->>TSC: Reviews, approves, or escalates as per governance/policies
    TSC->>Bot: Initiates voting or automation (e.g., via GitHub issue/PR)
    Bot->>TSC: Tracks votes, updates participation tables
    Maintainer->>Contributor: Provides feedback, merges PR, or recognizes contribution
    Contributor->>Community Docs: References style guides, process docs, and program info
Loading

Possibly related PRs

Suggested reviewers

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

Poem

In the warren of docs, where ideas bloom bright,
New guides and charters hop into sight.
From bounties to meetings, and codes of conduct too,
Onboarding and style guides, all shiny and new!
With every new page, our community grows—
A rabbit’s delight as knowledge overflows!
🐇✨


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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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)

  • @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 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.

@akshatnema akshatnema deleted the update-community-docs-40886bc2c059b2d96317a16a95b6a24881e139a2 branch August 3, 2025 13:09
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.

4 participants