docs: use published GHCR image in README examples - #5
Merged
Merged
Conversation
Point the install examples at ghcr.io/dstack-tee/dstack-openssh-installer:latest instead of a placeholder $NS namespace, lead with the GitHub-user import one-liner, and move the build-it-yourself steps below the install section.
There was a problem hiding this comment.
🟢 Approval recommended
The change is docs-only and the only remaining feedback is a minor clarity improvement for the $NS placeholder in the “Build the Installer Yourself” snippet.
Pull request overview
Updates the README Quick Start to use the published GHCR image so users can copy/paste working install commands without needing to substitute a namespace placeholder.
Changes:
- Reordered Quick Start to lead with install instructions and GitHub username key import.
- Updated install examples to use
ghcr.io/dstack-tee/dstack-openssh-installer:latest. - Moved “Build the Installer” instructions below the install section and fixed the “instuction” typo.
File summaries
| File | Description |
|---|---|
| README.md | Refreshes Quick Start examples to use the published GHCR image and improves copy/paste usability. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+35
to
+37
| chmod +x build.sh | ||
| ./build.sh $NS/dstack-openssh-installer latest | ||
| docker push $NS/dstack-openssh-installer:latest |
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
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.
What
Update the README Quick Start so users can copy-paste a working command instead of substituting a
$NSplaceholder namespace.ghcr.io/dstack-tee/dstack-openssh-installer:latest(built and pushed by the existingGHCRworkflow).docker run --rm --privileged --pid=host --net=host -v /:/host -e SSH_GITHUB_USER="alice,bob" ghcr.io/dstack-tee/dstack-openssh-installer:latestSSH_GITHUB_USERis already documented as comma-separated).Docs-only change; no behavior changes.