Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: new docs blog post sharing Q1 Docs Report #1527

Merged
merged 11 commits into from
Apr 13, 2023

Conversation

quetzalliwrites
Copy link
Member

The 2023 Q1 AsyncAPI Docs Report is an overview of the work we have done in the first quarter of this year:

  • The number of sessions and unique users on our docs site.
  • Our participation in the Google Season of Docs program and the progress we've made so far.
  • The creation of the AsyncAPI Docs Style Guide and the individual tasks that are part of it.
  • Spec 3.0 docs updates coming up for June release.
  • The technical writer applications we are currently accepting for GSoD 2023 and interview process.

@quetzalliwrites quetzalliwrites added area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Apr 7, 2023
@quetzalliwrites quetzalliwrites self-assigned this Apr 7, 2023
@netlify
Copy link

netlify bot commented Apr 7, 2023

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4eee559
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/642f8604bb5fbd0008bc7837
😎 Deploy Preview https://deploy-preview-1527--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@quetzalliwrites
Copy link
Member Author

Want to regain momentum with my Docs reports and make them more data driven this year. Since I'm making nicer reports, I will be turning them into blog posts to help give the community even more visibility into Docs progress. ✨

@netlify
Copy link

netlify bot commented Apr 7, 2023

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 508e514
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6437cb5f13ff8c00082d568b
😎 Deploy Preview https://deploy-preview-1527--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Apr 7, 2023

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 54
🟠 Accessibility 88
🟢 Best practices 100
🟢 SEO 100
🔴 PWA 30

Lighthouse ran on https://deploy-preview-1527--asyncapi-website.netlify.app/

tags:
- Documentation
- Communication
cover: /img/posts/gsod-2022/SeasonofDocs_Logo.webp
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accepting ideas/recommendations for best cover photo idea 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my perspective, since the blog covers all aspects of AsyncAPI documentation then the banner should definitely have that Ale's-documentation style vibes. 😊

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw @alequetzalli only 18 applications, weren't you on your 50th interview sometime last year😂🤭

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thulieblack

  1. Yeah, I think I will make one of the mermaid diagrams of this report into the banner image! I think I will pick the diagram that summarizes the quarter work.
  2. Yes, last year I was far too lenient 😄😅... this year I realized that the best way to identify candidates for a writing program is have them take the time to write an application. If candidates don't take the time or passion to write a thorough application then they're not the right candidates for a writing program.😄🔥

@quetzalliwrites
Copy link
Member Author

@thulieblack @derberg @AceTheCreator I would like to prioritize this blog post going out soon this week because I don't want reports to be waiting around before we publish them.

Please take the time to review and address the questions I left in the PR 😄

derberg
derberg previously approved these changes Apr 11, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome initiative!!! @alequetzalli well done

@AceTheCreator
Copy link
Member

Lgtm!!! A well-done job, sensei 🙇🏾‍♂️

quetzalliwrites and others added 2 commits April 11, 2023 16:14
Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com>
@quetzalliwrites
Copy link
Member Author

did i do it right? 😄🧐

the blog post itself works fine: https://deploy-preview-1527--asyncapi-website.netlify.app/blog/2023-q1-docs-report

Copy link
Member

@thulieblack thulieblack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks awesome🤩👌🏿

@quetzalliwrites
Copy link
Member Author

Ok if y'all agree then I look forward to Thulie merging this week 🔥

@thulieblack
Copy link
Member

yo @derberg please approve the PR for merging please😊😊

Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving this PR but tbh, I think it won't get merged after @derberg review. @alequetzalli is the codeowner of the MD files in the repo and since she initialized this PR, Github will ask asyncapi-bot-eve to review the PR. So, quite a confusion on this 🤔.

@akshatnema
Copy link
Member

Exactly, we are now in a position where this PR has to be merged while removing the approval conditions in the repo settings which will be done by @derberg.

My point is should we add @thulieblack as a markdown reviewer for the PRs? cc: @alequetzalli @derberg

@derberg
Copy link
Member

derberg commented Apr 13, 2023

My point is should we add @thulieblack as a markdown reviewer for the PRs? cc: @alequetzalli @derberg

I think yes as Community Manager should be in control of what gets accepted under blog. But this is separate discussion and not a quick fix we should apply here.

I can just temporarily merge with admin rights this single PR, just lemme know if you want to publish this blog today and I can do it

@thulieblack
Copy link
Member

The blog needs to be merged today if possible

@derberg derberg merged commit 71b6a3f into asyncapi:master Apr 13, 2023
@derberg
Copy link
Member

derberg commented Apr 13, 2023

merged

@akshatnema please open separate issue to discuss codeowners file structure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs
Projects
Status: Community PR under Review 🧐
Development

Successfully merging this pull request may close these issues.

5 participants