Skip to content

[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cli/installing-the-roxctl-cli.adoc #111774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
agantony wants to merge 1 commit into
base: rhacs-docs-main
Choose a base branch
from
Open

[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cli/installing-the-roxctl-cli.adoc #111774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions cli/installing-the-roxctl-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,9 @@ toc::[]
You can install the `roxctl` CLI by downloading the binary or you can run the `roxctl` CLI from a container image.


[id="installing-the-roxctl-cli-by-downloading-the-binary_{context}"]
== Installing the roxctl CLI by downloading the binary

You can install the `roxctl` CLI to interact with {product-title-short} from a command-line interface. You can install `roxctl` on Linux, Windows, or macOS.

// Installing the CLI by downloading the binary
include::modules/install-roxctl-cli-binary.adoc[leveloffset=+1]

include::modules/install-roxctl-cli-linux.adoc[leveloffset=+2]

include::modules/install-roxctl-cli-macos.adoc[leveloffset=+2]
Expand Down
10 changes: 10 additions & 0 deletions modules/install-roxctl-cli-binary.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * cli/installing-the-roxctl-cli.adoc

:_mod-docs-content-type: CONCEPT
[id="installing-the-roxctl-cli-by-downloading-the-binary_{context}"]
= Installing the roxctl CLI by downloading the binary

[role="_abstract"]
You can install the `roxctl` CLI to interact with {product-title-short} from a command-line interface. You can install `roxctl` on Linux, Windows, or macOS.
4 changes: 2 additions & 2 deletions modules/install-roxctl-cli-linux.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can install the `roxctl` CLI binary on Linux by using the following procedur

.Procedure

. Determine the `roxctl` architecture for the target operating system:
. Find the `roxctl` architecture for the target operating system:
+
[source,terminal,subs=attributes+]
----
Expand All @@ -39,7 +39,7 @@ $ chmod +x roxctl

. Place the `roxctl` binary in a directory that is on your `PATH`:
+
To check your `PATH`, execute the following command:
To check your `PATH`, run the following command:
+
[source,terminal]
----
Expand Down
4 changes: 2 additions & 2 deletions modules/install-roxctl-cli-macos.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can install the `roxctl` CLI binary on macOS by using the following procedur

.Procedure

. Determine the `roxctl` architecture for the target operating system:
. Find the `roxctl` architecture for the target operating system:
+
[source,terminal,subs=attributes+]
----
Expand Down Expand Up @@ -46,7 +46,7 @@ $ chmod +x roxctl

. Place the `roxctl` binary in a directory that is on your `PATH`:
+
To check your `PATH`, execute the following command:
To check your `PATH`, run the following command:
+
[source,terminal]
----
Expand Down
1 change: 1 addition & 0 deletions modules/run-roxctl-from-container.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="run-roxctl-from-container_{context}"]
= Running the roxctl CLI from a container

[role="_abstract"]
The `roxctl` client is the default entry point in the {product-title-short} `roxctl` image.
To run the `roxctl` client in a container image:

Expand Down