Skip to content

Instantly share code, notes, and snippets.

@alequetzalli
Last active April 22, 2022 19:14
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save alequetzalli/8f449f731b919193f4101098a69da14d to your computer and use it in GitHub Desktop.
Save alequetzalli/8f449f731b919193f4101098a69da14d to your computer and use it in GitHub Desktop.

πŸ“„ AsyncAPI Docs update (28 Feb - 11 March 2022)

As an Open-Source (OSS) contributor, I volunteer to write periodic updates about the AsyncAPI Docs ecosystem every 2 weeks.

πŸ¦„ This is Ale's personal summary

I want to note that this is not an official AsyncAPI Initiative update, but a personal summary I'm volunteering to write up for the OSS community. The goal is to let you know what's going on in the Docs area and how the Docs area has been teaming with other areas within the AsyncAPI Initiative. πŸ˜€πŸ‘πŸ½

πŸ“‘ Google Season of Docs 2022: UPDATE

As some of you may remember from my Gist Docs update of 14 Feb - 25 Feb 2022 and the previous Gist Docs update for 31 Jan - 11 Feb 2022, I noted that GSoD 2022 was coming up and that AsyncAPI wanted to participate in the application process once it opened on February 23, 2022.

As mentioned in those previous Gists, I've already begun our application to GSoD 2022, but keep in mind that it entails a very detailed process with several steps. One of the main components is a specific project proposal template that Google requires all orgs fill out. The close date of the application is March 23rd, so we're good.

You can see what the project proposal looks like so far in my Draft PR here.

Don't forget that we have an AsyncAPI Slack channel named #temp-gsod-2022 that you can join here. This slack channel is a temporary channel to coordinate GSoC 2022 setup. I'll publish regular updates on where we are in the application process, so stay tuned as the applicate date grows closer. πŸ™‚

Join the #temp-gsod-2022 slack channel for:

  • mentees identification
  • mentors identification
  • ideas identification
  • mentees and ideas and mentors matching

✍🏾 What main change is happening within the writing of the Docs?

We're tackling the writing for /website issue #350. Here's that scintillating Draft PR that can be followed for updates: asyncapi/website#601. The goal is to have preview links to help community members better visualize current proposed changes in progress.

This bi-weekly update is more exciting because I get to show you lots of cool changes happening in in this PR! Our changes to the Information Architecture (IA) is really starting to show!

Lukasz tackled re-writing the script that creates the left side navigation in the Docs, because the current functionality didn't allow for children sub-categories.

Screen Shot 2022-03-09 at 10 48 30 AM

Screen Shot 2022-03-09 at 10 03 00 AM

Here are a few screenshots to show you how the AsyncAPI website's main Navigation and Read the Docs CTA button in the Homepage are changing too...

Screen Shot 2022-03-10 at 8 23 05 PM

Screen Shot 2022-03-10 at 8 24 54 PM

🎨 Feature Card: UPDATE

You may also remember from a previous Gist Docs update that Design contributors were teaming with Docs on /websiteissue #453 for the ideation and development of a new feedback card that would be added at the bottom of each Docs page.

What the community decided over the last 2 weeks was that the Submit feedback button in the card will publish the feedback anonymously via the AsyncAPI bot and create a new GitHub Discussion with said feedback:

Screen Shot 2022-03-10 at 8 47 22 PM

Screen Shot 2022-03-10 at 8 48 47 PM

We can see in this PR comment also an update of the functionality so far, or you can simply watch this video:

157867993-e28ec24b-df34-4221-8b6b-154e1ad8bbd1.mp4

❀️ Thanking our Contributors

A BIG thank you πŸ€— to all of our OSS contributors; without you, there would be no OSS initiative! πŸ˜„πŸŽ‰

For this biweekly update Gist, let's give a round of applause to:

πŸ™πŸ½ Contributors Needed

There is always something to do for OSS Docs, and it's no different for us! πŸ˜„

We could really use contributors for the following Docs issues:

  • Technical Writing for defining server in spec #587
  • Development work for ✨NEW✨ Docs homepage, based on new design components created in #503

That's it for now. See you in 2 weeks! -A.Q. πŸ‘©πŸ»β€πŸ’» y Canela πŸ•β€πŸ¦Ί

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment