From 4f100e64d2b9aeb04a929ec474d7e17501746827 Mon Sep 17 00:00:00 2001 From: Antonio Date: Fri, 4 Oct 2024 22:27:04 +0300 Subject: [PATCH] docs: replace duplicated content with reusable fragments --- README.md | 18 +++++++++++++ assets/docs/fragments/contribution-notes.md | 14 +++++++++++ assets/docs/fragments/how-to-contribute.md | 25 +++++-------------- assets/docs/fragments/talk-to-me.md | 1 + markdown/blog/2023-April-docs-report.md | 19 +++++--------- markdown/blog/2023-Q1-docs-report.md | 19 +++++--------- markdown/blog/2023-Q4-docs-report.md | 20 +++++---------- markdown/blog/2023-july-docs-report.md | 22 ++++++---------- markdown/blog/2023-june-docs-report.md | 20 +++++---------- markdown/blog/2023-may-docs-report.md | 19 +++++--------- markdown/blog/changes-coming-docs.md | 23 +++++------------ markdown/blog/google-season-of-docs-2022.md | 16 +++--------- markdown/docs/community/index.md | 14 +++-------- .../asyncapi-document/adding-bindings.md | 2 +- markdown/docs/concepts/index.md | 14 +++-------- markdown/docs/guides/index.md | 14 +++-------- markdown/docs/reference/bindings/index.md | 2 +- markdown/docs/reference/index.md | 14 +++-------- markdown/docs/tools/index.md | 17 +++---------- markdown/docs/tutorials/generate-code.md | 2 +- markdown/docs/tutorials/index.md | 14 +++-------- 21 files changed, 106 insertions(+), 203 deletions(-) create mode 100644 assets/docs/fragments/contribution-notes.md create mode 100644 assets/docs/fragments/talk-to-me.md diff --git a/README.md b/README.md index 5eab72063aa1..543ff41d935c 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,24 @@ After cloning repository to your local, perform the following steps from the roo Now you're running AsyncAPI website in a development mode. Container is mapped with your local copy of the website. Whenever you make changes to the code, the website will refresh and changes visible in localhost:3000. +## Use shared Markdown fragments + +To minimize the duplication of content and make it easier to maintain, there are shared fragments you can use when working with Markdown files. These fragments are stored in the `/assets/docs/fragments` directory. + +To include a fragment in a Markdown file: + +1. Import the fragment at the top of the file (but below the frontmatter) using the following syntax: + + ```md + import DesiredFragmentName from '@/assets/docs/fragments/fragmentYouWantToImport.md'; + ``` + +1. Add the imported fragment to the desired location in the Markdown file using the following syntax: + + ```md + + ``` + ## Lint the code To lint the code, run the following command: ``` diff --git a/assets/docs/fragments/contribution-notes.md b/assets/docs/fragments/contribution-notes.md new file mode 100644 index 000000000000..5c10d80c480f --- /dev/null +++ b/assets/docs/fragments/contribution-notes.md @@ -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) πŸ™. diff --git a/assets/docs/fragments/how-to-contribute.md b/assets/docs/fragments/how-to-contribute.md index 932347021a1c..1f3711096e3d 100644 --- a/assets/docs/fragments/how-to-contribute.md +++ b/assets/docs/fragments/how-to-contribute.md @@ -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? + ### 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.✨ \ No newline at end of file + \ No newline at end of file diff --git a/assets/docs/fragments/talk-to-me.md b/assets/docs/fragments/talk-to-me.md new file mode 100644 index 000000000000..c1066a563f1a --- /dev/null +++ b/assets/docs/fragments/talk-to-me.md @@ -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.✨ diff --git a/markdown/blog/2023-April-docs-report.md b/markdown/blog/2023-April-docs-report.md index d57467c04693..3a8feb36e68e 100644 --- a/markdown/blog/2023-April-docs-report.md +++ b/markdown/blog/2023-April-docs-report.md @@ -13,6 +13,9 @@ authors: byline: In April 2023, the AsyncAPI documentation experienced significant growth with 8,889 sessions and 4,575 unique users, including 2,895 new users. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; + # AsyncAPI Docs Report - April 2023 In April 2023, the AsyncAPI documentation experienced significant growth with **8,889 sessions** and **4,575 unique users**, including **2,895 new users**. April was a strong month for our expanding docs community. @@ -109,18 +112,8 @@ style DC fill:#E1FEC1,stroke:#000000,stroke-width:2px; --- ## 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; 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). -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! - -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? + ### 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.✨ + diff --git a/markdown/blog/2023-Q1-docs-report.md b/markdown/blog/2023-Q1-docs-report.md index ef6ccc759956..1c90d29c37ed 100644 --- a/markdown/blog/2023-Q1-docs-report.md +++ b/markdown/blog/2023-Q1-docs-report.md @@ -14,6 +14,9 @@ authors: excerpt: 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. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; + # AsyncAPI Documentation Report - Q1 2023 During Q1 2023, AsyncAPI Docs had **26,875 sessions** and **13,506 unique users**. @@ -170,18 +173,8 @@ style G fill:#FF6EC7,stroke:#000000,stroke-width:2px; --- ## 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). -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! - -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? + ### 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.✨ + diff --git a/markdown/blog/2023-Q4-docs-report.md b/markdown/blog/2023-Q4-docs-report.md index 8805ec444b47..8baaf02d3c04 100644 --- a/markdown/blog/2023-Q4-docs-report.md +++ b/markdown/blog/2023-Q4-docs-report.md @@ -14,6 +14,9 @@ authors: excerpt: In Q4, AsyncAPI docs had primary engagement across the tutorials and reference content buckets. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; + # AsyncAPI Documentation Report - Q4 2023 As a core maintainer of AsyncAPI Docs, I (Alejandra Quetzalli) volunteer to write periodic updates about the AsyncAPI Docs ecosystem. The goal is to keep the community informed about what's going on in docs and how docs contributors collaborate with other areas in AsyncAPI Initiative. @@ -94,19 +97,8 @@ A --> H --- ### 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; 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. ❀️ - -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). -3. Pick an issue you would like to contribute to and leave a comment introducing yourself and questions 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! -5. Send me a DM in Slack! - -#### 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! - -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? + #### 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.✨ + diff --git a/markdown/blog/2023-july-docs-report.md b/markdown/blog/2023-july-docs-report.md index 34b0fb112284..867d3359c466 100644 --- a/markdown/blog/2023-july-docs-report.md +++ b/markdown/blog/2023-july-docs-report.md @@ -11,7 +11,10 @@ authors: photo: /img/avatars/canela-ale.webp link: https://www.linkedin.com/in/alejandra-quetzalli/ byline: In July 2023, the AsyncAPI documentation had 7,443 sessions and 3,895 unique users, including 2,345 new users. ---- +--- + +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; # AsyncAPI Docs Report - July 2023 @@ -87,19 +90,8 @@ A --> H --- ### 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; 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). -3. Pick an issue you would like to contribute to and leave a comment introducing yourself and questions 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! -5. Send me a DM in Slack! - -#### 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! - -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? + #### 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.✨ \ No newline at end of file + \ No newline at end of file diff --git a/markdown/blog/2023-june-docs-report.md b/markdown/blog/2023-june-docs-report.md index c15a462c2e53..604548186a21 100644 --- a/markdown/blog/2023-june-docs-report.md +++ b/markdown/blog/2023-june-docs-report.md @@ -13,6 +13,9 @@ authors: byline: In June 2023, the AsyncAPI documentation had 7,827 sessions and 4,203 unique users, including 2,566 new users. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; + # AsyncAPI Docs Report - June 2023 In June 2023, the AsyncAPI documentation had **7,827 sessions** and **4,203 unique users**, including **2,566 new users**, showing consistent engagement within our vibrant docs community. @@ -120,19 +123,8 @@ style K fill:#C1F9F7,stroke:#000000,stroke-width:2px; --- ### 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; 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). -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! -5. Send me a DM in Slack! - -#### 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! - -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? + #### 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.✨ + diff --git a/markdown/blog/2023-may-docs-report.md b/markdown/blog/2023-may-docs-report.md index a60248dd4061..2b21c61b1f64 100644 --- a/markdown/blog/2023-may-docs-report.md +++ b/markdown/blog/2023-may-docs-report.md @@ -13,6 +13,9 @@ authors: byline: In May 2023, the AsyncAPI documentation had 9,453 sessions and 4,876 unique users, including 2,895 new users. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; + # AsyncAPI Docs Report - May 2023 In May 2023, the AsyncAPI documentation had **9,453 sessions** and **4,876 unique users**, including **2,895 new users**, highlighting the increasing interest and engagement within our vibrant docs community. May was a busy month in our expanding docs community! @@ -71,18 +74,8 @@ style DA fill:#E1FEC1,stroke:#000000,stroke-width:2px; --- ## 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; 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). -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! - -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? + ### 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.✨ + diff --git a/markdown/blog/changes-coming-docs.md b/markdown/blog/changes-coming-docs.md index e39864b456f8..cd2291fa5152 100644 --- a/markdown/blog/changes-coming-docs.md +++ b/markdown/blog/changes-coming-docs.md @@ -14,6 +14,9 @@ authors: excerpt: 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. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; + ## πŸ¦„ Hola, soy Alejandra Quetzalli Β‘Hola! πŸ˜„ @@ -122,22 +125,8 @@ Think of a How-To as the bucket to address problems and advanced scenarios that *** ## πŸ‘‰πŸ½ 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/8). -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! - -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? + ## πŸ™‚ 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.✨ + diff --git a/markdown/blog/google-season-of-docs-2022.md b/markdown/blog/google-season-of-docs-2022.md index 7e35562a821b..c83a1bcba9e8 100644 --- a/markdown/blog/google-season-of-docs-2022.md +++ b/markdown/blog/google-season-of-docs-2022.md @@ -14,6 +14,8 @@ authors: excerpt: Check out the Docs project proposal we're submitting to GSoD 2022! You won't want to miss out. --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Β‘Hola, AsyncAPI community! For today's blog post about AsyncAPI Docs πŸ“‘, I wanted to share with all technical writers about our organization’s plan for participation in `Google Season of Docs 2022 (GSoD)`. Any and all technical writers are welcome to come participate with us for GSoD 2022 season, regardless of tech background or years of experience! At AsyncAPI, we love mentoring folks who want to get involved in OSS, tech, and Docs. ❀️ @@ -89,18 +91,6 @@ We have set aside 2 mentors for now, for our 2 projects: improving our IA and re ___ ## Get started contributing to AsyncAPI Docs Today -Last but not least, don't forget that 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/8). -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! - -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) πŸ™. - +Last but not least, don't forget that _-A.Q. πŸ‘©πŸ»β€πŸ’» and Canela πŸ•β€πŸ¦Ί_ \ No newline at end of file diff --git a/markdown/docs/community/index.md b/markdown/docs/community/index.md index 57d4906396b2..5a4f879ea0ef 100644 --- a/markdown/docs/community/index.md +++ b/markdown/docs/community/index.md @@ -3,6 +3,8 @@ title: Overview weight: 2 --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Community: Guidelines and resources around community. Welcome to AsyncAPI **Community**! Our Community section documents the community guidelines and resources. @@ -10,16 +12,6 @@ Welcome to AsyncAPI **Community**! Our Community section documents the community ## Contribute to the AsyncAPI Community section -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) πŸ™. diff --git a/markdown/docs/concepts/asyncapi-document/adding-bindings.md b/markdown/docs/concepts/asyncapi-document/adding-bindings.md index 7380fc5c30a3..cd86c3de62db 100644 --- a/markdown/docs/concepts/asyncapi-document/adding-bindings.md +++ b/markdown/docs/concepts/asyncapi-document/adding-bindings.md @@ -3,7 +3,7 @@ title: Adding bindings weight: 260 --- -import BindingsOverview from '../../../../assets/docs/fragments/bindings-overview.md' +import BindingsOverview from '@/assets/docs/fragments/bindings-overview.md' diff --git a/markdown/docs/concepts/index.md b/markdown/docs/concepts/index.md index 4e028aaf5979..34e581fea077 100644 --- a/markdown/docs/concepts/index.md +++ b/markdown/docs/concepts/index.md @@ -3,6 +3,8 @@ title: 'Overview' weight: 1 --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Concepts: Define AsyncAPI features and capabilities Welcome to AsyncAPI **Concepts**! Our Concepts section will define the concepts of AsyncAPI features and capabilities. @@ -10,16 +12,6 @@ Welcome to AsyncAPI **Concepts**! Our Concepts section will define the concepts ## Contribute to AsyncAPI Concepts -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) πŸ™. diff --git a/markdown/docs/guides/index.md b/markdown/docs/guides/index.md index 048819267e49..99118858318e 100644 --- a/markdown/docs/guides/index.md +++ b/markdown/docs/guides/index.md @@ -3,6 +3,8 @@ title: 'Overview' weight: 1 --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Guides: Teaches AsyncAPI's capabilities at a high level Welcome to AsyncAPI **Guides**! Our Guides section teaches AsyncAPI's capabilities and features at a high level. @@ -10,16 +12,6 @@ Welcome to AsyncAPI **Guides**! Our Guides section teaches AsyncAPI's capabiliti ## Contribute to AsyncAPI Guides -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) πŸ™. diff --git a/markdown/docs/reference/bindings/index.md b/markdown/docs/reference/bindings/index.md index 314c533f0ae4..83eb7ddd2849 100644 --- a/markdown/docs/reference/bindings/index.md +++ b/markdown/docs/reference/bindings/index.md @@ -5,7 +5,7 @@ weight: 15 ## Overview -import BindingsOverview from '../../../../assets/docs/fragments/bindings-overview.md' +import BindingsOverview from '@/assets/docs/fragments/bindings-overview.md' diff --git a/markdown/docs/reference/index.md b/markdown/docs/reference/index.md index 540daa008aaa..b08034a917e9 100644 --- a/markdown/docs/reference/index.md +++ b/markdown/docs/reference/index.md @@ -3,6 +3,8 @@ title: Overview weight: 2 --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Reference: AsyncAPI Specification Welcome to AsyncAPI **Reference**! Our Reference section documents the AsyncAPI specification. @@ -10,16 +12,6 @@ Welcome to AsyncAPI **Reference**! Our Reference section documents the AsyncAPI ## Contribute to the AsyncAPI Reference section -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) πŸ™. diff --git a/markdown/docs/tools/index.md b/markdown/docs/tools/index.md index 2b68891ec2a3..17d8ff47a34f 100644 --- a/markdown/docs/tools/index.md +++ b/markdown/docs/tools/index.md @@ -3,6 +3,8 @@ title: 'Overview' weight: 0 --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Tools: the AsyncAPI tools ecosystem Welcome to AsyncAPI **Tools**! Our Tools section documents the AsyncAPI tools ecosystem. @@ -10,21 +12,8 @@ Welcome to AsyncAPI **Tools**! Our Tools section documents the AsyncAPI tools ec ## Contribute to AsyncAPI Tools + -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) πŸ™. ___ diff --git a/markdown/docs/tutorials/generate-code.md b/markdown/docs/tutorials/generate-code.md index c57d46a25e92..78e29ebb41ed 100644 --- a/markdown/docs/tutorials/generate-code.md +++ b/markdown/docs/tutorials/generate-code.md @@ -29,7 +29,7 @@ It is important to have [Node.js](https://nodejs.org/en/download/) installed whi -import CliInstallation from '../../../assets/docs/fragments/cli-installation.md' +import CliInstallation from '@/assets/docs/fragments/cli-installation.md' diff --git a/markdown/docs/tutorials/index.md b/markdown/docs/tutorials/index.md index 61fffa3c502c..eee0219108b3 100644 --- a/markdown/docs/tutorials/index.md +++ b/markdown/docs/tutorials/index.md @@ -3,6 +3,8 @@ title: Overview weight: 2 --- +import ContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; + ## Tutorials: Learn how AsyncAPI works Welcome to AsyncAPI **Tutorials**! Our Tutorials section teaches beginner processes with AsyncAPI by doing. @@ -11,16 +13,6 @@ Welcome to AsyncAPI **Tutorials**! Our Tutorials section teaches beginner proces ## Contribute to AsyncAPI Tutorials -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) πŸ™.