Skip to content

Commit

Permalink
docs: move run-kas hint to developer guide
Browse files Browse the repository at this point in the history
This command is only intended for local development. By that, move it to
the developer guide.

Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
  • Loading branch information
fmoessbauer authored and jan-kiszka committed Oct 25, 2024
1 parent 13fabfe commit 9f36e05
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/devguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ project yourself you can create the necessary links via::

That will install a backlink ~/.local/bin/kas to this project. Now you are
able to call it from anywhere.
For local development, use the **run-kas** wrapper from the project root
directory. In this case, replace ``kas`` with ``path/to/run-kas``.


Container image build
Expand Down
4 changes: 1 addition & 3 deletions docs/userguide/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To install kas into your python site-package repository, run::
Usage
-----

There are (at least) four options for using kas:
There are (at least) three options for using kas:

- Install it locally via pip to get the ``kas`` command.
- Use the container image locally. In this case, download the
Expand All @@ -31,8 +31,6 @@ There are (at least) four options for using kas:
- Use the container image in CI. Specify
``ghcr.io/siemens/kas/kas[-isar][:<x.y>]`` in your CI script that requests
a container image as runtime environment.
- Use the **run-kas** wrapper from this directory. In this case,
replace ``kas`` in the examples below with ``path/to/run-kas``.

Start build::

Expand Down

0 comments on commit 9f36e05

Please sign in to comment.