Skip to content

Commit

Permalink
docs: bump tutorials tag DOC-1303 (#3396) (#3419)
Browse files Browse the repository at this point in the history
* docs: bump tutorials tag DOC-1303

* docs: add partials to tutorials setup DOC-1303

* docs: add partials to tutorials cleanup DOC-1303

* docs: fix format DOC-1303

(cherry picked from commit 76f18f9)

Co-authored-by: Adelina Simion <[email protected]>
  • Loading branch information
1 parent 4932d8e commit d41a4fa
Show file tree
Hide file tree
Showing 14 changed files with 109 additions and 158 deletions.
5 changes: 4 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,7 @@ docs/api-content/**/*.json
# Troublesome files
tsconfig.json
src/components/IconMapper/dynamicFontAwesomeImports.js
docs/docs-content/security-bulletins/cve-reports.md
docs/docs-content/security-bulletins/cve-reports.md

# Ignore partials
_partials/
10 changes: 10 additions & 0 deletions _partials/tutorials/_checkout_tutorial_tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
partial_category: tutorials
partial_name: checkout-tutorials-tag
---

Check out the following git tag.

```shell
git checkout v1.1.7
```
10 changes: 10 additions & 0 deletions _partials/tutorials/_download_tutorial_image_docker.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
partial_category: tutorials
partial_name: download-tutorials-image-docker
---

Download the tutorial image to your local machine.

```bash
docker pull ghcr.io/spectrocloud/tutorials:1.1.7
```
10 changes: 10 additions & 0 deletions _partials/tutorials/_download_tutorial_image_podman.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
partial_category: tutorials
partial_name: download-tutorials-image-podman
---

Download the tutorial image to your local machine.

```bash
podman pull ghcr.io/spectrocloud/tutorials:1.1.7
```
10 changes: 10 additions & 0 deletions _partials/tutorials/_run_tutorial_container_docker.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
partial_category: tutorials
partial_name: run-tutorials-container-docker
---

Next, start the container, and open a bash session into it.

```shell
docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash
```
10 changes: 10 additions & 0 deletions _partials/tutorials/_run_tutorial_container_podman.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
partial_category: tutorials
partial_name: run-tutorials-container-podman
---

Next, start the container, and open a bash session into it.

```shell
podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash
```
9 changes: 9 additions & 0 deletions _partials/tutorials/_stop_tutorial_container_docker.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
partial_category: tutorials
partial_name: stop-tutorials-container-docker
---

```shell
docker stop tutorialContainer && \
docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.7
```
9 changes: 9 additions & 0 deletions _partials/tutorials/_stop_tutorial_container_podman.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
partial_category: tutorials
partial_name: stop-tutorials-container-podman
---

```shell
podman stop tutorialContainer && \
podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.7
```
40 changes: 7 additions & 33 deletions docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -828,17 +828,9 @@ displaying the version number.
docker version
```

Download the tutorial image to your local machine.
<PartialsComponent category="tutorials" name="download-tutorials-image-docker" />

```bash
docker pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

```shell
docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-docker" />

Navigate to the tutorial code.

Expand All @@ -864,17 +856,9 @@ Use the following command and ensure you receive an output displaying the instal
podman info
```

Download the tutorial image to your local machine.
<PartialsComponent category="tutorials" name="download-tutorials-image-podman" />

```bash
podman pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

```shell
podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-podman" />

Navigate to the tutorial code.

Expand All @@ -898,11 +882,7 @@ Change the directory to the tutorial folder.
cd tutorials/
```

Check out the following git tag.

```shell
git checkout v1.1.3
```
<PartialsComponent category="tutorials" name="checkout-tutorials-tag" />

Change the directory to the tutorial code.

Expand Down Expand Up @@ -1352,19 +1332,13 @@ the **Enter** key. Next, issue the following command to stop the container.

<TabItem label="Docker" value="docker">

```shell
docker stop tutorialContainer && \
docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-docker" />

</TabItem>

<TabItem label="Podman" value="podman">

```shell
podman stop tutorialContainer && \
podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-podman" />

</TabItem>

Expand Down
40 changes: 7 additions & 33 deletions docs/docs-content/getting-started/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,17 +75,9 @@ displaying the version number.
docker version
```

Download the tutorial image to your local machine.
<PartialsComponent category="tutorials" name="download-tutorials-image-docker" />

```bash
docker pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

```shell
docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-docker" />

Navigate to the tutorial code.

Expand All @@ -111,17 +103,9 @@ Use the following command and ensure you receive an output displaying the instal
podman info
```

Download the tutorial image to your local machine.
<PartialsComponent category="tutorials" name="download-tutorials-image-podman" />

```bash
podman pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

```shell
podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-podman" />

Navigate to the tutorial code.

Expand All @@ -145,11 +129,7 @@ Change the directory to the tutorial folder.
cd tutorials/
```

Check out the following git tag.

```shell
git checkout v1.1.3
```
<PartialsComponent category="tutorials" name="checkout-tutorials-tag" />

Change the directory to the tutorial code.

Expand Down Expand Up @@ -531,19 +511,13 @@ the **Enter** key. Next, issue the following command to stop the container.

<TabItem label="Docker" value="docker">

```shell
docker stop tutorialContainer && \
docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-docker" />

</TabItem>

<TabItem label="Podman" value="podman">

```shell
podman stop tutorialContainer && \
podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-podman" />

</TabItem>

Expand Down
46 changes: 7 additions & 39 deletions docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,19 +389,9 @@ displaying the version number.
docker version
```

Download the tutorial image to your local machine. <br />
<PartialsComponent category="tutorials" name="download-tutorials-image-docker" />

```bash
docker pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

<br />

```shell
docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-docker" />

Navigate to the tutorial code.

Expand Down Expand Up @@ -429,19 +419,9 @@ Use the following command and ensure you receive an output displaying the instal
podman info
```

Download the tutorial image to your local machine. <br />

```bash
podman pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.
<PartialsComponent category="tutorials" name="download-tutorials-image-podman" />

<br />

```shell
podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-podman" />

Navigate to the tutorial code.

Expand Down Expand Up @@ -471,13 +451,7 @@ Change directory to the tutorial folder.
cd tutorials/
```

Check out the following git tag.

<br />

```shell
git checkout v1.0.4
```
<PartialsComponent category="tutorials" name="checkout-tutorials-tag" />

Change directory to the tutorial code.

Expand Down Expand Up @@ -1247,19 +1221,13 @@ the **Enter** key. Next, issue the following command to stop the container.
<TabItem label="Docker" value="Docker">
```shell
docker stop tutorialContainer && \
docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-docker" />
</TabItem>
<TabItem label="Podman" value="Podman">
```shell
podman stop tutorialContainer && \
podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-podman" />
</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -828,17 +828,9 @@ displaying the version number.
docker version
```

Download the tutorial image to your local machine.
<PartialsComponent category="tutorials" name="download-tutorials-image-docker" />

```bash
docker pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

```shell
docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-docker" />

Navigate to the tutorial code.

Expand All @@ -864,17 +856,9 @@ Use the following command and ensure you receive an output displaying the instal
podman info
```

Download the tutorial image to your local machine.
<PartialsComponent category="tutorials" name="download-tutorials-image-podman" />

```bash
podman pull ghcr.io/spectrocloud/tutorials:1.1.3
```

Next, start the container, and open a bash session into it.

```shell
podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash
```
<PartialsComponent category="tutorials" name="run-tutorials-container-podman" />

Navigate to the tutorial code.

Expand All @@ -898,11 +882,7 @@ Change the directory to the tutorial folder.
cd tutorials/
```

Check out the following git tag.

```shell
git checkout v1.1.3
```
<PartialsComponent category="tutorials" name="checkout-tutorials-tag" />

Change the directory to the tutorial code.

Expand Down Expand Up @@ -1352,19 +1332,13 @@ the **Enter** key. Next, issue the following command to stop the container.

<TabItem label="Docker" value="docker">

```shell
docker stop tutorialContainer && \
docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-docker" />

</TabItem>

<TabItem label="Podman" value="podman">

```shell
podman stop tutorialContainer && \
podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
```
<PartialsComponent category="tutorials" name="stop-tutorials-container-podman" />

</TabItem>

Expand Down
Loading

0 comments on commit d41a4fa

Please sign in to comment.