docs(cli): update installation instructions for Docker usage #4457
Conversation
akshat99812
requested review from
TRohit20,
asyncapi-bot-eve and
thulieblack
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
WalkthroughRewrote the Docker section of the CLI installation guide into two explicit options: (1) build locally with detailed volume mounts and full command sequence, and (2) pull from Docker Hub with a simplified single-run command. Clarified Windows syntax and removed the original condensed build/run snippet. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4457 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4457--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
markdown/docs/tools/cli/installation.md (1)
100-102: Clarify Option 2 example with user-facing paths.This example still mounts the CLI repo’s fixture file, which readers won’t have when they’re just pulling the published image. The command fails unless they also clone the repo. Please switch to neutral placeholders (or add a brief note) so the sample works for a clean environment.
-```bash -docker run --rm -it --user=root -v ${PWD}/test/integration/fixtures/asyncapi_v1.yml:/app/asyncapi.yml -v ${PWD}/output:/app/output asyncapi/cli generate fromTemplate -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write -``` +```bash +docker run --rm -it --user=root \ + -v /absolute/path/to/your/asyncapi.yml:/app/asyncapi.yml \ + -v /absolute/path/to/output-directory:/app/output \ + asyncapi/cli generate fromTemplate -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write +```
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/tools/cli/installation.md(1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
akshat99812
changed the title
| Then, run the image using: | ||
|
|
||
| ```bash | ||
| docker run --rm -it --user=root -v [ASYNCAPI SPEC FILE LOCATION]:/app/asyncapi.yml -v [GENERATED FILES LOCATION]:/app/output asyncapi/cli [COMMAND HERE] |
There was a problem hiding this comment.
@akshat99812 I would recommend keeping the original formatting for command syntax and example where each parameter is on a new line. This gives you a better readability and shorter line length.
|
hey @TRohit20 any update? |
|
|
||
| --- | ||
|
|
||
| ## 🏗️ Option 1: Build the image locally |
There was a problem hiding this comment.
| ## 🏗️ Option 1: Build the image locally | |
| ## Option 1: Build the image locally |
On the preview, I spot several issues:
As I expected, adding emojis to titles leads to non-user-friendly anchor links, so it's better to remove them
| One | Two |
|---|---|
 |
 |
Another drawback is that with added emojis, the browser is no longer able to scroll to these sections after clicking the links in the table of contents.
| --- | ||
|
|
||
| ## 🐳 Option 2: Pull the image from Docker Hub |
There was a problem hiding this comment.
| ## 🐳 Option 2: Pull the image from Docker Hub | |
| ## Option 2: Pull the image from Docker Hub |
| asyncapi/cli [COMMAND HERE] | ||
| ``` | ||
|
|
||
| ### Example |
There was a problem hiding this comment.
| ### Example | |
| **Example** |
Both sections have the same link to examples (#examples), so when you click on the example in the second section, the browser scrolls to the example in the first section (which is kinda expected behavior). To avoid this confusion, I would recommend making examples as bold text, not headings.
|
|
||
| # Example that you can run inside the cli directory after cloning this repository. First, you specify the mount in the location of your AsyncAPI specification file and then you mount it in the directory where the generation result should be saved. | ||
| ``` | ||
| ### Example |
There was a problem hiding this comment.
| ### Example | |
| **Example** |
4 participants
Description
This pull request addresses and fixes the issue reported in asyncapi/cli#1799
.
The changes have been implemented in the AsyncAPI Website repository to ensure consistency and resolve the problem identified in the CLI project.
Changes include:
Added the docs for the installation of cli using docker first it was only by building the image locally , added the required docs for installing the cli using docker registery.
Related issue(s)
Resolves asyncapi/cli#1799
Summary by CodeRabbit