docs(community): update latest community documentation #3631
Conversation
asyncapi-bot
requested review from
quetzalliwrites,
asyncapi-bot-eve,
derberg,
akshatnema,
magicmatatjahu,
anshgoyalevil and
Mayaleeeee
as code owners
WalkthroughThis pull request introduces a comprehensive onboarding guide for technical writers in the AsyncAPI community. The changes include adding a new configuration entry in Changes
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
|
asyncapi-bot
requested review from
devilkiller-ag,
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3631 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (10)
markdown/docs/community/onboarding-guide/index.md (1)
15-15: Fix hyphenation in "subject matter".For consistency with technical writing standards, "subject matter" should be hyphenated when used as a compound modifier.
-* Connect with teammates and subject matter experts (SMEs). +* Connect with teammates and subject-matter experts (SMEs).🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: This term is normally spelled with a hyphen.
Context: ...audiences. * Connect with teammates and subject matter experts (SMEs). * Report documentation bugs via...(SUBJECT_MATTER_HYPHEN)
markdown/docs/community/onboarding-guide/open-docs-pull-request.md (2)
6-6: Fix grammar in heading.The article "a" shouldn't be used with the plural noun "docs".
-## Create a new docs pull request +## Create a new documentation pull request🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: The plural noun “docs” cannot be used with the article “a”. Did you mean “a new doc” or “new docs”?
Context: ...ull request' weight : 90 --- ## Create a new docs pull request Create and submit a docs ...(A_NNS)
14-14: Fix hyphenation in "subject matter".For consistency with technical writing standards, "subject matter" should be hyphenated when used as a compound modifier.
-Tag an engineer or subject matter expert (SME) to review the technical details. +Tag an engineer or subject-matter expert (SME) to review the technical details.🧰 Tools
🪛 LanguageTool
[grammar] ~14-~14: This term is normally spelled with a hyphen.
Context: ...ew your document. - Tag an engineer or subject matter expert (SME) to review the technical details. ...(SUBJECT_MATTER_HYPHEN)
markdown/docs/community/onboarding-guide/tools-and-setup.md (1)
16-16: Fix grammar: "Setup" vs "Set up".When used as a verb, "set up" should be two words.
-## Setup your AsyncAPI local environment +## Set up your AsyncAPI local environment🧰 Tools
🪛 LanguageTool
[grammar] ~16-~16: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...scm.com), a version control system. ## Setup your AsyncAPI local environment 1. Fork...(SENT_START_NN_DT)
markdown/docs/community/onboarding-guide/docs-onboarding-checklist.md (1)
1-22: Consider adding estimated time commitmentsThe checklist is well-structured and comprehensive. Consider adding estimated time commitments for each task to help contributors plan their onboarding journey effectively.
markdown/docs/community/onboarding-guide/docs-community.md (2)
6-6: Improve grammar in the introductionConsider rephrasing to use proper noun forms:
-Join OPEN docs community meetings via Zoom, a regular space for docs contributors to meet and help each other. +Join OPEN documentation community meetings via Zoom, a regular space for documentation contributors to meet and help each other.🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: Nouns are not usually modified by plural nouns. Is it possible that you meant to use the singular or possessive form here?
Context: ... meetings via Zoom, a regular space for docs contributors to meet and help each othe...(PLURAL_MODIFIER)
23-27: Enhance roadmap table with specific timelinesThe "Timeline" column currently only shows "Ongoing". Consider adding more specific timeframes or milestones to help contributors understand project priorities and deadlines.
markdown/docs/community/onboarding-guide/technical-writer-contributor-responsibilities.md (1)
6-6: Fix hyphenation in "Subject Matter Experts"The term should be hyphenated:
-In the AsyncAPI community, technical writers collaborate with other technical writers, Subject Matter Experts (SME), designers, engineers, and core maintainers. +In the AsyncAPI community, technical writers collaborate with other technical writers, Subject-Matter Experts (SME), designers, engineers, and core maintainers.🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: This term is normally spelled with a hyphen.
Context: ...llaborate with other technical writers, Subject Matter Experts (SME), designers, engineers, and core m...(SUBJECT_MATTER_HYPHEN)
markdown/docs/community/onboarding-guide/prerequisite-knowledge.md (2)
22-22: Fix Markdown capitalizationCapitalize "Markdown" as it's a proper noun:
-Our diagrams are created with [Mermaid markdown syntax](https://mermaid.live/) thanks to the [mermaid.js](https://mermaid.js.org/) dependency. +Our diagrams are created with [Mermaid Markdown syntax](https://mermaid.live/) thanks to the [mermaid.js](https://mermaid.js.org/) dependency.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ... Our diagrams are created with Mermaid markdown syntax thanks t...(MARKDOWN_NNP)
35-36: Remove redundant project nameAvoid repeating "AsyncAPI" in the same sentence:
-## Protocols used with AsyncAPI -AsyncAPI supports several protocols, such as Kafka, AMQP, MQTT, and more. +## Supported Protocols +The specification supports several protocols, such as Kafka, AMQP, MQTT, and more.🧰 Tools
🪛 LanguageTool
[duplication] ~35-~35: Possible typo: you repeated a word.
Context: ...tate of EDAs.) ## Protocols used with AsyncAPI AsyncAPI supports several protocols, such as Kaf...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
config/edit-page-config.json(1 hunks)markdown/docs/community/onboarding-guide/_section.md(1 hunks)markdown/docs/community/onboarding-guide/contribute-to-docs.md(1 hunks)markdown/docs/community/onboarding-guide/create-new-docs-directories.md(1 hunks)markdown/docs/community/onboarding-guide/docs-community.md(1 hunks)markdown/docs/community/onboarding-guide/docs-onboarding-checklist.md(1 hunks)markdown/docs/community/onboarding-guide/index.md(1 hunks)markdown/docs/community/onboarding-guide/open-docs-pull-request.md(1 hunks)markdown/docs/community/onboarding-guide/prerequisite-knowledge.md(1 hunks)markdown/docs/community/onboarding-guide/technical-writer-contributor-responsibilities.md(1 hunks)markdown/docs/community/onboarding-guide/tools-and-setup.md(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- markdown/docs/community/onboarding-guide/_section.md
- markdown/docs/community/onboarding-guide/contribute-to-docs.md
🧰 Additional context used
🪛 LanguageTool
markdown/docs/community/onboarding-guide/index.md
[grammar] ~15-~15: This term is normally spelled with a hyphen.
Context: ...audiences. * Connect with teammates and subject matter experts (SMEs). * Report documentation bugs via...
(SUBJECT_MATTER_HYPHEN)
markdown/docs/community/onboarding-guide/open-docs-pull-request.md
[grammar] ~6-~6: The plural noun “docs” cannot be used with the article “a”. Did you mean “a new doc” or “new docs”?
Context: ...ull request' weight : 90 --- ## Create a new docs pull request Create and submit a docs ...
(A_NNS)
[grammar] ~14-~14: This term is normally spelled with a hyphen.
Context: ...ew your document. - Tag an engineer or subject matter expert (SME) to review the technical details. ...
(SUBJECT_MATTER_HYPHEN)
markdown/docs/community/onboarding-guide/tools-and-setup.md
[grammar] ~16-~16: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...scm.com), a version control system. ## Setup your AsyncAPI local environment 1. Fork...
(SENT_START_NN_DT)
markdown/docs/community/onboarding-guide/docs-community.md
[grammar] ~6-~6: Nouns are not usually modified by plural nouns. Is it possible that you meant to use the singular or possessive form here?
Context: ... meetings via Zoom, a regular space for docs contributors to meet and help each othe...
(PLURAL_MODIFIER)
markdown/docs/community/onboarding-guide/create-new-docs-directories.md
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...for that directory. 2. _section.md: Used for reusable components or partial...
(UNLIKELY_OPENING_PUNCTUATION)
markdown/docs/community/onboarding-guide/prerequisite-knowledge.md
[grammar] ~22-~22: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ... Our diagrams are created with Mermaid markdown syntax thanks t...
(MARKDOWN_NNP)
[duplication] ~35-~35: Possible typo: you repeated a word.
Context: ...tate of EDAs.) ## Protocols used with AsyncAPI AsyncAPI supports several protocols, such as Kaf...
(ENGLISH_WORD_REPEAT_RULE)
markdown/docs/community/onboarding-guide/technical-writer-contributor-responsibilities.md
[grammar] ~6-~6: This term is normally spelled with a hyphen.
Context: ...llaborate with other technical writers, Subject Matter Experts (SME), designers, engineers, and core m...
(SUBJECT_MATTER_HYPHEN)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (6)
config/edit-page-config.json (1)
21-26: LGTM! The new config entry is properly structured.The addition follows the existing pattern and points to the correct repository path.
markdown/docs/community/onboarding-guide/index.md (1)
1-4: LGTM! Well-structured frontmatter.The title and weight are appropriately set for the introduction page.
markdown/docs/community/onboarding-guide/open-docs-pull-request.md (1)
12-12: Add link to AsyncAPI style guide.The document mentions the AsyncAPI style guide but doesn't provide a link to it.
Please add a link to the style guide document. I can help verify the correct URL:
✅ Verification successful
Add link to AsyncAPI Style Guide:
https://github.com/asyncapi/website/issues/1240The AsyncAPI Style Guide is currently a work in progress, tracked in the epic issue #1240. This is the official reference point for style guide content and tasks.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for style guide references in the repository rg -i "style.?guide" --type mdLength of output: 4893
markdown/docs/community/onboarding-guide/create-new-docs-directories.md (1)
17-24: LGTM! Clear instructions with helpful visualization.The mermaid flowchart effectively illustrates the directory structure and relationships.
markdown/docs/community/onboarding-guide/tools-and-setup.md (1)
24-44: LGTM! Clear and comprehensive setup instructions.The commands are well-documented and follow a logical sequence.
markdown/docs/community/onboarding-guide/prerequisite-knowledge.md (1)
1-36: Well-structured prerequisite knowledge documentationThe document provides a clear and comprehensive overview of the required knowledge for technical writers. The organization into distinct sections makes it easy to follow and understand the requirements.
🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ... Our diagrams are created with Mermaid markdown syntax thanks t...(MARKDOWN_NNP)
[duplication] ~35-~35: Possible typo: you repeated a word.
Context: ...tate of EDAs.) ## Protocols used with AsyncAPI AsyncAPI supports several protocols, such as Kaf...(ENGLISH_WORD_REPEAT_RULE)
| - [ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md). | ||
| - [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite). | ||
| - [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events). | ||
| - [ ] Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities.md). |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix internal documentation link format
The link to technical writer responsibilities includes the .md extension which should be removed for proper rendering:
-Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities.md).
+Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [ ] Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities.md). | |
| - [ ] Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities). |
There was a problem hiding this comment.
@thulieblack This is a valid issue, please fix this doc in the community repo first.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
|
/dnm |
Updated community documentation is available and this PR introduces update to community folder on the website
Summary by CodeRabbit
New Features
Documentation
Chores