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

docs: new style guide - SEO #1256

Closed
Tracked by #1240
quetzalliwrites opened this issue Jan 24, 2023 · 13 comments · May be fixed by asyncapi/community#1059
Closed
Tracked by #1240

docs: new style guide - SEO #1256

quetzalliwrites opened this issue Jan 24, 2023 · 13 comments · May be fixed by asyncapi/community#1059
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs stale

Comments

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jan 24, 2023

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

@quetzalliwrites quetzalliwrites changed the title SEO docs: new style guide - SEO Jan 25, 2023
@quetzalliwrites quetzalliwrites self-assigned this Jan 25, 2023
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jan 25, 2023
@quetzalliwrites quetzalliwrites moved this to Changes proposed 📄 ✨✨ in AsyncAPI Docs Board Jan 25, 2023
@AsaEkengren
Copy link

I'm starting to work on this here

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

@quetzalliwrites
Copy link
Member Author

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

@AsaEkengren

@quetzalliwrites
Copy link
Member Author

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
Copy link
Contributor

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
Copy link

CBID2 commented Jan 30, 2024

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

@thulieblack
Copy link
Member

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
Copy link
Member Author

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
Copy link

CBID2 commented Jan 31, 2024

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
Copy link
Member

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
Copy link

CBID2 commented Jan 31, 2024

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
Copy link

CBID2 commented Feb 1, 2024

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 quetzalliwrites moved this to Changes proposed 📄 ✨✨ in AsyncAPI Docs Board Feb 7, 2024
@quetzalliwrites
Copy link
Member Author

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!

@quetzalliwrites quetzalliwrites moved this from Changes proposed 📄 ✨✨ to Community PR under Review 🧐 in AsyncAPI Docs Board Feb 13, 2024
Copy link

github-actions bot commented Jun 7, 2024

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 ❤️

@github-actions github-actions bot added the stale label Jun 7, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 5, 2024
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. 📑 docs stale
Projects
Status: Community PR under Review 🧐
Development

Successfully merging a pull request may close this issue.

5 participants