Skip to content

Commit 3efeea2

Browse files
author
asyncapi-bot
committed
docs(community): update latest community docs
1 parent 250823b commit 3efeea2

32 files changed

+75
-81
lines changed

markdown/docs/community/000-onboarding/ambassador-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ Examples:
3838
- Our sincere gratitude and respect for your contributions!
3939

4040
### Additional resources
41-
[AsyncAPI Ambassador Program](../020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md)
41+
[AsyncAPI Ambassador Program](../020-governance-and-policies/AMBASSADOR_PROGRAM)

markdown/docs/community/000-onboarding/docs-onboarding-checklist.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ As an open-source initiative with a global community, technical writer contribut
99
Complete in order the following onboarding tasks:
1010

1111
- [ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
12-
- [ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette.md).
12+
- [ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette).
1313
- [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite).
1414
- [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
15-
- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities.md).
16-
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge.md).
17-
- [ ] Familiarize yourself with the _work-in-progress_ [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
15+
- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities).
16+
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).
17+
- [ ] Familiarize yourself with the [AsyncAPI Style Guide](../011-styleguide).
1818
- [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
19-
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow.md).
19+
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow).
2020
- [ ] Introduce yourself in AsyncAPI Slack in the `#01_introductions` channel and the `#13_docs` channel. Ask docs-related questions in #13_docs.
2121
- [ ] Request a good first docs issue in the [`#13_docs` Slack channel](https://asyncapi.com/slack-invite).
2222
- [ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers.

markdown/docs/community/000-onboarding/maintainer-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Before you can become a **maintainer**, you need to start as a **contributor**.
4646
4747
### 2. Open a PR
4848

49-
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.md).
49+
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).
5050

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

markdown/docs/community/000-onboarding/upholding-code-of-conduct.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ If you experience or observe discrimination, harassment, or any behavior that vi
4444
### 2. Report the Incident
4545
You can report a CoC violation by:
4646

47-
- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](../CODE_OF_CONDUCT_COMMITTEE.md)
47+
- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](../CODE_OF_CONDUCT_COMMITTEE)
4848
- Reaching out to a specific CoC Committee member if the issue involves someone on the committee
4949

5050
All reports are handled with confidentiality, respect, and prompt action.
@@ -61,5 +61,5 @@ The Code of Conduct Committee is trained to resolve conflicts fairly and ensure
6161

6262

6363
## Additional Resources
64-
- [Incident Resolution Procedures](../COC-incident-resolution-procedures.md)
65-
- [Slack Etiquette Guidelines](../060-meetings-and-communication/slack-etiquette.md)
64+
- [Incident Resolution Procedures](../COC-incident-resolution-procedures)
65+
- [Slack Etiquette Guidelines](../060-meetings-and-communication/slack-etiquette)

markdown/docs/community/010-contribution-guidelines/Become-maintainer-in-existing-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Here's how to select an issue to contribute to:
2323

2424
**Step 2: Open a Pull Request**
2525

26-
To open a pull request successfully, follow our [Git workflows contributors guide](git-workflow.md).
26+
To open a pull request successfully, follow our [Git workflows contributors guide](git-workflow).
2727

2828
Use the following steps to open your pull request:
2929
1. Configure a fork
3030
2. Work on it locally
31-
3. Write an appropriate PR title using the [conventional commits specification](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits)
31+
3. Write an appropriate PR title using the [conventional commits specification](../010-contribution-guidelines/conventional-commits)
3232
4. Test your PR against GitHub checks to ensure they all pass
3333

3434
**Step 3: Get Pull Request Merged**
@@ -45,4 +45,4 @@ After making several contributions to AsyncAPI, maintainers will recognize you.
4545

