Skip to content

Commit

Permalink
Merge pull request #308 from marcosvbuzo/marcosvbuzo_docs
Browse files Browse the repository at this point in the history
Doc adjustments to improve user experience
  • Loading branch information
mirceaulinic authored Mar 26, 2024
2 parents 7804809 + 15dce2a commit 3056766
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ Docker

A Docker image is available at
[https://github.com/mirceaulinic/salt-sproxy/pkgs/container/salt-sproxy](https://github.com/mirceaulinic/salt-sproxy/pkgs/container/salt-sproxy),
and you can pull it, e.g., ``docker pull ghcr.io/mirceaulinic/salt-sproxy:develop``. See
and you can pull it, e.g., ``docker pull ghcr.io/mirceaulinic/salt-sproxy:master``. See
[https://salt-sproxy.readthedocs.io/en/latest/#docker](https://salt-sproxy.readthedocs.io/en/latest/#docker)
for further usage instructions and examples.

Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ Docker

A Docker image is available at
https://github.com/mirceaulinic/salt-sproxy/pkgs/container/salt-sproxy, and you can pull it, e.g.,
``docker pull ghcr.io/mirceaulinic/salt-sproxy:develop``. See
``docker pull ghcr.io/mirceaulinic/salt-sproxy:master``. See
https://salt-sproxy.readthedocs.io/en/latest/#docker for further usage
instructions and examples.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ can define the following convoluted alias:

.. code-block:: bash
alias salt-sproxy='f(){ docker run --rm --network host -v $SALT_PROXY_PILLAR_DIR:/etc/salt/pillar/ -ti ghcr.io/mirceaulinic/salt-sproxy:develop salt-sproxy $@; }; f'
alias salt-sproxy='f(){ docker run --rm --network host -v $SALT_PROXY_PILLAR_DIR:/etc/salt/pillar/ -ti ghcr.io/mirceaulinic/salt-sproxy:master salt-sproxy "$@"; }; f'
And in the ``SALT_PROXY_PILLAR_DIR`` environment variable, you set the path to
the directory where you have the Pillars, e.g.,
Expand Down
2 changes: 1 addition & 1 deletion docs/man/salt-sproxy.1
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ can define the following convoluted alias:
.sp
.nf
.ft C
alias salt\-sproxy=\(aqf(){ docker run \-\-rm \-\-network host \-v $SALT_PROXY_PILLAR_DIR:/etc/salt/pillar/ \-ti mirceaulinic/salt\-sproxy salt\-sproxy $@; }; f\(aq
alias salt\-sproxy=\(aqf(){ docker run \-\-rm \-\-network host \-v $SALT_PROXY_PILLAR_DIR:/etc/salt/pillar/ \-ti mirceaulinic/salt\-sproxy salt\-sproxy "$@"; }; f\(aq
.ft P
.fi
.UNINDENT
Expand Down

0 comments on commit 3056766

Please sign in to comment.