docs: fix old documentation for 'podman-mac-helper setup' #1428
Conversation
This file contains 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
…elper install' and direct users to 'podman-mac-helper install --help' for more options Signed-off-by: Mitch West <mitch9378dev@gmail.com>
benoitf
approved these changes
Feb 13, 2023
benoitf
reviewed
Feb 13, 2023
| ``` | ||
| $ brew install podman-mac-helper | ||
| ```sh | ||
| brew install podman-mac-helper |
There was a problem hiding this comment.
@themr0c there is an error in the documentation as the helper is installed by podman, there is no formulae in brew to install the helper
benoitf
requested review from
cdrage,
jeffmaury,
lstocchi,
slemeur,
themr0c and
vzhukovs
as code owners
benoitf
changed the title
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.
…elper install' and direct users to 'podman-mac-helper install --help' for more options
Signed-off-by: Mitch West mitch9378dev@gmail.com
What does this PR do?
Updates an old piece of documentation on podman-mac-helper to reflect the current CLI. Also it points users to review the --help flag for more options to facilitate discover of new command line flag --user (containers/podman#17478) and future command line changes. The intent was to not be overly verbose as the CLI should contain the necessary usage docs.
Screenshot/screencast of this PR
Old (left) vs new (right):
What issues does this PR fix or reference?
Documentation referenced a command:
which no longer exists and has been changed to 'install'
This will also facilitate the discovery of containers/podman#17478 should it be merged.
How to test this PR?
Build website and review:
/docs/troubleshooting
/docs/migrating-from-docker/using-podman-mac-helper