As a core OSS contributor for AsyncAPI Docs, I (Alejandra Quetzalli) volunteer to write periodic updates about the AsyncAPI Docs ecosystem. The goal is to let the community know what's going on in the Docs area and how the Docs area has been collaborating with other areas within the AsyncAPI Initiative.
During Q1 2023, AsyncAPI Docs had 26,875 sessions and 13,506 unique users.
/docs: 26,875 sessions overall with 13,506 unique users./docs/concepts: 2,316 sessions with 1,308 unique users./docs/tutorials: 7,719 sessions with 4,679 unique users./docs/tools: 2,955 sessions with 239 unique users./docs/guides: 360 sessions with 6,011 unique users./docs/reference: 10,807 sessions with 6,011 unique users.
AsyncAPI was accepted into Google Season of Docs 2023 for two projects: documenting the AsyncAPI document in detail and creating interactive learning paths. We received a total budget of $10,350 .
- $5,000 for documenting the AsyncAPI document section details
- $5,000 for creating interactive learning paths
- $350 for participant swag+shipping costs
Alejandra Quetzalli is currently accepting applications for technical writers who want to participate in GSoD 2023 at AsyncAPI. The deadline for applications is April 15. Interested participants must complete this AsyncAPI GSoD 2023 written application available in a public Google form. We have received six applications to date.
If selected, the next step in the process for candidates will be to receive a direct follow-up message (DM) on AsyncAPI Slack and an email from Alejandra to schedule their interview.
The AsyncAPI Docs Style Guide has been created as an epic issue in our docs repository, broken into individual tasks:
- About this guide
- Accessibility
- Code examples
- Content buckets explanation
- Docs contribution guidelines
- Inclusive language
- Voice & Tone
- Grammar
- Numbers
- Punctuation
- Formatting
- Internalization (i18n) & Localization
- Links
- SEO
- Styling
- Version control
- Glossary
We did not pitch the style guide project for Google Season of Docs 2023 because creating a style guide does not require any knowledge of event-driven architecture (EDA). A style guide can be a good first issue to assign to new contributors unfamiliar with EDAs. By assigning them such tasks, we can help them learn about the basics of AsyncAPI and gradually move on to more complex documentation projects.
We are pleased to report that three new docs contributors are already working on the AsyncAPI Docs Style Guide. We are thrilled to have new contributors working with us to help ensure consistency and clarity across all documentation.
AsyncAPI community members, including Jonas Lagoni, have begun planning documentation updates for the upcoming Spec 3.0 release in June. We are looking for contributors to assist with the documentation efforts. A meeting point has also been established for documentation in our community spec meetings until the release is live and the docs are ready.
Overall, Q1 2023 saw many sessions and unique users visiting the new AsyncAPI Docs after their information architecture makeover from the GSoD 2022 program. For the second time, we were accepted into Google Season of Docs 2023 for two projects that will help improve the quality of our documentation and provide valuable opportunities for contributors to develop new skills. We have also begun planning documentation updates for the upcoming Spec 3.0 release and started work on our first style guide, which will ensure that our documentation remains consistent and relevant.
Creating our first AsyncAPI Docs style guide is a major milestone because it will help ensure consistency and clarity across all documentation moving forward. With three new contributors working on the Style Guide and six applications already submitted for GSoD 2023 technical writing positions, the future of our docs community keeps looking bright!
