Skip to content

Conversation

activus-d
Copy link

This Pull Request creates the AsyncAPI CLI content under the Tools content bucket by re-writing and editing what is currently in the CLI readME docs. This resolves issue #1078

@netlify
Copy link

netlify bot commented Nov 10, 2022

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit b6ed1e3
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6393f9470048ca0008749637
😎 Deploy Preview https://deploy-preview-1097--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Nov 10, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 37
🟠 Accessibility 88
🟢 Best practices 100
🟢 SEO 100
🔴 PWA 30

Lighthouse ran on https://deploy-preview-1097--asyncapi-website.netlify.app/

@quetzalliwrites quetzalliwrites added area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs labels Nov 10, 2022
@quetzalliwrites quetzalliwrites linked an issue Nov 10, 2022 that may be closed by this pull request
1 task
Copy link
Contributor

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yay! nice job so far! thank you for taking care of that so quickly 🙌🏽🙌🏽🙌🏽

We need to have another technical feedback review by @derberg before we can merge tho, so now we wait for him 😄✌🏽

@activus-d
Copy link
Author

yay! nice job so far! thank you for taking care of that so quickly 🙌🏽🙌🏽🙌🏽

We need to have another technical feedback review by @derberg before we can merge tho, so now we wait for him 😄✌🏽

@alequetzalli thank you for your compliments. I was only able to complete the task so quickly because of your well detailed and timely feedbacks. It's been a pleasure working with you on this, and I'm looking forward to working with you on a new task once this current one is completed.

@derberg
Copy link
Member

derberg commented Nov 21, 2022

It looks good. My only concern is that it is CLI docs authored in website repo, and it should be authored in cli repo, like we do with generator.

@derberg
Copy link
Member

derberg commented Nov 24, 2022

@alequetzalli I mean we need docs under cli repo (but 3 markdown files, one for intro, one for installation and one for usage, and later we can add a nice one about context concept explanation), and then add automation to cli repo that will push any updates done to docs, to the website repo.

Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Hey @activus-d, kindly update the GoBack button on /docs/guides page to point it to the new AsyncAPI CLI page created by you.

@activus-d
Copy link
Author

image

Hey @activus-d, kindly update the GoBack button on /docs/guides page to point it to the new AsyncAPI CLI page created by you.

@akshatnema Thanks for the Observation. The branch has been updated.

@quetzalliwrites
Copy link
Contributor

quetzalliwrites commented Dec 6, 2022

Hey @activus-d here is what you need to do:

  1. We are not going to merge this PR; as Lukasz observed, we want to host docs in their main repo and have them copied to the website repo where we can maintain them in the official website.
  2. You must create a NEW PR in the CLI repo with this same exact content. Make sure this new PR in the CLI repo is only the written docs' content. (You don't need to add the prev/next buttons here since those only work on the /website repo.)
  3. For this NEW PR, let's actually make a tiny change. We want to have this CLI docs have subsections in the left-hand navigation. To accomplish that, you must separate your current CLI docs into separate files instead of only 1 file like you currently have in this PR. Let's separate your content based on the outline into 3 tiny sub-sections: introduction.md, installation.md, and usage.md.
  4. @derberg needs to code an automation that copies new docs added in CLI repo to the /website repo. Once that functionality is complete, it will be automatic to open a PR in both CLI and /website repoes. (Lukasz needs to sync with us on what he thinks his next steps here are and timeline)
  5. After the new automation copies the docs over to a new PR in the /websiterepo, you must ensure to add the prev/next buttons just like akshat showed you here.

I realize this is a lot of extra steps to think about, so please let us know if you understand and if you're able to do next steps. 😄✌🏽

@quetzalliwrites
Copy link
Contributor

later we can add a nice one about context concept explanation

Not quite, that is not what the Concepts sections is for and you should not duplicate content buckets into sub-sections.

Instead, the CLI tool will be introduced in the first file of introduction.md and any background context needed to introduce the tool shall be inside the Introduction section.

@derberg

Copy link
Member

derberg commented Dec 6, 2022

Not quite, that is not what the Concepts sections is for and you should not duplicate content buckets into sub-sections.

oh, sorry, by concept I meant concept in general, not Concept bucket. So like in generator, where we have docs that explain different generator concepts, but these are just on the list of docs for generator. Same I mean for CLI, we just need to have later a document that explains "context" functionality/concept in the CLI.

@activus-d
Copy link
Author

activus-d commented Dec 6, 2022

  1. You must create a NEW PR in the CLI repo with this same exact content. Make sure this new PR in the CLI repo is only the written docs' content. (You don't need to add the prev/next buttons here since those only work on the /website repo.)
  2. For this NEW PR, let's actually make a tiny change. We want to have this CLI docs have subsections in the left-hand navigation. To accomplish that, you must separate your current CLI docs into separate files instead of only 1 file like you currently have in this PR. Let's separate your content based on the outline into 3 tiny sub-sections: introduction.md, installation.md, and usage.md.

@alequetzalli Alright. However, you are yet to tell me which of the directories in the CLI repository would host the documents. Is it that I will create a new folder at the root of the repository and name it (let's say docs)? I need a specific direction in this regard.

Copy link
Member

derberg commented Dec 6, 2022

@activus-d yes, new docs directory like https://github.com/asyncapi/generator/tree/master/docs

@activus-d
Copy link
Author

@derberg @alequetzalli I will work on it and make a pull request soon.

@activus-d
Copy link
Author

@alequetzalli @derberg the pull request has been made as instructed. Kindly review.

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey folks, should not this PR be closed in favour of the one from CLI?

@quetzalliwrites
Copy link
Contributor

CLOSING in favor of resolving via asyncapi/cli#414

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
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: add CLI docs to tools content bucket
4 participants