Skip to content

docs: add Docker Hub image reference to installation docs (fixes #1799)#2176

Open
gavin913427-hash wants to merge 1 commit intoasyncapi:masterfrom
gavin913427-hash:fix/docker-docs-image
Open

docs: add Docker Hub image reference to installation docs (fixes #1799)#2176
gavin913427-hash wants to merge 1 commit intoasyncapi:masterfrom
gavin913427-hash:fix/docker-docs-image

Conversation

@gavin913427-hash
Copy link
Copy Markdown

What does this PR do?

Adds Docker Hub image reference to the installation documentation (fixes #1799)

Changes

Updated docs/installation.md Docker section to:

  1. Add a new "Using the pre-built image from Docker Hub" subsection with docker pull asyncapi/cli:latest and usage example
  2. Reorganize the existing build-from-source instructions under a "Building from source" subsection

Why this matters

Previously, the Docker docs only mentioned building from source, which requires cloning the repo and waiting for the build. The official Docker Hub image at asyncapi/cli is already published on every release but wasn't documented.

Related issue(s)

Fixes #1799

Checklist

  • Added Docker Hub image section
  • Organized existing content under "Building from source"
  • Added changeset

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 4, 2026

🦋 Changeset detected

Latest commit: 65f5fd1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@asyncapi/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 4, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Triage

Development

Successfully merging this pull request may close these issues.

[📑 Docs]: Docs for installation with docker not mention the docker repository image for cli.

1 participant