docs: cli validation tutorial steps #1370
Conversation
Aysha-py
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
Aysha-py
changed the title
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1370--asyncapi-website.netlify.app/ |
quetzalliwrites
added
📑 docs
area/docs
|
|
Hi @alequetzalli, from our subsequent conversations, there was a comment where you said I can find the installation guide in the cli repo and I should add it to my PR. I might have missed the instruction as this is what I followed. Do you mean I have to install the CLI on my PC? Since this is my first time writing a tutorial related to Validating the document using CLI, is there a document or file that helps me understand how to do this? If I am not taking too much of your time on this, I'd appreciate clarity on this. |
No worries! So no, you are not writing a tutorial about installing the CLI, you are writing a tutorial about validating docs with the CLI. Correct, you asked me for info on how to install the CLI and I sent you to the repo. But you downloading the CLI in your dev env is not related to writing this tutorial. Let me know if you got it now :) |
|
Thank you for your reply @alequetzalli. Now I understand, Can I get a document to help me understand how to validate docs using AsynAPi so that I can update the tutorial, if you don't mind, I would love general feedback on the commit I have made so far. Thank you |
@derberg what is the best resource I (we) can give @Aysha-py in order for her to understand how to validate docs with the CLI? Do we have something already written up to share with her and maybe I am unaware? 😬😄✌🏽 |
|
@Aysha-py It is too early for me to review your draft because you must complete the entire task before I conduct an editorial review. That said, please remember you need to clean this file up and remove the content you added regarding how to install the CLI. That is NOT part of this tutorial, so you need to remove that :) |
|
The tutorial part will be removed, In the meantime, I await @derberg's answer on the resources. |
|
@Aysha-py You must remove the wrong content from THIS pull request. You shouldn't be opening a new pull request to make changes to this one; that doesn't make any sense. Also you didn't remove any content, you just added an HTML comment. Please make sure to delete wrong content, not comment it out. |
Thank you @alequetzalli, I would do this and make sure not to open a new pull request. I actually though I needed to make new PRs for corrections. |
|
This pull request 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 pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request 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 pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
Description
I added the tutorial steps, summary, and next step to the Validation steps using CLI
Related issue(s)
Related issue(s)
Fixes #1094