[📑 Docs]: new tutorial 'validate AsyncAPI document with CLI'

[quetzalliwrites]

What Dev Docs changes are you proposing?

2022 GSoD project scope included creating a NEW tutorial for "validating AsyncAPI documents with Studio." However, because there is more than 1 method for validating AsyncAPI documents, we also need to document how to validate AsyncAPI documents with CLI commands.

Instructions for contributing technical writer

1. Let's name this new file cli-document-validation.md, so we end up with a URL like so: asyncapi.com/docs/tutorials/cli-document-validation.

2. Add a page weight of around 115 so that this CLI validation tutorial shows up BEFORE the studio validation tutorial in the left-hand navigation in Docs.

   

3. For tutorials, use the following outline headers: Introduction Background context Installation Guide (tutorial steps) Summary Next steps

Code of Conduct

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

[Jagrutiti]

Hey,

Though I do not understand the issue completely. It is clear from the description that I have to write about validating AsyncAPI with CLI commands.

Though I am a beginner in technical writing. The issue sounds interesting.

I would like to take this up and give it a try.

[quetzalliwrites]

Hey @Jagrutiti, to pick this up I need to first onboard you as a new OSS Docs contributor to help you be ready to take this on. 😄✌🏽

Send me a Slack DM with a link to this issue (AsyncAPI community's primary communication method is Slack ✌🏽). Then I will onboard you offline to get you ready.

[Aysha-py]

@alequetzalli, is this issue still opened, Can I send a DM to you on slack ?

[Jagrutiti]

Hey @Aysha-py

Just wanted to let you know that I am going to start working on this issue from next week.

[quetzalliwrites]

heyo!

@Jagrutiti, since we've been teaming up and planning offline already with Maciej how to get you started working on Studio tool documentation, I would finish that task before picking up another doc issue. 😄

@Aysha-py are you still interested in doing this tutorial? ✨✌🏽

[Aysha-py]

@alequetzalli Yes please, I am still interested. Can you Kindly put me through the process of Validating Async API document with CLI? or do I need to make the research myself?

[quetzalliwrites]

@alequetzalli Yes please, I am still interested. Can you Kindly put me through the process of Validating Async API document with CLI? or do I need to make the research myself?

@Aysha-py to pick this up, I need to first onboard you as a new OSS Docs contributor to help you be ready to take this on. 😄✌🏽

Send me a Slack DM with a link to this issue. Then I will onboard you offline to get you ready.

[quetzalliwrites]

Confirming that I've onboarded @Aysha-py into our OSS Docs project; now I'm giving her the context to write this tutorial. 😄

[github-actions[bot]]

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

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 :heart: