Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Find all the resources you need to start contributing to our organization.

1. Follow the [Code of Conduct](CODE_OF_CONDUCT.md) and help keep the community inclusive and respectful.

2. Read the [Contribution Guide](docs/010-contribution-guidelines/contribution-flow.md) and learn how to contribute effectively.
2. Read the [Contribution Guide](docs/community/
010-contribution-guidelines/contribution-flow.md) and learn how to contribute effectively.

3. Explore the [Community Contribution Onboarding Docs](docs/000-onboarding/docs-onboarding-checklist.md), a step-by-step guide for new contributors.

Expand Down
9 changes: 6 additions & 3 deletions docs/000-onboarding/docs-onboarding-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,14 @@ Complete in order the following onboarding tasks:
- [ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette).
- [ ] 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](../010-contribution-guidelines/technical-writer-contributor-responsibilities).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).
- [ ] Read the list of [technical writer contributor responsibilities](../community/
010-contribution-guidelines/technical-writer-contributor-responsibilities).
Comment on lines +15 to +16
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the multi-line URL syntax.

The link URL is split across two lines, which may not render correctly in all Markdown parsers. Keep the URL on a single line within the parentheses.

📝 Proposed fix
-- [ ] Read the list of [technical writer contributor responsibilities](../community/
-010-contribution-guidelines/technical-writer-contributor-responsibilities).
+- [ ] Read the list of [technical writer contributor responsibilities](../community/010-contribution-guidelines/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.

Suggested change
- [ ] Read the list of [technical writer contributor responsibilities](../community/
010-contribution-guidelines/technical-writer-contributor-responsibilities).
- [ ] Read the list of [technical writer contributor responsibilities](../community/010-contribution-guidelines/technical-writer-contributor-responsibilities).
🤖 Prompt for AI Agents
In `@docs/000-onboarding/docs-onboarding-checklist.md` around lines 15 - 16, The
markdown link for "technical writer contributor responsibilities" is split
across two lines; update the checklist item so the URL inside the parentheses is
on a single line (remove the newline between "../community/" and
"010-contribution-guidelines/technical-writer-contributor-responsibilities")
ensuring the entire URL sits on one line within the parentheses.

- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/
010-contribution-guidelines/prerequisite-knowledge).
Comment on lines +17 to +18
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the multi-line URL syntax.

The link URL is split across two lines, which may not render correctly in all Markdown parsers. Keep the URL on a single line within the parentheses.

📝 Proposed fix
-- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/
-010-contribution-guidelines/prerequisite-knowledge).
+- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/010-contribution-guidelines/prerequisite-knowledge).
📝 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.

Suggested change
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/
010-contribution-guidelines/prerequisite-knowledge).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/010-contribution-guidelines/prerequisite-knowledge).
🤖 Prompt for AI Agents
In `@docs/000-onboarding/docs-onboarding-checklist.md` around lines 17 - 18, The
Markdown link for "prerequisite knowledge topics" is broken across two lines;
update the line containing [prerequisite knowledge
topics](../community/010-contribution-guidelines/prerequisite-knowledge) so the
entire URL appears on a single line inside the parentheses (remove the newline
and join the path) to ensure correct rendering.

- [ ] Familiarize yourself with the [AsyncAPI Style Guide](../011-styleguide).
- [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow).
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../community/
010-contribution-guidelines/git-workflow).
Comment on lines +21 to +22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

# Check repository structure and locate the files mentioned
git ls-files | grep -E "(docs-onboarding-checklist|contribution-guidelines)" | head -20

Repository: asyncapi/community

Length of output: 1244


🏁 Script executed:

# List the docs directory structure to understand the layout
find docs -type d -name "*onboarding*" -o -name "*contribution*" | head -20

Repository: asyncapi/community

Length of output: 168


🏁 Script executed:

# Check if the specific file exists
fd -t f "docs-onboarding-checklist" docs/

Repository: asyncapi/community

Length of output: 110


🏁 Script executed:

# Look for git-workflow references
fd -t f "git-workflow" docs/

Repository: asyncapi/community

Length of output: 110


🏁 Script executed:

cat -n docs/000-onboarding/docs-onboarding-checklist.md | sed -n '15,30p'

Repository: asyncapi/community

Length of output: 1233


Fix the broken and malformed links to contribution guidelines.

The links reference a non-existent ../community/ subdirectory. The correct relative path from docs/000-onboarding/ is ../010-contribution-guidelines/. Additionally, these links are split across multiple lines, which may not render correctly.

