From 0e501fd71bad978075471a8e00bf5f2449f97d73 Mon Sep 17 00:00:00 2001 From: Antonio Date: Fri, 4 Oct 2024 21:25:03 +0300 Subject: [PATCH] docs: move fragments to assets/docs directory. Update paths of existing fragments --- .../docs/fragments/contribution-notes.md | 0 assets/docs/fragments/how-to-contribute.md | 4 ++-- .../docs/fragments/talk-to-me.md | 0 markdown/blog/2023-April-docs-report.md | 4 ++-- markdown/blog/2023-Q1-docs-report.md | 4 ++-- markdown/blog/2023-Q4-docs-report.md | 4 ++-- markdown/blog/2023-july-docs-report.md | 4 ++-- markdown/blog/2023-june-docs-report.md | 4 ++-- markdown/blog/2023-may-docs-report.md | 4 ++-- markdown/blog/changes-coming-docs.md | 4 ++-- markdown/blog/google-season-of-docs-2022.md | 2 +- markdown/docs/community/index.md | 2 +- .../concepts/asyncapi-document/adding-bindings.md | 6 +++--- markdown/docs/concepts/index.md | 2 +- markdown/docs/guides/index.md | 2 +- markdown/docs/reference/bindings/index.md | 2 +- markdown/docs/reference/index.md | 2 +- markdown/docs/tools/index.md | 2 +- markdown/docs/tutorials/generate-code.md | 14 +++++++------- markdown/docs/tutorials/index.md | 2 +- 20 files changed, 34 insertions(+), 34 deletions(-) rename markdown/fragments/docContributionNotes.mdx => assets/docs/fragments/contribution-notes.md (100%) rename markdown/fragments/talkToMe.mdx => assets/docs/fragments/talk-to-me.md (100%) diff --git a/markdown/fragments/docContributionNotes.mdx b/assets/docs/fragments/contribution-notes.md similarity index 100% rename from markdown/fragments/docContributionNotes.mdx rename to assets/docs/fragments/contribution-notes.md diff --git a/assets/docs/fragments/how-to-contribute.md b/assets/docs/fragments/how-to-contribute.md index 3d9661fa754..e5e9ea567b3 100644 --- a/assets/docs/fragments/how-to-contribute.md +++ b/assets/docs/fragments/how-to-contribute.md @@ -1,5 +1,5 @@ -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; ## How to contribute to AsyncAPI Docs diff --git a/markdown/fragments/talkToMe.mdx b/assets/docs/fragments/talk-to-me.md similarity index 100% rename from markdown/fragments/talkToMe.mdx rename to assets/docs/fragments/talk-to-me.md diff --git a/markdown/blog/2023-April-docs-report.md b/markdown/blog/2023-April-docs-report.md index 355973d1331..5342d7b7b38 100644 --- a/markdown/blog/2023-April-docs-report.md +++ b/markdown/blog/2023-April-docs-report.md @@ -13,8 +13,8 @@ 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 DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes 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. diff --git a/markdown/blog/2023-Q1-docs-report.md b/markdown/blog/2023-Q1-docs-report.md index 4c058ecc342..5301be51fc9 100644 --- a/markdown/blog/2023-Q1-docs-report.md +++ b/markdown/blog/2023-Q1-docs-report.md @@ -14,8 +14,8 @@ 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 DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; # AsyncAPI Documentation Report - Q1 2023 diff --git a/markdown/blog/2023-Q4-docs-report.md b/markdown/blog/2023-Q4-docs-report.md index 4b5fa458214..f38733c5f9a 100644 --- a/markdown/blog/2023-Q4-docs-report.md +++ b/markdown/blog/2023-Q4-docs-report.md @@ -14,8 +14,8 @@ authors: excerpt: In Q4, AsyncAPI docs had primary engagement across the tutorials and reference content buckets. --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes 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. diff --git a/markdown/blog/2023-july-docs-report.md b/markdown/blog/2023-july-docs-report.md index abe9ce29282..37d308c4307 100644 --- a/markdown/blog/2023-july-docs-report.md +++ b/markdown/blog/2023-july-docs-report.md @@ -13,8 +13,8 @@ authors: byline: In July 2023, the AsyncAPI documentation had 7,443 sessions and 3,895 unique users, including 2,345 new users. --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; # AsyncAPI Docs Report - July 2023 diff --git a/markdown/blog/2023-june-docs-report.md b/markdown/blog/2023-june-docs-report.md index 8289c7845be..4d68e256acb 100644 --- a/markdown/blog/2023-june-docs-report.md +++ b/markdown/blog/2023-june-docs-report.md @@ -13,8 +13,8 @@ authors: byline: In June 2023, the AsyncAPI documentation had 7,827 sessions and 4,203 unique users, including 2,566 new users. --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes 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. diff --git a/markdown/blog/2023-may-docs-report.md b/markdown/blog/2023-may-docs-report.md index 0f56e3a223e..e691e6da579 100644 --- a/markdown/blog/2023-may-docs-report.md +++ b/markdown/blog/2023-may-docs-report.md @@ -13,8 +13,8 @@ authors: byline: In May 2023, the AsyncAPI documentation had 9,453 sessions and 4,876 unique users, including 2,895 new users. --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes 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! diff --git a/markdown/blog/changes-coming-docs.md b/markdown/blog/changes-coming-docs.md index 6354774370b..9192e8d1b8c 100644 --- a/markdown/blog/changes-coming-docs.md +++ b/markdown/blog/changes-coming-docs.md @@ -14,8 +14,8 @@ 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 DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; -import TalkToMe from '@/markdown/fragments/talkToMe.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; +import TalkToMe from '@/assets/docs/fragments/talk-to-me.md'; ## 🦄 Hola, soy Alejandra Quetzalli diff --git a/markdown/blog/google-season-of-docs-2022.md b/markdown/blog/google-season-of-docs-2022.md index 4c373da5623..fe61498f1d5 100644 --- a/markdown/blog/google-season-of-docs-2022.md +++ b/markdown/blog/google-season-of-docs-2022.md @@ -14,7 +14,7 @@ authors: excerpt: Check out the Docs project proposal we're submitting to GSoD 2022! You won't want to miss out. --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes 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. ❤️ diff --git a/markdown/docs/community/index.md b/markdown/docs/community/index.md index bbed04e387e..7aab8e91a4b 100644 --- a/markdown/docs/community/index.md +++ b/markdown/docs/community/index.md @@ -3,7 +3,7 @@ title: Overview weight: 2 --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; ## Community: Guidelines and resources around community. diff --git a/markdown/docs/concepts/asyncapi-document/adding-bindings.md b/markdown/docs/concepts/asyncapi-document/adding-bindings.md index 7380fc5c30a..ea2f476bb56 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' @@ -29,7 +29,7 @@ style I fill:#47BCEE,stroke:#47BCEE; ## Server bindings -Server bindings provide protocol-specific information related to the server configuration. For example, if you use Pulsar as your message broker, you can specify the tenant name in the server bindings. +Server bindings provide protocol-specific information related to the server configuration. For example, if you use Pulsar as your message broker, you can specify the tenant name in the server bindings. Here is a diagram explaining server bindings: @@ -94,7 +94,7 @@ The previous document shows how to configure channel bindings for a Kafka topic- ## Message bindings -Message bindings provide protocol-specific information for a specific message. For example, for the AMQP protocol, you can specify the message type in a protocol-specific notation. +Message bindings provide protocol-specific information for a specific message. For example, for the AMQP protocol, you can specify the message type in a protocol-specific notation. Here is a diagram explaining where message bindings fit into the AsyncAPI document structure: diff --git a/markdown/docs/concepts/index.md b/markdown/docs/concepts/index.md index 479a0c52e2c..cff0248b951 100644 --- a/markdown/docs/concepts/index.md +++ b/markdown/docs/concepts/index.md @@ -3,7 +3,7 @@ title: 'Overview' weight: 1 --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; ## Concepts: Define AsyncAPI features and capabilities diff --git a/markdown/docs/guides/index.md b/markdown/docs/guides/index.md index 655c6ef14ad..5667c954d25 100644 --- a/markdown/docs/guides/index.md +++ b/markdown/docs/guides/index.md @@ -3,7 +3,7 @@ title: 'Overview' weight: 1 --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; ## Guides: Teaches AsyncAPI's capabilities at a high level diff --git a/markdown/docs/reference/bindings/index.md b/markdown/docs/reference/bindings/index.md index 314c533f0ae..83eb7ddd284 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 f32e9339f6e..f508f783621 100644 --- a/markdown/docs/reference/index.md +++ b/markdown/docs/reference/index.md @@ -3,7 +3,7 @@ title: Overview weight: 2 --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; ## Reference: AsyncAPI Specification diff --git a/markdown/docs/tools/index.md b/markdown/docs/tools/index.md index 447ec3d8ba7..f902356b45e 100644 --- a/markdown/docs/tools/index.md +++ b/markdown/docs/tools/index.md @@ -3,7 +3,7 @@ title: 'Overview' weight: 0 --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; ## Tools: the AsyncAPI tools ecosystem diff --git a/markdown/docs/tutorials/generate-code.md b/markdown/docs/tutorials/generate-code.md index c57d46a25e9..023192d7ff9 100644 --- a/markdown/docs/tutorials/generate-code.md +++ b/markdown/docs/tutorials/generate-code.md @@ -1,5 +1,5 @@ --- -title: Generate code +title: Generate code description: In this tutorial, you'll learn how to generate code from your AsyncAPI document. weight: 100 --- @@ -17,7 +17,7 @@ In the previous tutorial, you created an AsyncAPI document that is used in this -If you did not follow the previous tutorial and do not have an `asyncapi.yaml` file for overview, then generate one by running the following command using the AsyncAPI CLI: +If you did not follow the previous tutorial and do not have an `asyncapi.yaml` file for overview, then generate one by running the following command using the AsyncAPI CLI: `asyncapi new --example=tutorial.yml --no-tty`. @@ -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' @@ -41,9 +41,9 @@ import CliInstallation from '../../../assets/docs/fragments/cli-installation.md' Let's break down the previous command: - - `asyncapi new glee` is how you use Glee via the AsyncAPI CLI. - - `--name=tutorial` is how you tell the AsyncAPI CLI to name your new Glee project. - - `--template=tutorial` is how you tell the AsyncAPI CLI to use the template of a Glee project that was created specifically for this tutorial. + - `asyncapi new glee` is how you use Glee via the AsyncAPI CLI. + - `--name=tutorial` is how you tell the AsyncAPI CLI to name your new Glee project. + - `--template=tutorial` is how you tell the AsyncAPI CLI to use the template of a Glee project that was created specifically for this tutorial. 2. List all files in the directory and confirm your Glee project creation: @@ -89,7 +89,7 @@ import CliInstallation from '../../../assets/docs/fragments/cli-installation.md' Streetlight with id "1" updated its lighting information to 3 lumens at 2017-06-07T12:34:32.000Z.`} ## Summary -In this tutorial, you learned how to create a Glee project from the [Streetlights API specification document created in a previous tutorial](https://asyncapi.com/docs/tutorials/create-asyncapi-document). +In this tutorial, you learned how to create a Glee project from the [Streetlights API specification document created in a previous tutorial](https://asyncapi.com/docs/tutorials/create-asyncapi-document). Additionally, you've learned how to run your code by installing the project's dependencies and sending several test messages to the Streelights application using the MQTT client. diff --git a/markdown/docs/tutorials/index.md b/markdown/docs/tutorials/index.md index 3171fde68b2..2a6da426bb4 100644 --- a/markdown/docs/tutorials/index.md +++ b/markdown/docs/tutorials/index.md @@ -3,7 +3,7 @@ title: Overview weight: 2 --- -import DocContributionNotes from '@/markdown/fragments/docContributionNotes.mdx'; +import DocContributionNotes from '@/assets/docs/fragments/contribution-notes.md'; ## Tutorials: Learn how AsyncAPI works