Welcome to another update from the AsyncAPI Initiative. In this article, I want to highlight the most important items contributed to AsyncAPI during the first few months of 2022.
I usually ask the community if folks have anything important that I should put in my updates. Still, this is a pretty subjective article because it's based mainly on things I see in my personal bubble. 😃
Brand Refresh
This one is pretty easy to spot, especially if you have been with AsyncAPI Initiative for some time. 😃
On March 10, we announced a change to the AsyncAPI brand. Change that was needed. A refresh of this faded green that I personally never liked. 😂
It was a massive effort led by Missy Turco. Months of work, research, and discussions with the community.
It is not all. More work in the area is needed:
- Design System 💪 - Get involved in the related design system repository if you are interested in helping out.
- AsyncAPI Mascots refresh - We need to refresh our existing Eve and Chan mascots to match the new brand. Any help would be appreciated.
For more regular news and updates on topics around brand and design in AsyncAPI Initiative, I definitely recommend you follow Missy Turco and read her regular design updates.
AsyncAPI Conference
We want to organize our first hybrid conference, one you can watch online and participate in person. May is right behind the corner, so not much time is left. We need to start working actively on the event now.
We discuss all aspects of our upcoming conference in our Community Discussion for 2022 Conference Organization openly. Please join and actively support the effort. We need lots of volunteers to make this happen.
We need to have a special task force that will focus on the subject. Please join the discussion on hosting a conference-dedicated weekly meeting.
Meetings scheduling automation and related changes
Because of the community's growth and the growing number of topic-specific meetings, we had to spend some time improving things and automating as much as possible. After some initial discussions, such as this discussion about Google-services, some initial requirements were defined, called Meeting as a Service.
- A week ago, we stopped using our
asyncapi-users
Google Group. We removed it, and all the members were migrated as subscribers to the AsyncAPI Newsletter. This newsletter is the new place where we'll send email notifications every Monday morning with a list of upcoming meetings. - We switched to the new Google Calendar instance managed by the official AsyncAPI Google account. You should remove/unsubscribe from the old calendar and subscribe to the new calendar,
- Our Technical Steering Committee (TSC) approved to sponsor 8 Zoom licenses to host official AsyncAPI meetings. So far, only 3 licenses have been assigned. We have lots of room for more meetings and hosts, if there is a need.
Huge thanks to Krishna Kumar and Shreyansh Jain, who helped research the implementation. ❤️
If you want to learn more about becoming a meeting host, or something else related to meetings, get familiar with our dedicated meetings FAQ.
Oh, and I almost forgot, look at this. 👇 ⭐️ All info about AsyncAPI-related meetings is in one beautiful place! ❤️
Upcoming 2.4 and 3.0 releases of the spec
We released a new 2.4.0 version of AsyncAPI Specification. There are many good features, like the possibility to provide a unique Message id
for the entire AsyncAPI file or the ability to specify that security is valid only for a given operation. You definitely need to read therelease notes.
Huge shout out to Sergio Moya, who was a release coordinator for the 2.4.0 release and pushed all the doors to make sure the release could go out.
2.4.0 was released, but this doesn't block us from working on something much bigger, 3.0.0 version of the specification! 🚀
If you haven't heard about 3.0.0 yet, I highly recommend you have a look at the 3.0.0 release article written by Harsh Mishra.
Please join these efforts, as there is much work ahead of us, but not many hands doing actual work. We meet every two weeks to sync the work efforts and discuss important topics. Feel free to join 🙏
I also recommend following Sergio Moya and reaching for his regular updates on specification-related efforts
Contributors onboarding initiatives
One of the goals for our 2022 community-building efforts was to involve AsyncAPI Initiative as a mentoring organization in as many coding (but not only) events as possible. We have many maintainers here who like to help first-time contributors land their first pull requests in an open and relaxed environment.
Google Summer of Code
We did not start well. We were not accepted for Google Summer of Code. Don't ask me why. I really do not know. I wish I could have a clear answer from them about what failed on my end, where I made mistakes in our application. 😢
We never give up here at AsyncAPI, though. 😃
OpenForce
March was a month where we joined OpenForce thanks to amazing support from Hargun Kaur. As a result, we managed to onboard a few new folks and gained important contributions in exchange. There are a few PRs still open, but here are some of the completed PRs:
- Namya LG introduced a great improvement to our CI by creating dedicated CI workflows that search for broken links in our documentation across all repositories.
- Harsh Mishra introduced a CI workflow that validates docker images in projects where we publish them.
- Abhijeet Jejurkar improved the Kubernetes deployment for our
server-api
service. - Samriddhi contributed a new
/bundle
endpoint to ourserver-api
service. - Ritik Rawal contributed a new
/diff
endpoint to ourserver-api
service. - Everly Precia Suresh added a possibility to host API reference docs for our
server-api
service through a dedicated endpoint.
It is also super important to mention Abir Pal, who helped to coordinate efforts and was the first point of contact for the community coming from OpenForce channels.
Google Season of Docs
Success with OpenForce was followed by the unexpected announcement that AsyncAPI was accepted as an organization for Google Season of Docs (GSoD) 2022, with a $10k budget. 💪
An amazing success for Alejandra Quetzalli and an excellent opportunity for the AsyncAPI Initiative to improve its documentation big time! On May 16, we will announce the names of six interns we want to hire to work on two different projects to have better docs. Alejandra leads a super challenging task to interview as many candidates as possible (around 150!). Keep your fingers crossed.
Alejandra and I will be mentors for our GSoD interns in the following months. Stay tuned to watch the progress.
AsyncAPI Mentorship
We did not want to give up even though the Google Summer of Code (GSoC) 2022 application was declined. We knew many community members joined and started contributing because they counted on AsyncAPI being part of GSoC.
Well tl;dr, our TSC just accepted an idea to start our own AsyncAPI Mentorship program! 🚀
Now we have until May 15 to discuss with mentors your mentorship ideas, understand the scope of each idea, and state clearly for which idea you are a candidate. Then we will ask TSC to vote and select 10 ideas that the AsyncAPI Initiative should sponsor this year.
AsyncAPI Training
ICYMI, we run an effort to create official AsyncAPI training videos. Barbaño González leads this topic and almost finished training scripts and storyboards for the first set of videos.
I do not think it is a secret to say that great content is created only with great input, feedback, and review from people waiting for it. Please join Barbaño's efforts with any help you can, as she is not doing it for herself but the community.
I recommend you follow Barbaño's monthly updates, especially if you want to participate.
Docs Feedback Form
One of our missions is to have kick-ass documentation. Easy, right?
Writing docs is easy, just like writing code (at least in my opinion 😜). Well, we all know the devil is hidden in details. Details like gathering requirements, figuring out architecture, and making sure you have a well-motivated group of people working on it. And last but not least, make sure the community can easily share feedback on your work transparently.
I wrote already about Alejandra Quetzalli and the efforts to get AsyncAPI into GSoD. Getting a well-motivated group of people to work on docs, checked. ✅
Our new docs information architecture is almost here too. I think we can say "checked" ✅ to this one too.
Since this week, we can also say "checked" ✅ to the idea of getting docs feedback from the community.
Each documentation page has a dedicated feedback form that one can fill in anonymously. The form injects the feedback into a docs-related GitHub Discussion like this example.
Huge applause to:
- Alejandra Quetzalli for leading the change
- Missy Turco for amazing support with design
- Maciej Urbanczyk for detailed review
- Akshat Nema for implementation. Akshat demonstrated a lot of patience here. As an individual contributor, he waited for the merge for quite some time. There was a long discussion, many parties involved. Many contributors lost interest in such long-running PRs. Not Akshat! 💪
Anyway, I recommend you follow Alejandra and her regular docs-related updates.
Photo by Mitchell Luo on Unsplash