docs: new style guide - SEO

[quetzalliwrites]

Let's finally get around to creating, designing, and incorporating an AsyncAPI Style Guide!

Why the need?

In tech jobs, we often focus on our technology's technical aspects, such as functionality and performance. However, the documentation for our technology is equally important to the code itself. A style guide ensures consistency and clarity, establishes a consistent voice and tone in your documentation, makes it easier for multiple writers to work together on a single doc, and helps ensure documentation is accurate and up-to-date. When all of your technical writers follow the same guidelines, it's easier for readers to find the information they need and understand how to use your product or OSS technology.

What section of the AsyncAPI Style Guide is this issue for?

• SEO: Identify best SEO practices for headers, URL structure, alt-text, etc.

Where should this go?

Let's create a new .md file for only the SEO section of the new AsyncAPI Style Guide.

Create the following directory and place your file there: asyncapi.com/docs/community/styleguide/seo.md.

Extra Resources

• Write the Docs: Style Guides
• Gatsby Style Guide
• Gatsby Docs Structure & Documentation Types
• Mozilla Style Guide
• Google Style Guide
• Microsoft Style Guide

[AsaEkengren]

I'm starting to work on this here

@alequetzalli: I DMed you on Slack. Just let me know!

[quetzalliwrites]

Looking good! Go ahead and open a PR when you're ready to have it reviewed by the community :)

@AsaEkengren

[quetzalliwrites]

This SEO style guide task is available again because the previous contributor ghosted us. 😂

Folks, please feel free to pick this up as a good-first-task.

[rukundob451]

This SEO style guide task is available again because the previous contributor ghosted us. 😂

Folks, please feel free to pick this up as a good-first-task.

I am going to pick it up @alequetzalli as suggested.

[CBID2]

Can I be assigned to this @alequetzalli or @thulieblack?

[thulieblack]

Hey Chrissy, sure please pick it up as I don't see anyone assigned. Please kindly open the Pull Request on the community repo https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide

[quetzalliwrites]

Hey @thulieblack sorry, but I asked @CBID2 specifically to follow the new onboarding instructions and she still hasn't followed the order of steps we noted in the TW Onboarding Guide. I need to make sure all new docs contributors follow our instructions and don't get accidentally distracted. Otherwise, the onboarding will be less successful and take longer, due to the confusing back and forth. 😸

@CBID2 Do not pick up a docs task yet, like we discussed in Slack, all new docs contributors need to follow the instructions in the onboarding guide first.

[CBID2]

Hey @thulieblack sorry, but I asked @CBID2 specifically to follow the new onboarding instructions and she still hasn't followed the order of steps we noted in the TW Onboarding Guide. I need to make sure all new docs contributors follow our instructions and don't get accidentally distracted. Otherwise, the onboarding will be less successful and take longer, due to the confusing back and forth. 😸

@CBID2 Do not pick up a docs task yet, like we discussed in Slack, all new docs contributors need to follow the instructions in the onboarding guide first.

Will do @alequetzalli. I'm on the Concepts section now :)

[thulieblack]

Thank you, Ale, and I second that. Following the onboarding instructions is an essential process before jumping to contributions. You'll understand how we write docs and what AsyncAPI is all about.

It'll be easy to contribute after that.

[CBID2]

Thank you, Ale, and I second that. Following the onboarding instructions is an essential process before jumping to contributions. You'll understand how we write docs and what AsyncAPI is all about.

It'll be easy to contribute after that.

Thanks. Now, I'm on the Tutorials section

[CBID2]

Thank you, Ale, and I second that. Following the onboarding instructions is an essential process before jumping to contributions. You'll understand how we write docs and what AsyncAPI is all about.

It'll be easy to contribute after that.

Hi @alequetzalli and @thulieblack. I've finished reading the tutorials(interactive one took me a long time to do) and posted my questions in Slack. The last two things I need to do is request a good first issue and attend the contributor meetings. So, can I be assigned to this one.

[quetzalliwrites]

Ok then, @CBID2, it looks like you earned this docs issue! 😸 Thank you for your time and volunteering to OSS! 🐻🪄

Since you should have also read the other Style Guide docs that other folks have written so far, that should help you start this SEO docs task. Let us know if you have questions!

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️