AsyncAPI Docs Report - July 2023

Overview

In July 2023, our AsyncAPI documentation continued to flourish, with a total of 7,443 sessions and 3,895 unique users recorded. Engagement this month also included 2,345 new users, further underlining the thriving growth of our docs community.

With the successful continuation of the 2023 Google Season of Docs and the Technical Writing Mentorship Program, our documentation contributors have made significant strides in understanding the intricacies of the new Spec 3 and its enhanced features.

2023 Google Season of Docs

During July, remarkable progress was achieved on documenting the AsyncAPI document structure. Assigned to our diligent Google Season of Docs (GSoD) writers, most sections have already undergone their second draft, and these dedicated writers are actively engaging with core spec contributors to clarify any queries.

Simultaneously, the create 100-level interactive learning path has been advancing steadily. The setup of a dedicated AsyncAPI GitHub repository to host with Killercoda, 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.

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.

Join OPEN Spec 3.0 Docs Meetings

Calling out to all members of the AsyncAPI community! Our efforts to bolster Spec 3.0 documentation continues with a series of community meetings. These biweekly gatherings, scheduled for Thursdays at 14:30 UTC, provide an open forum for enthusiastic contributors and inquisitive minds.

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.

July 6th 2023 (Spec 3.0 Docs Meeting)

July 20th 2023 (Spec 3.0 Docs Meeting)

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.

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.

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 and our Code of Conduct.
2. Head over to our AsyncAPI Docs Board.
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 via my GitHub handle, quetzalliwrites 🐙.

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.✨