-
-
Notifications
You must be signed in to change notification settings - Fork 692
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: replace duplicated content with reusable fragments #3269
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. ❤️ | ||||||||
|
||||||||
Comment on lines
+1
to
+2
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great introduction, minor grammatical fix needed. The introduction effectively emphasizes the importance of documentation contributions. However, there's a minor grammatical issue to address. Please apply the following change: -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. ❤️
+Code isn't the only way to contribute to OSS; Dev Docs are a **huge** help that benefits the entire OSS ecosystem. At AsyncAPI, we value Doc contributions as much as every other type of contribution. ❤️ This change ensures subject-verb agreement between "help" and "benefits". 📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @bandantonio ptal There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||||||||
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) 🐙. |
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 /> |
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.✨ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great stuff with
@
instead of super complex../../../
paths!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tsconfig.json
has proper configuration for aliases, idk why this feature hasn't been used here :)