docs(community): update latest community documentation #4261
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
sambhavgupta0705 and
thulieblack
as code owners
❌ Deploy Preview for asyncapi-website failed.
|
WalkthroughThis update introduces a large collection of new documentation files across the AsyncAPI community, including onboarding guides, contribution guidelines, governance policies, mentorship program details, marketing strategies, and style guides. It also updates configuration files to reference these new documents and makes minor corrections to existing markdown files. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Maintainer
participant Community Docs
participant Config File
Contributor->>Community Docs: Accesses onboarding/contribution/governance guides
Contributor->>Maintainer: Submits PRs/issues as per new guidelines
Maintainer->>Community Docs: Updates/approves documentation
Config File->>Community Docs: Links new docs for edit-page functionality
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
asyncapi-bot
requested review from
CBID2,
ashmitjsg,
bandantonio and
vishvamsinh28
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 #4261 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 21
🔭 Outside diff range comments (3)
markdown/docs/community/010-contribution-guidelines/contribution-flow.md (1)
28-34: Fix broken GitHub links in contribution‐flow.mdThe links for git workflow guide and git workflow document (lines 28 and 34) currently use a leading slash without a domain, which resolves to
/asyncapi/community/...on the site and returns 404. Update both to the full GitHub URLs and confirm the conventional-commits link still points to an existing file:- 1. Set up your workflow environment using the [git workflow guide](/asyncapi/community/blob/master/git-workflow.md). + 1. Set up your workflow environment using the [git workflow guide](https://github.com/asyncapi/community/blob/master/git-workflow.md). … - 7. Follow the [git workflow document](/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR. + 7. Follow the [git workflow document](https://github.com/asyncapi/community/blob/master/git-workflow.md) when working on your changes and making a PR.• Also verify that the conventional commits guide link
https://github.com/asyncapi/community/blob/master/docs/010-contribution-guidelines/conventional-commits.md
still matches the file location in the community repo and update if it’s moved.config/edit-page-config.json (1)
15-65: New community matchers are unreachable due to fallback entry order
determineEditLink()stops at the first match.
The catch-all entry with emptyvaluesits at lines 15-17, before all newly-added community paths, so every URL will match the fallback and the new rules will never be applied.Move the fallback object to the end of the array or insert the community rules above it.
markdown/docs/community/050-mentorship-program/README.md (1)
18-41: Tables fail markdownlint & render incorrectlySeveral rows miss trailing pipes which causes uneven column counts (
MD055,MD056).
Readers will see broken tables; automated docs checks may also fail.Run markdownlint ‑-fix or adjust table rows so each line has four
|separators.
🧹 Nitpick comments (81)
markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md (3)
8-12: Numbered-list formatting: use incremental indices or a fenced block
Using1.for all three items is Markdown-legal but occasionally confuses linters & translators. Consider1. 2. 3.or a checklist to avoid MD025 noise.
17-24: Absolute GitHub links hard-wire to the default branch
Links such as/tree/master/...will 404 when the default branch renames (e.g.,main). Prefer relative links (../../pages/blog) or just omit the branch segment.
20-21: Accessibility reminder: provide concrete alt-text examples
The requirements mention alt descriptions but giving one short example would set clear expectations (“e.g.,alt="Screenshot of AsyncAPI generator output"”).markdown/docs/community/050-mentorship-program/README.md (1)
3-4: Minor wording nitConsider replacing “a variety of” with “several” for concision (LanguageTool flag).
markdown/docs/community/070-marketing/webinar_planning_template.md (1)
6-14: Consider starting with an H2 rather than an H3 to avoid a heading-level jumpThe first visible heading is
### Basic Info, which skips directly from no visible heading to H3. Markdown-lint often flags this (MD001) as it breaks the logical outline.
If there is no higher-level section title after the front-matter, bump all###headings up to##for a flatter, consistent structure.markdown/docs/community/040-guides/keep-repository-settings-consistent.md (1)
24-26: Wrap bare URLs in proper Markdown linksLines containing
https://sonarcloud.io/organizations/asyncapi/projectsandhttps://sonarcloud.io/projects/createare bare URLs.
Markdown-lint ruleMD034recommends enclosing them in angle brackets or converting to[text](url)to improve readability and avoid lint warnings.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/README.md (1)
14-26: Multiple bare URLs inside table cells trigger MD034Several table cells include raw links (e.g., GitHub issues) without Markdown link syntax. Converting them to
[label](url)avoidsMD034warnings and looks cleaner in rendered pages.markdown/docs/community/050-mentorship-program/winterofcode/2023/README.md (1)
2-2: Fix typo and wrap announcement link
annoucement→announcement, and wrap the URL in Markdown link syntax to satisfyMD034.Example:
> Program participation announcement can be found [here](https://github.com/orgs/asyncapi/discussions/556)markdown/docs/community/050-mentorship-program/summerofcode/mentors-guideline.md (1)
3-5: Heading level jumps from H1 to H5
##### Introductionjumps four levels after the H1 title, violatingMD001. Changing it to## Introduction(and adjusting subsequent headings accordingly) keeps the outline hierarchical.markdown/docs/community/onboarding-guide/upholding-code-of-conduct.md (1)
44-48: Convert the plain email address into a propermailto:link.This tiny change silences MD034 (“bare URL”) and gives readers a one-click way to start an email.
- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](https://github.com/asyncapi/community/blob/master/code_of_conduct/code-of-conduct-committee.md) + Emailing **[conduct@asyncapi.io](mailto:conduct@asyncapi.io)** – this forwards directly to the [Code of Conduct Committee](https://github.com/asyncapi/community/blob/master/code_of_conduct/code-of-conduct-committee.md)markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2022/project-ideas.md (2)
6-8: Surround the table with blank lines to satisfy MD058.Markdown-lint requires one blank line before and after a table. Add an empty line above
Number | Idea …and another after the last row.
17-18: Fix spelling and wording issues inside project descriptions.
- “Fuction-as-a-Service” → “Function-as-a-Service”.
- “prodution-ready” → “production-ready”.
- The phrase “in difficulty” is redundant – simply remove it.
- ... doing serverless or Fuction-as-a-Service (FaaS) ... + ... doing serverless or Function-as-a-Service (FaaS) ... - ... it needs to be prodution-ready, and that means ... + ... it needs to be production-ready, and that means ... - This is probably the most complicated issue in difficulty. + This is probably the most complicated issue.Also applies to: 24-25
markdown/docs/community/050-mentorship-program/summerofcode/application-template.md (1)
7-9: Use consecutive heading levels (MD001).Each top-level
#should be followed by##, not###. Update all section headings accordingly.-### Contact information +## Contact information ... -### Project Information +## Project Information ... -### Your Understanding of AsyncAPI +## Your Understanding of AsyncAPI ... -### Your Involvement with the AsyncAPI community +## Your Involvement with the AsyncAPI community ... -### Bio +## BioAlso applies to: 15-17, 25-27, 33-35, 43-45
markdown/docs/community/050-mentorship-program/seasonofdocs/2022/README.md (1)
28-35: Table needs surrounding blank lines and consistent column width.Adding a blank line before and after the budget table removes MD058 warnings; aligning pipes keeps MD055 quiet.
-### 💸 Project budget -We had 2 mentors ... +### 💸 Project budget + +We had 2 mentors ... | **Budget item** | **Total Amount** | | --- | --- | | Technical writer updates, reviews, edits, and publishing new documentation for the IA improvements. | $5 000 | | Technical writer updates, reviews, migration, and publishing improved Generator tool documentation. | $5 000 | | **TOTAL** | **$10 000** | +markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2023/project-ideas.md (5)
1-4: Fix header wordingTypo in the H1 header – it should read “Project ideas” (singular “Project”, plural “ideas”).
12-13: Spelling: “engile” ➜ “engine”
templating engileis a typo.
14-17: Improve readability of Step-by-Step/Glee sentenceThe sentence is currently run-on and difficult to parse. Please split it or add commas to clarify the flow from “install and setup Glee” through “how to deploy Glee”.
20-28: Consistency: “visualiser” vs “visualizer”Line 27 mixes British “visualiser” with earlier American “visualizer”. Pick one spelling across the doc (AsyncAPI repos consistently use “visualizer”).
21-22: Minor: “HML” ➜ “HTML”The phrase “Markdown/HML files” should be “Markdown/HTML files”.
markdown/docs/community/050-mentorship-program/asyncapi-mentorship/2024/README.md (2)
9-10: Spacing issueWrite “18 weeks” (add space) for readability.
11-12: Markdown-lint: add blank lines before & after the table
MD058—surround tables with blank lines to avoid rendering glitches in some Markdown engines.markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md (2)
26-27: Remove spaces inside emphasis markers
* *violatesMD037. Either drop the spaces or switch to normal text.
31-33: Bare URLs
MD034flags bare links (e.g. Slack). Consider turning them into Markdown links for consistency with the rest of the doc.markdown/docs/community/050-mentorship-program/summerofcode/2024/asyncapi-gsoc-ideas-page.md (2)
58-60: Spelling: “Maintainance” ➜ “Maintenance”Correct the title “Conference Website Maintainance”.
61-62: Grammar: singular/pluralSentence starts with “Ensure our conference website remains a dynamic and user-friendly …” – drop the article “a” or rewrite (“remains dynamic and user-friendly”).
markdown/docs/community/010-contribution-guidelines/recognize-contributors.md (1)
8-14: Tighten wording & capitalize SlackMinor style tweaks:
• “on Slack” (capital S)
• “Answer questions under issues or in Slack” (remove “to”).markdown/docs/community/050-mentorship-program/seasonofdocs/2023/README.md (4)
13-14: Typo: “Specifing” → “Specifying”
Minor spelling slip in the list entry title.
40-41: Clarity / grammar – awkward phrasing in the date-time example
“For example, of writing03/04/2024 8:00 AM, use …” reads oddly.
Consider “For example, instead of writing …”.
47-50: Use en dashes in timeline ranges for consistency
“June - August” and “September - October” should use an en dash (–) rather than a hyphen (-).
54-60: Redundant currency symbol
“$350 dollars” repeats the currency indicator. Prefer “USD 350” or simply “350 dollars”.markdown/docs/community/050-mentorship-program/seasonofdocs/2023/project-ideas.md (2)
12-13: Typo: “Specifing” → “Specifying”
29-30: Extraneous double space
There are two spaces between “a” and “learning” — tighten to one.markdown/docs/community/CODE_OF_CONDUCT_COMMITTEE.md (1)
5-6: Grammar – missing comma
“responds to investigates, and resolves” → “responds to, investigates, and resolves”.markdown/docs/community/060-meetings-and-communication/slack-etiquette.md (1)
32-34: Minor formatting – back-tick pair renders as nothing
The text mentions “Use backticks () for code”. Using a pair of back-ticks without escaping can disappear in some renderers. Consider “\code``”.markdown/docs/community/styleguide/localization.md (2)
40-41: Grammar / wording
“For example, of writing03/04/2024 8:00 AM, use …” → “For example, instead of writing …”.
44-48: Number-format example could be clearer
“One thousand and fifty hundredths” is confusing. Consider a simpler illustrative number such as “1,000.50”.markdown/docs/community/050-mentorship-program/summerofcode/2024/README.md (1)
31-33: Fix minor spelling + link sanity‐check in row 7
- “Maintainance” → “Maintenance”.
- The link
asyncapi-archived-repos/design-systempoints at an archived repo; confirm that this is intentional (archived projects are usually read-only). If the active design-system repo has moved, update the URL to avoid 404s.markdown/docs/community/050-mentorship-program/summerofcode/2025/asyncapi-gsoc-ideas-page.md (1)
44-47: Standardise terminology & hyphenation• Use “open-source contribution” (hyphenated adjective).
• Consistently capitalise technology names: “TypeScript”, “Node.js”.Cosmetic, but improves polish and search accuracy.
Also applies to: 80-82
markdown/docs/community/010-contribution-guidelines/git-workflow.md (1)
70-75: Remote URL placeholder & branch naming
https://ORIGINAL-OWNER/ORIGINAL-REPOSITORY-NAME.gitis missinggithub.com/.- AsyncAPI repos increasingly use
main; verify thatmasteris still the default before newcomers copy/paste the commands.markdown/docs/community/onboarding-guide/identifying-good-first-issues.md (2)
18-23: Label list duplicates “docs” scopes
docs,docs bug, andarea/docsoverlap. If the project already standardises onarea/…labels, consider dropping the generic ones to avoid confusion for newcomers reading this guide.
70-78: Clarify assignment policy wording“Wait for approval by maintainers” + “first come, first served” can be read as contradictory. Suggest making explicit that the first commenter is normally assigned unless a maintainer blocks for a reason (duplicate, already being worked on, etc.) to avoid misunderstandings.
markdown/docs/community/050-mentorship-program/summerofcode/README.md (1)
35-40: Missing URL scheme in external link
[AsyncAPI website](asyncapi.com)lacks a protocol, which renders as a relative link. Usehttps://asyncapi.comto ensure it works in all contexts.markdown/docs/community/050-mentorship-program/asyncapi-mentorship/README.md (1)
74-75: Typo: “Progam”“Progam Administrators” → “Program Administrators”.
markdown/docs/community/020-governance-and-policies/voting.md (1)
35-38: Markdown-lint: list indentationThe sub-bullet list under “GB members will review the request” is indented with one space instead of two, triggering MD007 and rendering inconsistently. Re-indent to match the surrounding bullets.
markdown/docs/community/050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md (4)
17-18: Hard-coded GitHub team tag could drift
@asyncapi/ambassadorsis copied in prose. If the team slug ever changes, docs become stale. Consider replacing with a shortcode/macros approach ({{< githubTeam "ambassadors" >}}) or just reference “theambassadorsGitHub team”.
28-32: Bare URLs violate MD034Linking directly (e.g.,
https://www.asyncapi.com/blog) fails markdown-lint. Wrap in angle brackets<…>or convert to reference-style links to silence MD034.
41-43: Wordiness (“in tune with”) flagged by LanguageToolPrefer a shorter phrase such as “Align with AsyncAPI’s mission and values.”
58-68: ID-retrieval instructions risk becoming outdatedGitHub & Slack UIs evolve; step-by-step screenshots/links can break. Point to official GitHub REST API docs for user objects and Slack’s help article on member IDs instead of UI microcopy.
markdown/docs/community/050-mentorship-program/summerofcode/2023/README.md (3)
1-2: “Completed” banner lacks metadataConsider adding YAML front-matter (
status: completed) so downstream tooling can surface program status programmatically instead of parsing the first line.
15-22: Table not surrounded by blank lines (MD058)Add a blank line before and after the pipe table to satisfy markdown-lint and improve raw readability.
60-60: Missing period after “etc” (ETC_PERIOD)Minor punctuation nit for consistency with US-English style guide.
markdown/docs/community/040-guides/add-new-asyncapi-tool-to-website.md (1)
70-75: Very long sentence hampers readabilityThe description for
links.repoUrlruns >30 words. Break into two sentences or use list formatting for clarity.markdown/docs/community/011-styleguide/styling.md (2)
84-91: Bullet list starts three consecutive items with “Use” (ENGLISH_WORD_REPEAT_BEGINNING_RULE)Vary wording or consolidate the rules to avoid repetition and satisfy LanguageTool.
109-113: Font stack omits system-UI fallbacksRecommend adding
system-ui, -apple-system, BlinkMacSystemFontahead of Inter for better cross-platform rendering when Inter isn’t installed.markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md (1)
18-25: Bare URLs trigger MD034Convert raw links to reference-style or wrap in angle brackets.
markdown/docs/community/020-governance-and-policies/WORKING_GROUPS.md (1)
6-8: Wording: use “transparently” instead of the phrase “in a transparent manner”A single adverb keeps the sentence tight and avoids repetition:
“…and ensures the group works transparently and is aligned with the AsyncAPI Roadmap.”
markdown/docs/community/020-governance-and-policies/CHARTER.md (1)
54-57: Capitalisation – start of bulletThe bullet beginning with “approving and implementing policies…” should be capitalised for consistency with surrounding items (“Approving and implementing…”).
markdown/docs/community/COC-incident-resolution-procedures.md (1)
95-98: Wordiness – replace “taking into consideration”Simplify the highlighted sentence:
“…if any, considering risks of retaliation, evidence tampering…”
Avoids unnecessary four-word phrase.
markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md (1)
81-83: Mis-phrasing: “Master ceremony”The usual term is “Master of Ceremonies (MC)”. Suggest rephrasing to avoid confusion.
markdown/docs/community/020-governance-and-policies/donating-projects.md (2)
13-20: Pluralize heading and merge repetitive “We …” sentences
### Legal Considerationshould be### Legal Considerations, and the two successive bullet sentences starting with “We” feel repetitive. Consider merging them into one concise sentence to improve flow.
40-41: Missing space after GitHub-handle
@fmvilasis concatenated withcan→ “@fmvilascan”. Add a space.markdown/docs/community/020-governance-and-policies/introduction-of-changes-to-spec.md (2)
23-25: Subject/verb agreement“
The contributors/maintainers reviews” → “… review”.
65-65: Spelling“preperation” → “preparation”.
markdown/docs/community/onboarding-guide/github-actions.md (3)
80-90: Spelling and wording– “neccessary” → “necessary”
– “quater” → “quarter”
Fixing these will avoid showing basic typos in public docs.
96-97: Typo in platform name“Mastadon” → “Mastodon” (lines 96 and 115).
63-76: Hard tabs violate markdown-lint rule MD010Replace tab characters with spaces to keep the file compliant with the existing markdown-lint settings.
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md (4)
81-85: Multiple typos– “neccessary” → “necessary”
– “quater” → “quarter”
Correct in both the bullet list and paragraph text.
96-98: Consistent spelling of “Mastodon”“Mastadon” should be “Mastodon”.
Also applies to: 115-116
51-53: Spacing and phrasing
Goal 3:Drive Community Engagement→Goal 3: Drive Community Engagement.Also, “inform of the Bounty Program” → “in the form of the Bounty Program”.
1-155: Hard tabs presentMD010 warnings indicate many hard tabs inside tables. Convert them to spaces for markdown-lint compliance.
markdown/docs/community/styleguide/version-control.md (2)
57-57: Double spaceHeading reads “When Submitting Changes” (two spaces). Collapse to a single space.
37-38: Clarity in guidance“maintainers & others” → “maintainers and other contributors” for formal tone and clarity.
markdown/docs/community/020-governance-and-policies/PROJECT_FUNDING.md (4)
21-29: Check tier benefit differentiationSilver and Gold currently list the exact same benefits as Bronze, despite higher contribution levels. Consider either (a) adding incremental perks or (b) collapsing redundant tiers to avoid sponsor confusion.
30-34: Avoid raw HTML & add accessible alt textUsing
<center>and bare<img>tags breaks Markdown portability and lacks descriptivealtattributes (WCAG). Prefer pure-Markdown formatting (<div align="center">or plain image) and supply meaningful alt text.
38-41: Trim wordinessPhrase “contribute … on a regular basis” can be shortened to “contribute regularly” for clarity and tone.
106-108: Tone-down “Feel free” cliché“Feel free to contact us” is informal and was flagged by LanguageTool. Consider “Contact us at … for more details.”
markdown/docs/community/030-project-vision-strategy-goals/2025_Community_Goals.md (1)
31-33: Missing space after period“repository), which we can record and build upon.Once we have…” → “…build upon. Once…”
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
60-74: Step list renumbers each item as ‘1.’Some Markdown engines auto-number, others render literally; mixed behaviour can confuse. Consider explicit incremental numbers or bullet points for consistency.
markdown/docs/community/010-contribution-guidelines/BOUNTY_PROGRAM.md (3)
70-81: Long multi-sentence paragraph hurts readabilityThe randomization logic spans multiple dense sentences beginning with “In case…”. Splitting into shorter paragraphs or a bullet list would improve comprehension.
124-130: Complex timeline sentenceThe calculation for weekly pings is hard to parse. Rewriting with numbered bullet rules (e.g., “Ping #1 …; Ping #2 …; On third Monday …”) would reduce ambiguity.
225-236: Suspension rules repetitionThree nearly identical blocks describe first/second suspensions. A small table or numbered list would convey the same information more concisely and reduce maintenance cost.
| ## Contribute AsyncAPI blog posts | ||
|
|
||
| The AsyncAPI blog is open to everyone; any contribution is allowed, including reposting. You can share use cases, projects, or tools in the form of a blog post to reach out to the entire AsyncAPI community. |
There was a problem hiding this comment.
Add YAML front-matter for correct page build
Every community doc under markdown/docs/... needs the front-matter block (---, title, description, weight, ---). Without it, the page won’t render or be indexed in the sidebar.
🤖 Prompt for AI Agents
In markdown/docs/community/010-contribution-guidelines/contribute-blog-post.md
at the beginning (lines 1 to 3), add a YAML front-matter block including the
keys `title`, `description`, and `weight` enclosed by triple dashes (`---`)
before the content. This front-matter is required for the page to build
correctly and be indexed in the sidebar. Ensure the values for `title` and
`description` accurately describe the page, and set an appropriate `weight` for
sidebar ordering.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Missing front-matter and H1 heading will break site navigation
Docs in this repo normally start with a YAML front-matter block (--- title: ..., weight: ... ---) followed by an H1 heading. Without it, the page will not be picked up by the build pipeline or will surface without a title in the sidebar.
Please add at minimum the standard front-matter plus an H1 to keep the site build green.
🤖 Prompt for AI Agents
In markdown/docs/community/community-glossary.md at the beginning of the file
(lines 1 to 3), add the standard YAML front-matter block with at least a title
and weight, followed by an H1 heading. This will ensure the page is recognized
by the build pipeline and appears correctly in the site navigation sidebar.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
ROADMAP placeholder also lacks required front-matter
Same structural issue as above: no YAML block / H1.
Add front-matter (e.g., title: 'Project Roadmap', weight:) or mark the file draft: true to avoid broken links in production.
🤖 Prompt for AI Agents
In markdown/docs/community/030-project-vision-strategy-goals/ROADMAP.md at the
beginning of the file (lines 1 to 3), the document lacks the required YAML
front-matter block and an H1 header. To fix this, add a YAML front-matter
section at the top with at least a title field like 'Project Roadmap' and a
weight or draft status (e.g., draft: true) to ensure proper rendering and avoid
broken links in production.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Onboarding page will not render without metadata
The file is missing the mandatory metadata block and top-level heading; this causes rendering issues and makes the page undiscoverable in the docs tree.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/where-to-contribute.md at the
beginning of the file (lines 1 to 3), add the required metadata block with
appropriate frontmatter fields such as title, description, and any other
mandatory keys. Also, include a top-level heading (e.g., # Where to Contribute)
immediately after the metadata block to ensure the page renders correctly and is
discoverable in the documentation tree.
| 🚧 This document is under construction. | ||
|
|
||
| Please be patient as we work on it. Thank you. 🫶 No newline at end of file |
There was a problem hiding this comment.
Structural metadata missing
Add front-matter (title, weight, optionally draft: true) and an H1 heading so the guide is properly indexed once content arrives.
🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/documentarian-onboarding-guide.md at
the beginning (lines 1 to 3), the file lacks structural metadata and an H1
heading. Add front-matter with at least a title and weight, and optionally
include draft: true if the document is not ready. Also, add an H1 heading below
the front-matter to ensure the guide is properly indexed when content is added.
| There is no need to have any experience in event-driven architecture. You do not even need to know AsyncAPI spec too much. It is a pure coding task where you will need to find matching patterns between different documents and return this information. You will have the full support of the mentor on the subject. Mentors will define requirements, etc. | ||
| There is no decision yet if this is a library that will have to live in a separate repository or be a part of an existing CLI or UI project. | ||
| We already started work on the CLI so before summer there will be enough to plug in this functionality | ||
| [asyncapi/cli ](https://github.com/asyncapi/cli) |
There was a problem hiding this comment.
Extra spaces inside link text (MD039)
[asyncapi/cli ] has trailing spaces inside brackets. Remove to satisfy markdown-lint.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
43-43: Spaces inside link text
(MD039, no-space-in-links)
🤖 Prompt for AI Agents
In markdown/docs/community/050-mentorship-program/summerofcode/2021/README.md at
line 43, the markdown link text contains trailing spaces inside the brackets,
which violates markdown-lint rule MD039. Remove the extra spaces inside the
square brackets so the link text is clean and has no trailing spaces.
| 3. TSC membership is not time-limited. There’s no maximum size of TSC. The size is expected to vary in order to ensure adequate coverage of important areas of expertise, balanced with the ability to make decisions efficiently. The TSC must have at least three members. | ||
| 4. No more than one-fourth of the TSC members may be affiliated with the same employer. If the removal or resignation of a TSC member, or a change of employment/affiliation by a TSC member, creates a situation where more than one-fourth of the TSC membership shares an employer, then the situation must be assessed by TSC. In any case, the number of TSC members affiliated with the same employer must not be higher than one-third (round half up number). | ||
| 5. Voting members of the Technical Steering Committee (TSC) include committers of any Project's code repository and AsyncAPI Ambassadors. The TSC documents in the project’s GOVERNANCE file the method for determining voting members. |
There was a problem hiding this comment.
Conflicting employer-affiliation limits
Line 37 imposes “no more than one-fourth” of TSC members per employer, but the next sentence relaxes that to “not higher than one-third”.
These two caps conflict; please choose a single threshold (¼ or ⅓) to avoid ambiguous enforcement.
🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Consider a more concise word here.
Context: ...ze of TSC. The size is expected to vary in order to ensure adequate coverage of important a...
(IN_ORDER_TO_PREMIUM)
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/CHARTER.md around lines
36 to 38, there is a conflict between employer-affiliation limits for TSC
members: one sentence states a maximum of one-fourth per employer, while the
next allows up to one-third. Choose and apply a single consistent threshold,
either one-fourth or one-third, throughout the section to remove ambiguity and
ensure clear enforcement.
| The voting process is automated using [gitvote](https://github.com/cncf/gitvote) to enhance TSC’s voting efficiency. Whenever you need to participate in a discussion or vote, you can use three emojies: | ||
| * 👍 (vote for) | ||
| * 👎 (vote against) | ||
| * 👀 (no opinion about a particular topic. So you may, for example, acknowledge a topic if you're not experienced in some area being voted/discussed). |
There was a problem hiding this comment.
Typo: “emojies” → “emojis”
Correct the plural to maintain professional polish.
🧰 Tools
🪛 LanguageTool
[grammar] ~66-~66: Ensure spelling is correct
Context: ...a discussion or vote, you can use three emojies: * 👍 (vote for) * 👎 (vote against) * ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In markdown/docs/community/020-governance-and-policies/TSC_MEMBERSHIP.md around
lines 66 to 69, correct the typo by changing the word "emojies" to the proper
plural form "emojis" to maintain professional polish in the document.
| ## Introduction | ||
| Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant community and ignite a passion for event-driven architecture and asynchronous APIs through AsyncAPI adoption. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture. All are powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment. | ||
|
|
||
| Welcome to our journey of fostering innovation and growth through the AsyncAPI community. As the Community Marketing Specialist, I'm thrilled to lead this initiative alongside our dedicated team. Our goal is to bring together a vibrant developer community and ignite a passion for event-driven architecture and asynchronous APIs. By embracing this mission, we aim to enhance open-source tools to easily build and maintain your event-driven architecture. All are powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs. This initiative is more than just an open-source project; it's a platform for collaboration, learning, building, and empowerment. | ||
|
|
There was a problem hiding this comment.
Duplicate paragraph
Lines 12-16 repeat almost verbatim. Remove one copy to avoid bloat and confusion.
🤖 Prompt for AI Agents
In
markdown/docs/community/030-project-vision-strategy-goals/2025_marketing_strategy.md
around lines 12 to 16, there is a duplicated paragraph repeated almost verbatim.
Remove one of the duplicate paragraphs entirely to avoid redundancy and improve
clarity in the introduction section.
| You must start with YouTube first, even though Restream can directly stream there. It is because by | ||
|
|
||
| This is what you need to do to kick it off: | ||
|
|
||
| 1. In [YouTube](https://youtube.com), click on your profile picture and select `Switch account`: |
There was a problem hiding this comment.
Incomplete sentence
“…even though Restream can directly stream there. It is because by” — trailing clause is unfinished. Please complete or remove to avoid reader confusion.
🤖 Prompt for AI Agents
In
markdown/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
around lines 78 to 82, the sentence ending with "It is because by" is incomplete
and causes confusion. Either complete the sentence with the intended explanation
or remove the trailing clause entirely to ensure the text reads clearly and
logically.
akshatnema
deleted the
update-community-docs-56781b1e6f8d072b87452688c6236247c1e436ba
branch
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation
Style