Fix all three affected links (lines 15-22):

📝 Proposed fixes
-- [ ] Read the list of [technical writer contributor responsibilities](../community/
-010-contribution-guidelines/technical-writer-contributor-responsibilities).
+- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities).

-- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../community/
-010-contribution-guidelines/prerequisite-knowledge).
+- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).

-- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../community/
-010-contribution-guidelines/git-workflow).
+- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow).
🤖 Prompt for AI Agents
In `@docs/000-onboarding/docs-onboarding-checklist.md` around lines 21 - 22,
Update the malformed Markdown links that reference a non-existent ../community/
subdirectory: replace occurrences of
"../community/010-contribution-guidelines/git-workflow" with the correct
relative path "../010-contribution-guidelines/git-workflow" and ensure each link
(the three affected links referencing the "AsyncAPI git workflow" /
"contribution guidelines" checklist items) is written on a single line as a
standard Markdown link so it renders correctly.

- [ ] Introduce yourself in AsyncAPI Slack in the `#01_introductions` channel and the `#13_docs` channel. Ask docs-related questions in #13_docs.
- [ ] Request a good first docs issue in the [`#13_docs` Slack channel](https://asyncapi.com/slack-invite).
- [ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers.
3 changes: 2 additions & 1 deletion docs/000-onboarding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ weight: 2

The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively.

> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../010-contribution-guidelines)
> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../community/
010-contribution-guidelines)

The goal is providing docs contributors with the necessary tools and knowledge to:

Expand Down
3 changes: 2 additions & 1 deletion docs/000-onboarding/maintainer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ Before you can become a **maintainer**, you need to start as a **contributor**.

### 2. Open a PR

For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../010-contribution-guidelines/git-workflow).
For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../community/
010-contribution-guidelines/git-workflow).
Comment on lines +49 to +50
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify that target files exist at the new community/ paths

echo "Checking if contribution-guidelines files exist in community/ subdirectory..."

# List of target files referenced in the updated links
targets=(
  "docs/community/010-contribution-guidelines/git-workflow.md"
  "docs/community/010-contribution-guidelines/conventional-commits.md"
  "docs/community/010-contribution-guidelines/contribution-flow.md"
  "docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md"
  "docs/community/010-contribution-guidelines/index.md"
)

echo -e "\n=== Checking new community/ paths ==="
for target in "${targets[@]}"; do
  if [ -f "$target" ]; then
    echo "✓ EXISTS: $target"
  else
    echo "✗ MISSING: $target"
  fi
done

echo -e "\n=== Checking old non-community/ paths ==="
# Also check if files exist at the OLD paths (without community/)
old_targets=(
  "docs/010-contribution-guidelines/git-workflow.md"
  "docs/010-contribution-guidelines/conventional-commits.md"
  "docs/010-contribution-guidelines/contribution-flow.md"
  "docs/010-contribution-guidelines/Become-maintainer-in-existing-project.md"
)

for target in "${old_targets[@]}"; do
  if [ -f "$target" ]; then
    echo "✓ EXISTS: $target"
  else
    echo "✗ MISSING: $target"
  fi
done

echo -e "\n=== Actual directory structure ==="
# Show actual directory structure to confirm where files are located
echo "Contents of docs/:"
fd -t d -d 1 . docs/ 2>/dev/null || find docs/ -mindepth 1 -maxdepth 1 -type d

echo -e "\nContents of docs/010-contribution-guidelines/:"
fd -t f . docs/010-contribution-guidelines/ 2>/dev/null | head -10 || find docs/010-contribution-guidelines/ -type f 2>/dev/null | head -10

if [ -d "docs/community" ]; then
  echo -e "\nContents of docs/community/:"
  fd -t d -d 2 . docs/community/ 2>/dev/null || find docs/community/ -mindepth 1 -maxdepth 2 -type d 2>/dev/null
fi

Repository: asyncapi/community

Length of output: 1824


Links to contribution-guidelines files will be broken.

The verification confirms that all target files referenced in the updated links do NOT exist at the new docs/community/010-contribution-guidelines/ paths. The files remain at their original locations: docs/010-contribution-guidelines/. No docs/community/ subdirectory exists in the repository.

Adding the community/ segment to these paths will create broken links (404s). Either revert the path changes to remove the community/ prefix, or move the contribution-guidelines files to the docs/community/010-contribution-guidelines/ directory structure.

