Skip to content

Instantly share code, notes, and snippets.

@alequetzalli
Last active April 22, 2022 19:15
Show Gist options
  • Save alequetzalli/b3ee83ea9c29ce3d99f4693bf12ab6f4 to your computer and use it in GitHub Desktop.
Save alequetzalli/b3ee83ea9c29ce3d99f4693bf12ab6f4 to your computer and use it in GitHub Desktop.

πŸ“„ AsyncAPI Docs update (17 Jan - 28 Jan 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. πŸ˜€πŸ‘πŸ½

🎨 What Docs and Design teamed together on

For this time period, Docs got to talk through a lot of cool changes coming up within the DESIGN side of the initiative!

  • /websiteissue #503 update: chatting still w/ @mcturco through the ideation and development of a /new page added to the Docs to be a new homepage for our Docs.
  • /websiteissue #518 update: chatting still w/ @mcturco through the ideation and development of a new diagram to be added to the homepage of the docs.
  • /websiteissue #453 update: chatting still w/ @mcturco through the ideation and development of a new feedback card that would be added at the bottom of each Docs page.

🧐 What kind of Docs PRs did I help edit/review?

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

I'm finally tackling the writing for /websiteissue #350 in Q1 of 2022. I am still working on the rough drafts for adding intro copy to the new tools, tutorials, and concepts landing pages. I'm also doing new intro copy to the Docs for the new Homepage we're adding to the Docs.

Next update I will likely have a Draft PR link that I can append to show progress visually too. My goal is to have preview links to help community members better visualize current proposed changes in place.

🧼 What Docs cleanup items got done?

  • fixing incorrect docs label in issue template: this one was good to take care of because the new Docs issue template had the incorrect label in it! Now that it's fixed, new issues will be tagged correctly with the correct Docs label.

That's it for now. See you in 2 weeks! -A.Q.

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