docs: update docker installation section to mention docker Hub image#2238
Open
pvbang wants to merge 1 commit into
Open
docs: update docker installation section to mention docker Hub image#2238pvbang wants to merge 1 commit into
pvbang wants to merge 1 commit into
Conversation
The Docker installation docs previously only mentioned building from source. This update adds information about the official Docker Hub image (asyncapi/cli) which is the recommended approach for most users. Changes: - Add 'Using the official Docker Hub image' subsection (recommended) - Include docker pull commands for latest and specific versions - Add link to Docker Hub tags page - Add practical usage examples (validate, generate) - Move existing build-from-source instructions to a subsection Closes asyncapi#1799
pvbang
requested review from
AayushSaini101,
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
|
|
AayushSaini101
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the Docker installation documentation (
docs/installation.md) to mention the official Docker Hub image availability.Changes
The Docker section previously only mentioned building the image from source code. This update:
Adds a "Using the official Docker Hub image" subsection (marked as recommended) with:
docker pull asyncapi/clicommand for latest versionMoves existing build-from-source instructions to a "Building from source" subsection as an alternative approach
Related Issue
Closes #1799
Motivation
The
asyncapi/cliDocker image is already published on Docker Hub with 274+ tags, but the installation docs did not mention this. Users had to discover it on their own or build from source unnecessarily. This update makes the recommended Docker workflow more discoverable.Checklist