4646
Once you become a maintainer in one of the repositories, you can apply to join a group of [TSC members](https://www.asyncapi.com/community/tsc).
4747

48-
Open a PR in the **community** repository to add your name to the [list of TSC members](../../TSC_BOARD_MEMBERS.yaml). Specify your name, repositories that you maintain, and if you are sponsored by some company. For example [see this PR that introduced one of the new TSC members](https://github.com/asyncapi/community/pull/277).
48+
Open a PR in the **community** repository to add your name to the [list of TSC members](https://github.com/asyncapi/community/blob/master/TSC_BOARD_MEMBERS.yaml). Specify your name, repositories that you maintain, and if you are sponsored by some company. For example [see this PR that introduced one of the new TSC members](https://github.com/asyncapi/community/pull/277).

markdown/docs/community/010-contribution-guidelines/code-contributor-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@ Welcome to the AsyncAPI community! We're excited to have you here. Think of Asyn
1313
## Prerequisites
1414
Before you begin contributing code, make sure you're familiar with the following:
1515

16-
- [Git Workflow Guide](git-workflow.md): Learn how to fork, branch, commit, and open pull requests.
16+
- [Git Workflow Guide](git-workflow): Learn how to fork, branch, commit, and open pull requests.
1717
- [Git](https://git-scm.com) and [GitHub](https://github.com): These are your primary tools for version control and collaboration. Learn the basics [here](https://docs.github.com/en/get-started).
1818
- Code Editor: Your tool to work with the source code of our repositories and version control. For example, [VS Code](https://code.visualstudio.com), [Sublime Text](https://www.sublimetext.com), [JetBrains IDEs](https://www.jetbrains.com/ides/), or any other tool you prefer.
1919
- [Node.js & npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm): AsyncAPI relies on JavaScript/TypeScript, so ensure these are installed and configured.
2020

2121
## Contribution Etiquette
2222
1. Follow the [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md)
23-
2. Stick to the [Contributing guidelines](../../CONTRIBUTING.md)
23+
2. Stick to the [Contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md)
2424
3. Document the "why" of your contribution(s). Make sure that someone who opens the code for the first time understands the changes you've made.
2525
4. Communicate openly through discussions on GitHub or designated Slack channels.
2626

2727
## Submit Your First Pull Request (PR)
2828

29-
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](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) while creating PRs and follow these steps:
29+
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:
3030

3131
### Create a Pull Request (PR)
3232

markdown/docs/community/010-contribution-guidelines/contribution-flow.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ At AsyncAPI, we value **quality over quantity**. This guide will help you make m
1818
- Read the [documentation](https://www.asyncapi.com/docs) to learn more about AsyncAPI.
1919

2020
### Before Making a Contribution
21-
- Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide).
22-
- If you are contributing to the community repository, review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist).
23-
- For other repositories, refer to the [general contribution guidelines](../../CONTRIBUTING.md).
21+
- Read the [onboarding contributor guide](../000-onboarding).
22+
- If you are contributing to the community repository, review the [documentation onboarding checklist](../000-onboarding/docs-onboarding-checklist).
23+
- For other repositories, refer to the [general contribution guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
2424
- Look through existing issues and pull requests to understand the repository better.
2525
- Check the [general roadmap](https://www.asyncapi.com/roadmap).
2626

2727
### Steps to making a good contribution
28-
1. Set up your workflow environment using the [git workflow guide](git-workflow.md).
28+
1. Set up your workflow environment using the [git workflow guide](git-workflow).
2929
2. Search for [good first issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22).
3030
3. When you find one, comment on your interest and share the approach to solving the issue (please don't ask to be assigned, as it could be flagged as spam).
3131
4. If you noticed a bug, typo, or needed improvement, feel free to create an issue.
3232
5. **Make a PR only after a maintainer assigned the issue to you or asks you to work on it** even if you created the issue yourself.
33-
6. Follow the [conventional commits guide](conventional-commits.md) to write a good PR title.
34-
7. Follow the [git workflow document](git-workflow.md) when working on your changes and making a PR.
33+
6. Follow the [conventional commits guide](conventional-commits) to write a good PR title.
34+
7. Follow the [git workflow document](git-workflow) when working on your changes and making a PR.
3535
8. After making a PR, patiently wait for reviews.
3636
9. Make sure all your PR checks pass (turn green) to speed up the merging process.
3737
10. If your PR hasn’t been reviewed after **a week and a half**, you can gently remind a maintainer on Slack or GitHub. Delays can happen for various reasons, but no one is ignoring you! 🙏🏼 .
@@ -46,7 +46,7 @@ These rules are here to help you succeed and to support the maintainers and comm
4646
- **Be patient**. Maintainers are volunteers with their jobs, families, and responsibilities. It may take time for your PR or issue to be reviewed.
4747
- **Use the right Slack channels**. If you're unsure where to post, ask politely or take a moment to check.
4848
- **Keep Slack tidy**. Use threads for conversations, avoid tagging `@maintainers` unless truly necessary, and don’t spam.
49-
- Follow our [Slack etiquette](../060-meetings-and-communication/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
49+
- Follow our [Slack etiquette](../060-meetings-and-communication/slack-etiquette) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
5050
- **Respect others**. Treat everyone with kindness and patience. We are all here to learn and grow together.
5151

5252
### ❌ What You Should Never Do
@@ -73,7 +73,7 @@ Before submitting your contribution, ask yourself:
7373
- [ ] Is my contribution relevant to AsyncAPI?
7474
- [ ] Have I explained why this contribution is necessary?
7575
- [ ] Is my writing clear, concise, and well-structured?
76-
- [ ] Did I follow the [documentation style guide](https://github.com/asyncapi/community/tree/master/docs/styleguide)?
76+
- [ ] Did I follow the [documentation style guide](../011-styleguide)?
7777
- [ ] Have my code examples been tested, and are they functional?
7878
- [ ] Have I linked any relevant issues, discussions, or existing docs?
7979
- [ ] Did I provide a description of the changes in my PR?

markdown/docs/community/010-contribution-guidelines/git-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ You can follow the steps from the [GitHub documentation](https://docs.github.com
118118
## Start Contributing
119119
120120
1. Create a branch on your fork.
121-
2. Commit changes with clear messages. Use the [Conventional Commits](https://github.com/asyncapi/community/pull/1733) format.
121+
2. Commit changes with clear messages. Use the [Conventional Commits](../010-contribution-guidelines/conventional-commits) format.
122122
3. Push changes to your fork:
123123
124124
```bash

markdown/docs/community/010-contribution-guidelines/identifying-good-first-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ AsyncAPI follows a "first come, first served" approach for assigning issues. Her
7373
- **Comment on the issue:** Start with saying something like, "Hey, I'd like to work on this!" so maintainers know you're interested.
7474

7575
- **Once you comment, wait for approval by maintainers:** They may guide you further (if needed) or might assign the issue to you. If there are no blockers, you can start working!
76-
- **Start coding**: Once approved, head on to the [git workflow guide](git-workflow.md), and start working!
76+
- **Start coding**: Once approved, head on to the [git workflow guide](git-workflow), and start working!
7777
- **Ask for help**: Don't hesitate to ask in the issue comments or the dedicated AsyncAPI Slack Channel if you're stuck.
7878

7979
So what are you waiting for? Go find your first quest, and let's build something awesome together!

markdown/docs/community/010-contribution-guidelines/open-docs-pull-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Create and submit a docs pull request (PR) via the following steps:
88

99
- A Docs’ PR should solve one documentation problem.
1010
- If there is no current issue for the docs task you want to accomplish, please open a docs issue before creating a PR.
11-
- Use the [conventional commit style](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.
11+
- 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.
1212
- Please check your contribution and ensure it follows the AsyncAPI style guide.
1313
- Tag other technical writers to review your document.
1414
- Tag an engineer or subject matter expert (SME) to review the technical details.

0 commit comments

Comments
 (0)