🤖 Prompt for AI Agents
In `@docs/000-onboarding/maintainer-guide.md` around lines 49 - 50, The link in
maintainer-guide.md was changed to include a non-existent community/ segment
("../community/010-contribution-guidelines/git-workflow") which causes a broken
link; revert the link target to the existing path
("../010-contribution-guidelines/git-workflow") or move the
contribution-guidelines files into docs/community/010-contribution-guidelines
and update all references accordingly so that references like
"../community/010-contribution-guidelines/git-workflow" point to an actual file;
update the link in the maintainer-guide.md line that contains the AsyncAPI Git
Workflow Guide reference to use the correct existing path or ensure the files
are relocated to match the new path.


- **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ To open a pull request successfully, follow our [Git workflows contributors guid
Use the following steps to open your pull request:
1. Configure a fork
2. Work on it locally
3. Write an appropriate PR title using the [conventional commits specification](../010-contribution-guidelines/conventional-commits)
3. Write an appropriate PR title using the [conventional commits specification](../community/
010-contribution-guidelines/conventional-commits)
4. Test your PR against GitHub checks to ensure they all pass

**Step 3: Get Pull Request Merged**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Welcome to the AsyncAPI community! We're excited to have you here. Think of Asyn

## Submit Your First Pull Request (PR)

Once you've made and committed your changes (following the Git Workflow guide), you need to create a Pull Request (PR) to propose merging your work into the official AsyncAPI repository. Make sure to use the [conventional commit style](../010-contribution-guidelines/conventional-commits) while creating PRs and follow these steps:
Once you've made and committed your changes (following the Git Workflow guide), you need to create a Pull Request (PR) to propose merging your work into the official AsyncAPI repository. Make sure to use the [conventional commit style](../community/
010-contribution-guidelines/conventional-commits) while creating PRs and follow these steps:

### Create a Pull Request (PR)

Expand Down
3 changes: 2 additions & 1 deletion docs/010-contribution-guidelines/git-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ You can follow the steps from the [GitHub documentation](https://docs.github.com
## Start Contributing

1. Create a branch on your fork.
2. Commit changes with clear messages. Use the [Conventional Commits](../010-contribution-guidelines/conventional-commits) format.
2. Commit changes with clear messages. Use the [Conventional Commits](../community/
010-contribution-guidelines/conventional-commits) format.
3. Push changes to your fork:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Create and submit a docs pull request (PR) via the following steps:

- A Docs’ PR should solve one documentation problem.
- If there is no current issue for the docs task you want to accomplish, please open a docs issue before creating a PR.
- Use the [conventional commit style](../010-contribution-guidelines/conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.
- Use the [conventional commit style](../community/
010-contribution-guidelines/conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.
- Please check your contribution and ensure it follows the AsyncAPI style guide.
- Tag other technical writers to review your document.
- Tag an engineer or subject matter expert (SME) to review the technical details.
Expand Down
6 changes: 4 additions & 2 deletions docs/011-styleguide/styling.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,11 @@ Use asterisks for italics (`*italic*`) and bold (`**bold**`). You can also use u
### Links
Use square brackets to describe links and a parenthesis to insert the actual links. Always use descriptive link text. Avoid phrases like "click here."

- **✅ Good:** See our [Contribution Guide](../010-contribution-guidelines) for more.
- **✅ Good:** See our [Contribution Guide](../community/
010-contribution-guidelines) for more.

- **❌ Bad:** For more info, [click here](../010-contribution-guidelines).
- **❌ Bad:** For more info, [click here](../community/
010-contribution-guidelines).
Comment on lines +135 to +139
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the multi-line URL syntax in link examples.

These are example snippets demonstrating proper link formatting, but the URLs are split across multiple lines, which is non-standard Markdown syntax. The examples should demonstrate correct single-line URL formatting.

📝 Proposed fix for both examples
-- **✅ Good:** See our [Contribution Guide](../community/
-010-contribution-guidelines) for more.
+- **✅ Good:** See our [Contribution Guide](../community/010-contribution-guidelines) for more.

-- **❌ Bad:** For more info, [click here](../community/
-010-contribution-guidelines).
+- **❌ Bad:** For more info, [click here](../community/010-contribution-guidelines).
📝 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.

Suggested change
- **✅ Good:** See our [Contribution Guide](../community/
010-contribution-guidelines) for more.
- **❌ Bad:** For more info, [click here](../010-contribution-guidelines).
- **❌ Bad:** For more info, [click here](../community/
010-contribution-guidelines).
- **✅ Good:** See our [Contribution Guide](../community/010-contribution-guidelines) for more.
- **❌ Bad:** For more info, [click here](../community/010-contribution-guidelines).
🤖 Prompt for AI Agents
In `@docs/011-styleguide/styling.md` around lines 135 - 139, The link examples
split the URL across two lines in the markdown snippets for the "[Contribution
Guide]" link; fix both instances by merging the broken URL into a single
continuous path (e.g., replace the multi-line "(../community/
010-contribution-guidelines)" occurrences used in the "**✅ Good:** See our
[Contribution Guide](...)" and "**❌ Bad:** For more info, [click here](...)"
examples so the target URL is one uninterrupted string inside the parentheses.


### Code Blocks
Use backticks for inline code (`const foo = 'bar';`). For code blocks, use triple backticks and specify the language for syntax highlighting.
Expand Down
3 changes: 2 additions & 1 deletion docs/011-styleguide/version-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,5 @@ When contributing to documentation, keep the following in mind:

### Need Help?

Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow).
Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/
010-contribution-guidelines/contribution-flow).
Comment on lines +98 to +99
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find the actual location of contribution-flow.md
echo "=== Searching for contribution-flow.md ==="
fd -t f "contribution-flow.md"

