[📑 Docs]: Create an Onboarding guide for technical writers

[CynthiaPeter]

What Dev Docs changes are you proposing?

During my onboarding call with @alequetzalli, I figured some of her onboarding tips could be documented and shared with technical writers who wish to contribute to the AsyncAPI project.

This onboarding guide(Name could be changed, but for lack of a name, I am sticking with the Onboarding guide ) will highlight or link to existing resources things like:

• How page weight and content bucket section.md files work.
• Why every folder contains an index.md and _section.md files and what role they play.
• Step-by-step guide to create content buckets, new pages, and general editing rules.
• Github (Feature-branches, conventional commits, naming branches, and all things Git).

Why is this important?

• To reduce the time spent during the onboarding call. With new contributors joining the community very often, it is essential to automate things that can be automated while sparing time for the maintainers and contributors to do work.
• To help new contributors get comfortable with the "What, Why, How, Who" questions they may have.
• To have one source of truth for writers and editors in the community.

What content bucket will this live in?

This guide will live under the community content bucket.

Resources

• Technical writer onboarding toolkit by Opendocs.

Notes
Please feel free to comment if you have any ideas or suggestions about things that can be added to this document. Thank you.

CC: @alequetzalli @derberg

Code of Conduct

• I agree to follow this project's Code of Conduct

[quetzalliwrites]

Thank you for following up on this! ✨

I recommend tightening the scope and rewriting this description to specify what the onboarding guide should include. (i.e., In our 1:1, one item you wanted to document was how page weight and content bucket section.md files work) Otherwise, this current issue description is too generic and doesn't actually specify what to begin documenting. Let me know if that makes sense. 😄

[CynthiaPeter]

Thank you for following up on this! ✨

I recommend tightening the scope and rewriting this description to specify what the onboarding guide should include. (i.e., In our 1:1, one item you wanted to document was how page weight and content bucket section.md files work) Otherwise, this current issue description is too generic and doesn't actually specify what to begin documenting. Let me know if that makes sense. 😄

Oh yes. Thank you for that, @alequetzalli. I made some adjustments. Let me know how I can better improve the description.

[quetzalliwrites]

I love it! Great work ✨✨✨

I would make each one of those a task in this issue and then convert it into an issue. (let me know if this doesn't make sense)

BTW, I would also double check the /community repo to see if your 4th idea (Github, Feature-branches, conventional commits, naming branches, and all things Git) is already under work by another contrbutor. I think it might be 🧐

[Iykee]

I would like to work on this.
@alequetzalli have you been able to convert them to individual tasks

[quetzalliwrites]

Unfortunately, this issue is already assigned to @CynthiaPeter.

Let's find another issue for you to contribute to the docs. 😊 Please go ahead and send me a DM in the AsyncAPI Slack so that I can help you out.

[quetzalliwrites]

Hey @CynthiaPeter! 😄 How is this going? Let me know if you wanna sync for progress help ✌🏽

[CynthiaPeter]

Hello @alequetzalli

I'll appreciate a sync. I'll send you a message via Slack to know your availability.

[quetzalliwrites]

Perfect 🤩 , I really am excited to see you undertake this guide since it was your own great idea!

Following up with you on slack now...

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

[sambhavgupta0705]

still relevant

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

[TRohit20]

Still relevant.