-
-
Notifications
You must be signed in to change notification settings - Fork 692
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: replace duplicated content with reusable fragments
- Loading branch information
1 parent
44e57e7
commit 4f100e6
Showing
21 changed files
with
106 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
Code isn't the only way to contribute to OSS; Dev Docs are a **huge** help that benefit the entire OSS ecosystem. At AsyncAPI, we value Doc contributions as much as every other type of contribution. β€οΈ | ||
|
||
To get started as a Docs contributor: | ||
|
||
1. Familiarize yourself with our [project's Contribution Guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) and our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). | ||
2. Head over to our [AsyncAPI Docs Board](https://github.com/orgs/asyncapi/projects/12). | ||
3. Pick an issue you would like to contribute to and leave a comment introducing yourself. This is also the perfect place to leave any questions you may have on how to get started. | ||
4. If there is no work done in that Docs issue yet, feel free to open a PR and get started! | ||
|
||
### Docs contributor questions | ||
|
||
Do you have a documentation contributor question and you're wondering how to tag me into a GitHub discussion or PR? Never fear! | ||
|
||
Tag me in your AsyncAPI Doc PRs or [GitHub Discussions](https://github.com/asyncapi/community/discussions/categories/docs) via my GitHub handle, [`alequetzalli`](https://github.com/alequetzalli) π. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,10 @@ | ||
## How to contribute to AsyncAPI Docs | ||
|
||
Did you know that you can contribute Docs to AsyncAPI as well? Code isn't the only way to contribute to OSS; Dev Docs are a **huge** help that benefit the entire OSS ecosystem. At AsyncAPI, we value Doc contributions as much as every other type of contribution. β€οΈ | ||
|
||
To get started as a Docs contributor: | ||
|
||
1. Familiarize yourself with our [project's Contribution Guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) and our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). | ||
|
||
2. Head over to our Docs GH Board [here](https://github.com/orgs/asyncapi/projects/12). | ||
import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; | ||
import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; | ||
|
||
3. Pick an issue you would like to contribute to and leave a comment introducing yourself. This is also the perfect place to leave any questions you may have on how to get started. | ||
|
||
4. If there is no work done in that Docs issue yet, feel free to open a PR and get started! | ||
|
||
### Tag me in your AsyncAPI Doc PRs | ||
|
||
Do you have a documentation contributor question and you're wondering how to tag me into a GitHub discussion or PR? Never fear! | ||
## How to contribute to AsyncAPI Docs | ||
|
||
Tag me in your AsyncAPI Doc PRs or [GitHub Discussions](https://github.com/asyncapi/community/discussions/categories/docs) via my GitHub handle, [`/alequetzalli`](https://github.com/alequetzalli) π. | ||
Did you know that you can contribute Docs to AsyncAPI as well? | ||
<ContributionNotes /> | ||
|
||
### Talk to me | ||
|
||
I want and need to listen ππ½ to all of your perspectives and ideas. Please don't be shy to express to me what you think needs to be documented first or what is missing. π There's a lot of good work ahead, but **you** determine _our content roadmap_ because the OSS community needs should always come first.β¨ | ||
<TalkToMe /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
I want and need to listen ππ½ to all of your perspectives and ideas. Please don't be shy to express to me what you think needs to be documented first or what is missing. π There's a lot of good work ahead, but **you** determine _our content roadmap_ because the OSS community needs should always come first.β¨ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.