# Check the docs directory structure
echo -e "\n=== Docs directory structure ==="
find docs -type d -name "*contribution*" -o -name "*onboarding*" | head -20

# Verify the file under review exists
echo -e "\n=== Checking the file under review ==="
if [ -f "docs/011-styleguide/version-control.md" ]; then
  echo "File exists at docs/011-styleguide/version-control.md"
  # Show lines 98-99 with context
  echo -e "\n=== Lines 95-102 from version-control.md ==="
  sed -n '95,102p' docs/011-styleguide/version-control.md
else
  echo "File not found at expected path"
fi

Repository: asyncapi/community

Length of output: 737


Fix the broken link path and remove the multi-line syntax.

The link target ../community/010-contribution-guidelines/contribution-flow is incorrect—there is no community subdirectory in the docs folder. The correct path is ../010-contribution-guidelines/contribution-flow. Additionally, the URL is split across two lines, breaking Markdown link syntax.

Proposed fix
-Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/
-010-contribution-guidelines/contribution-flow).
+Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow).
📝 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.

Suggested change
Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../community/
010-contribution-guidelines/contribution-flow).
Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow).
🤖 Prompt for AI Agents
In `@docs/011-styleguide/version-control.md` around lines 98 - 99, Update the
broken Markdown link in the text that currently points to
../community/010-contribution-guidelines/contribution-flow and is split across
lines: replace it with a single-line link target
../010-contribution-guidelines/contribution-flow so the link Markdown is not
broken (edit the link text "AsyncAPI contribution flow guidelines" to reference
../010-contribution-guidelines/contribution-flow on one line).

3 changes: 2 additions & 1 deletion docs/020-governance-and-policies/TSC_MEMBERSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ To become a TSC member, you must be a project maintainer within the AsyncAPI Ini
You can become a maintainer by either:
1. Initiating a new repository or project and becoming its maintainer.
2. Donating to an existing repository or project and continuing to maintain it.
3. Supporting and committing to existing projects and being invited by other maintainers to join them as a maintainer. For more information, refer to [Become a maintainer in an existing project](../010-contribution-guidelines/Become-maintainer-in-existing-project).
3. Supporting and committing to existing projects and being invited by other maintainers to join them as a maintainer. For more information, refer to [Become a maintainer in an existing project](../community/
010-contribution-guidelines/Become-maintainer-in-existing-project).

There's no invitation flow to join the TSC; it's something that you are allowed to do as a maintainer by default, as described in the [charter signed with the Linux Foundation when AsyncAPI joined the foundation](CHARTER). Instead, there is an automation flow in place that adds a new maintainer to the [`community/MAINTAINERS.yaml`](https://github.com/asyncapi/community/blob/master/MAINTAINERS.yaml) list every time the [CODEOWNERS][code-owners] file is updated in any project. And the only thing you need to do is to find your name in the `MAINTAINERS.yaml` list and change `isTscMember` from `false` to `true` along with updating other missing information like, for example, your `slack` ID.

Expand Down