From 6e7f58bafbce1f62218454709e3f60c251712588 Mon Sep 17 00:00:00 2001 From: Antonio Date: Fri, 4 Oct 2024 00:42:18 +0300 Subject: [PATCH] docs: add missing excerpts to hide imports --- markdown/blog/2023-April-docs-report.md | 8 ++++---- markdown/blog/2023-july-docs-report.md | 22 +++++++++++----------- markdown/blog/2023-june-docs-report.md | 18 +++++++++--------- markdown/blog/2023-may-docs-report.md | 8 ++++---- 4 files changed, 28 insertions(+), 28 deletions(-) diff --git a/markdown/blog/2023-April-docs-report.md b/markdown/blog/2023-April-docs-report.md index d57467c0469..9f58b2ea250 100644 --- a/markdown/blog/2023-April-docs-report.md +++ b/markdown/blog/2023-April-docs-report.md @@ -10,7 +10,7 @@ authors: - name: Alejandra Quetzalli photo: /img/avatars/canela-ale.webp link: https://www.linkedin.com/in/alejandra-quetzalli/ - byline: In April 2023, the AsyncAPI documentation experienced significant growth with 8,889 sessions and 4,575 unique users, including 2,895 new users. +excerpt: In April 2023, the AsyncAPI documentation experienced significant growth with 8,889 sessions and 4,575 unique users, including 2,895 new users. --- # AsyncAPI Docs Report - April 2023 @@ -23,7 +23,7 @@ We are thrilled to introduce this year's selected technical writing candidates f Alejandra Quetzalli has chosen four outstanding candidates to collaborate with us for GSoD this year: [Mahfuza](https://github.com/mhmohona), [Bhaswati](https://github.com/BhaswatiRoy), [Rohit](https://github.com/TRohit20), and [Hridyesh](https://github.com/kakabisht). ### Overview of the LIVE Writing/Editing Interviews -During the LIVE interview session, Alejandra divided the exercises into two parts: writing and editing. Candidates were given a document and asked to identify issues and potential solutions, then rewrite or edit the document as needed. Some candidates faced challenges with staying focused on writing, while others struggled to generate ideas due to nerves or the live format of the exercise. A few candidates had difficulty spotting errors and completing the editing task. +During the LIVE interview session, Alejandra divided the exercises into two parts: writing and editing. Candidates were given a document and asked to identify issues and potential solutions, then rewrite or edit the document as needed. Some candidates faced challenges with staying focused on writing, while others struggled to generate ideas due to nerves or the live format of the exercise. A few candidates had difficulty spotting errors and completing the editing task. However, Alejandra did not disqualify candidates who experienced nerves, writer's block, or had limited editing skills. Instead, she guided them with questions and suggestions, encouraging them to search for answers online during the call. The main objective was to evaluate the candidates' problem-solving skills, ability to accept feedback, and integrate suggestions for improvement. The following sections outline the writing and editing exercises and the selection criteria for the candidates. @@ -78,7 +78,7 @@ graph TD style A fill:#FF6EC7,stroke:#000000,stroke-width:2px; style B fill:#B5EAD7,stroke:#000000,stroke-width:2px; style C fill:#DAD0FF,stroke:#000000,stroke-width:2px; -style D fill:#FDD6C1,stroke:#000000,stroke-width:2px; +style D fill:#FDD6C1,stroke:#000000,stroke-width:2px; style E fill:#C7CEEA,stroke:#000000,stroke-width:2px; style F fill:#C7CEEA,stroke:#000000,stroke-width:2px; style BA fill:#C1F9F7,stroke:#000000,stroke-width:2px; @@ -114,7 +114,7 @@ Did you know that you can contribute Docs to AsyncAPI as well? Code isn't the on 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. +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 diff --git a/markdown/blog/2023-july-docs-report.md b/markdown/blog/2023-july-docs-report.md index 34b0fb11228..1db67c75b1f 100644 --- a/markdown/blog/2023-july-docs-report.md +++ b/markdown/blog/2023-july-docs-report.md @@ -10,8 +10,8 @@ authors: - name: Alejandra Quetzalli 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. ---- +excerpt: In July 2023, the AsyncAPI documentation had 7,443 sessions and 3,895 unique users, including 2,345 new users. +--- # AsyncAPI Docs Report - July 2023 @@ -25,8 +25,8 @@ During July, remarkable progress was achieved on [documenting the AsyncAPI docum Simultaneously, the [create 100-level interactive learning path](https://github.com/asyncapi/website/issues/1520) has been advancing steadily. The [setup of a dedicated AsyncAPI GitHub repository to host with Killercoda](https://github.com/asyncapi/website/issues/1522), marks a significant step towards hosting our interactive learning paths. To ensure inclusivity, the topics to be covered in our 100-level learning path will also be determined through a forthcoming community vote. -## 2023 AsyncAPI Mentorship Program — `Technical Writing` -Technical writers participating in the 2023 AsyncAPI Mentorship Program are actively engaged in community building, opening a [community vote that successfully identified Kafka and Websocket as the prioritized protocols for this year's scope of work](https://github.com/orgs/asyncapi/discussions/815). +## 2023 AsyncAPI Mentorship Program — `Technical Writing` +Technical writers participating in the 2023 AsyncAPI Mentorship Program are actively engaged in community building, opening a [community vote that successfully identified Kafka and Websocket as the prioritized protocols for this year's scope of work](https://github.com/orgs/asyncapi/discussions/815). Diving into detailed research and interactions with diverse community members, our [writers are also researching meticulously the most common AsyncAPI processes/tasks associated with Kafka and Websocket](https://github.com/orgs/asyncapi/discussions/814). @@ -36,7 +36,7 @@ Calling out to all members of the AsyncAPI community! Our efforts to bolster **S Whether you're passionate about contributing to Spec 3.0 docs or seeking clarifications, these meetings are the conduit to connect and collaborate with the expertise of our spec contributors. A special invitation is extended to the participants of the GSoD and Mentorship Program, ensuring their contributions seamlessly align with the evolution of Spec 3.0. ### Watch July Spec 3.0 Docs Meetings -For those who missed our July meetings, you can revisit these sessions on the AsyncAPI YouTube channel. +For those who missed our July meetings, you can revisit these sessions on the AsyncAPI YouTube channel. #### July 6th 2023 (Spec 3.0 Docs Meeting) @@ -48,11 +48,11 @@ For those who missed our July meetings, you can revisit these sessions on the As ## AsyncAPI Docs - July Summary In July 2023, the AsyncAPI documentation community experienced steady engagement, with a total of 7,443 sessions and 3,895 unique users. The concurrent progress of the _2023 Google Season of Docs_ and the _Technical Writing Mentorship Program_ highlighted the writers' dedication to understanding the intricacies of the new Spec 3 and its advanced functionalities. -During this period, the Google Season of Docs (GSoD) writers made substantial strides in their assigned projects. Additionally, the "create 100-level interactive learning path" project gained momentum as the writers set up a dedicated GitHub repository for hosting our interactive learning paths with Killercoda. +During this period, the Google Season of Docs (GSoD) writers made substantial strides in their assigned projects. Additionally, the "create 100-level interactive learning path" project gained momentum as the writers set up a dedicated GitHub repository for hosting our interactive learning paths with Killercoda. -The 2023 AsyncAPI Mentorship Program writers delved into meticulous research and community interactions, aiming to comprehensively capture common AsyncAPI processes and tasks associated with our selected protocols. +The 2023 AsyncAPI Mentorship Program writers delved into meticulous research and community interactions, aiming to comprehensively capture common AsyncAPI processes and tasks associated with our selected protocols. -Meanwhile, the OPEN Spec 3.0 Docs Meetings continued to serve as a platform for fostering docs collaboration. With biweekly gatherings scheduled on Thursdays at 14:30 UTC, these meetings provide an opportunity for contributors to engage with expert spec contributors, aligning their contributions seamlessly with the evolution of Spec 3.0. Those who missed the July Spec 3.0 Docs Meetings could easily catch up by accessing the recordings on the AsyncAPI YouTube channel. +Meanwhile, the OPEN Spec 3.0 Docs Meetings continued to serve as a platform for fostering docs collaboration. With biweekly gatherings scheduled on Thursdays at 14:30 UTC, these meetings provide an opportunity for contributors to engage with expert spec contributors, aligning their contributions seamlessly with the evolution of Spec 3.0. Those who missed the July Spec 3.0 Docs Meetings could easily catch up by accessing the recordings on the AsyncAPI YouTube channel. ```mermaid graph LR @@ -60,7 +60,7 @@ graph LR style A fill:#FF6EC7,stroke:#000000,stroke-width:2px; style B fill:#B5EAD7,stroke:#000000,stroke-width:2px; style C fill:#B5EAD7,stroke:#000000,stroke-width:2px; -style D fill:#B5EAD7,stroke:#000000,stroke-width:2px; +style D fill:#B5EAD7,stroke:#000000,stroke-width:2px; style E fill:#E1FEC1,stroke:#000000,stroke-width:2px; style F fill:#E1FEC1,stroke:#000000,stroke-width:2px; style G fill:#E1FEC1,stroke:#000000,stroke-width:2px; @@ -92,9 +92,9 @@ Did you know that you can contribute Docs to AsyncAPI as well? Code isn't the on 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. +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! +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! diff --git a/markdown/blog/2023-june-docs-report.md b/markdown/blog/2023-june-docs-report.md index c15a462c2e5..e6d48e2a11a 100644 --- a/markdown/blog/2023-june-docs-report.md +++ b/markdown/blog/2023-june-docs-report.md @@ -10,11 +10,11 @@ authors: - name: Alejandra Quetzalli photo: /img/avatars/canela-ale.webp link: https://www.linkedin.com/in/alejandra-quetzalli/ - byline: In June 2023, the AsyncAPI documentation had 7,827 sessions and 4,203 unique users, including 2,566 new users. +excerpt: In June 2023, the AsyncAPI documentation had 7,827 sessions and 4,203 unique users, including 2,566 new users. --- # 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. +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. Adding to this excitement was the kick-off of both the _2023 Google Season of Docs_ and _Technical Writing Mentorship Program_ projects, further expanding our bustling docs community. @@ -42,7 +42,7 @@ No worries! You can watch the previous June **Spec 3.0 documentation** community ## AsyncAPI Docs' Hall of Fame - Welcoming Florence Njeri -We're delighted to introduce the ⭐ **AsyncAPI Docs' Hall of Fame** ⭐ to our monthly AsyncAPI Docs reports; a place to feature particularly exceptional and dedicated technical writing maintainers and contributors! +We're delighted to introduce the ⭐ **AsyncAPI Docs' Hall of Fame** ⭐ to our monthly AsyncAPI Docs reports; a place to feature particularly exceptional and dedicated technical writing maintainers and contributors! A hearty congratulations to [Florence Njeri](https://github.com/Florence-Njeri), our inaugural inductee and exceptional docs contributor for June. Florence, an active TSC member, excels in her meticulous maintenance of the [Generator Tool documentation](https://www.asyncapi.com/docs/tools/generator). Her consistent, flawless, and timely contributions have made her an invaluable asset to our community. @@ -70,7 +70,7 @@ graph LR C --> H H --> I H --> J - style A fill:#C1F9F7,stroke:#333,stroke-width:4px + style A fill:#C1F9F7,stroke:#333,stroke-width:4px style B fill:#80c6ff,stroke:#333,stroke-width:2px style C fill:#E1FEC1,stroke:#333,stroke-width:2px style D fill:#FF6EC7,stroke:#333,stroke-width:2px @@ -106,13 +106,13 @@ F --> K[4,203 Unique Users] style A fill:#FF6EC7,stroke:#000000,stroke-width:2px; style B fill:#B5EAD7,stroke:#000000,stroke-width:2px; style C fill:#DAD0FF,stroke:#000000,stroke-width:2px; -style D fill:#FDD6C1,stroke:#000000,stroke-width:2px; +style D fill:#FDD6C1,stroke:#000000,stroke-width:2px; style E fill:#E1FEC1,stroke:#000000,stroke-width:2px; style F fill:#C1F9F7,stroke:#000000,stroke-width:2px; style G fill:#B5EAD7,stroke:#000000,stroke-width:2px; -style H fill:#DAD0FF,stroke:#000000,stroke-width:2px; -style I fill:#FDD6C1,stroke:#000000,stroke-width:2px; +style H fill:#DAD0FF,stroke:#000000,stroke-width:2px; +style I fill:#FDD6C1,stroke:#000000,stroke-width:2px; style J fill:#E1FEC1,stroke:#000000,stroke-width:2px; style K fill:#C1F9F7,stroke:#000000,stroke-width:2px; ``` @@ -125,9 +125,9 @@ Did you know that you can contribute Docs to AsyncAPI as well? Code isn't the on 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. +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! +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! diff --git a/markdown/blog/2023-may-docs-report.md b/markdown/blog/2023-may-docs-report.md index a60248dd406..a4f8bc02e67 100644 --- a/markdown/blog/2023-may-docs-report.md +++ b/markdown/blog/2023-may-docs-report.md @@ -10,14 +10,14 @@ authors: - name: Alejandra Quetzalli photo: /img/avatars/canela-ale.webp link: https://www.linkedin.com/in/alejandra-quetzalli/ - byline: In May 2023, the AsyncAPI documentation had 9,453 sessions and 4,876 unique users, including 2,895 new users. +excerpt: In May 2023, the AsyncAPI documentation had 9,453 sessions and 4,876 unique users, including 2,895 new users. --- # 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! ## Google Season of Docs 2023 (GSoD) at AsyncAPI -We are thrilled to have started working with this year's selected technical writing candidates for the 2023 Google Season of Docs (GSoD) at AsyncAPI: [Mahfuza](https://github.com/mhmohona), [Bhaswati](https://github.com/BhaswatiRoy), [Rohit](https://github.com/TRohit20), and [Hridyesh](https://github.com/kakabisht). This year, all GSoD interns will get the opportunity to work on both GSoD projects: [cover AsyncAPI document sections in detail](https://github.com/asyncapi/website/issues/1507) and [create 100-level interactive learning path](https://github.com/asyncapi/website/issues/1520). +We are thrilled to have started working with this year's selected technical writing candidates for the 2023 Google Season of Docs (GSoD) at AsyncAPI: [Mahfuza](https://github.com/mhmohona), [Bhaswati](https://github.com/BhaswatiRoy), [Rohit](https://github.com/TRohit20), and [Hridyesh](https://github.com/kakabisht). This year, all GSoD interns will get the opportunity to work on both GSoD projects: [cover AsyncAPI document sections in detail](https://github.com/asyncapi/website/issues/1507) and [create 100-level interactive learning path](https://github.com/asyncapi/website/issues/1520). Additionally, our GSoD interns have started a [community vote to select our host platform for AsyncAPI Interactive Learning Paths](https://github.com/orgs/asyncapi/discussions/711). You are cordially invited to participate in the vote and share your thoughts, as your feedback plays a vital role in shaping the future of our interactive learning experience. @@ -51,7 +51,7 @@ graph TD style A fill:#FF6EC7,stroke:#000000,stroke-width:2px; style B fill:#B5EAD7,stroke:#000000,stroke-width:2px; style C fill:#DAD0FF,stroke:#000000,stroke-width:2px; -style D fill:#FDD6C1,stroke:#000000,stroke-width:2px; +style D fill:#FDD6C1,stroke:#000000,stroke-width:2px; style E fill:#C7CEEA,stroke:#000000,stroke-width:2px; style BA fill:#C1F9F7,stroke:#000000,stroke-width:2px; @@ -76,7 +76,7 @@ Did you know that you can contribute Docs to AsyncAPI as well? Code isn't the on 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. +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