Skip to content

Commit

Permalink
docs: add terminal into code blocks (#1146)
Browse files Browse the repository at this point in the history
  • Loading branch information
esoubiran-aneo authored Jun 21, 2023
1 parent b5e9f74 commit 01e1db2
Show file tree
Hide file tree
Showing 12 changed files with 110 additions and 110 deletions.
2 changes: 1 addition & 1 deletion .docs/content/1.installation/1.linux/0.prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to install ArmoniK locally or on-premise, you must have a few of things

You can easily install all of them using the [ArmoniK prerequisites installer](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/utils/scripts/installation/prerequisites-installer.sh) from the root repository.

```bash
```bash [shell]
./infrastructure/utils/scripts/installation/prerequisites-installer.sh
```

Expand Down
42 changes: 21 additions & 21 deletions .docs/content/1.installation/1.linux/1.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Before running the script, you must set environment variables.

From the root of the repository:

```bash
```bash [shell]
cd infrastructure/quick-deploy/localhost
```

Then, you can set environment variables in the file `envvars.sh`:

```bash
```bash [shell]
source envvars.sh
```

Expand All @@ -30,7 +30,7 @@ Please, read the file `envvars.sh` before running it.

Create data directory:

```bash
```bash [shell]
mkdir -p "${ARMONIK_SHARED_HOST_PATH}"
```

Expand All @@ -44,7 +44,7 @@ You can find why your pod doesn't start using `kubectl describe pod <pod_name> -

Finally, you can run the script to deploy ArmoniK on your local machine:

```bash
```bash [shell]
make deploy-all
```

Expand All @@ -66,23 +66,23 @@ armonik = {

You can also deploy each resource independently:

```bash
```bash [shell]
make deploy-keda
```

```bash
```bash [shell]
make deploy-metrics-server
```

```bash
```bash [shell]
make deploy-storage
```

```bash
```bash [shell]
make deploy-monitoring
```

```bash
```bash [shell]
make deploy-armonik
```

Expand All @@ -94,7 +94,7 @@ The order matters because top level resources depend on the bottom level resourc

To destroy all the infrastructure, you can run the following command:

```bash
```bash [shell]
make destroy-all
```

Expand All @@ -104,23 +104,23 @@ To reinstall, you must restart from [setup environment variables](#setup-environ

You can also destroy each resource independently:

```bash
```bash [shell]
make destroy-armonik
```

```bash
```bash [shell]
make destroy-monitoring
```

```bash
```bash [shell]
make destroy-storage
```

```bash
```bash [shell]
make destroy-metrics-server
```

```bash
```bash [shell]
make destroy-keda
```

Expand All @@ -132,7 +132,7 @@ The order matters. You must destroy the resources in the reverse order of the de

To clean all the generated files from the deployment, you can run the following command:

```bash
```bash [shell]
make clean-all
```

Expand All @@ -142,23 +142,23 @@ To reinstall, you must restart from [setup environment variables](#setup-environ

You can also clean each resource independently:

```bash
```bash [shell]
make clean-armonik
```

```bash
```bash [shell]
make clean-monitoring
```

```bash
```bash [shell]
make clean-storage
```

```bash
```bash [shell]
make clean-metrics-server
```

```bash
```bash [shell]
make clean-keda
```

Expand Down
8 changes: 4 additions & 4 deletions .docs/content/1.installation/1.linux/2.verify-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can also retrieve the `seq.web_url` from the Terraform outputs `monitoring/g

Example:

```bash
```bash [shell]
http://<ip_address>:8080
```

Expand All @@ -34,7 +34,7 @@ You can also retrieve the `armonik.admin_gui_url` from the Terraform outputs `ar

Example:

```bash
```bash [shell]
http://<ip_address>:5000
```

Expand All @@ -60,7 +60,7 @@ You can find more information about samples in their [dedicated documentation](h

Before executing the samples, you must clone [ArmoniK.Samples](https://github.com/aneoconsulting/ArmoniK.Samples) into a folder name `Source` from the root repository of ArmoniK:

```bash
```bash [shell]
git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK.Samples/
```

Expand All @@ -69,7 +69,7 @@ git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK
<!-- TODO: Verify how to execute samples -->
* Execute [tools/tests/symphony_like.sh](https://github.com/aneoconsulting/ArmoniK.Samples/blob/main/tools/tests/symphony_like.sh) from the **root** repository:

```bash
```bash [shell]
tools/tests/symphony_like.sh
```

Expand Down
Loading

0 comments on commit 01e1db2

Please sign in to comment.