From bd2cb2ae031a34208fb23108118d284397152018 Mon Sep 17 00:00:00 2001 From: Adelina Simion <43963729+addetz@users.noreply.github.com> Date: Thu, 18 Jul 2024 14:30:22 +0200 Subject: [PATCH] docs: bump tutorials tag DOC-1303 (#3396) * 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 --- .prettierignore | 3 ++ .../tutorials/_checkout_tutorial_tag.mdx | 10 ++++ .../_download_tutorial_image_docker.mdx | 10 ++++ .../_download_tutorial_image_podman.mdx | 10 ++++ .../_run_tutorial_container_docker.mdx | 10 ++++ .../_run_tutorial_container_podman.mdx | 10 ++++ .../_stop_tutorial_container_docker.mdx | 9 ++++ .../_stop_tutorial_container_podman.mdx | 9 ++++ .../public-cloud/deploy-k8s-cluster.md | 40 +++------------- .../docs-content/getting-started/terraform.md | 40 +++------------- .../cluster-deployment/pde/deploy-app.md | 48 +++---------------- .../public-cloud/deploy-k8s-cluster.md | 40 +++------------- .../update-maintain/update-k8s-cluster.md | 6 +-- .../tutorials/profiles/deploy-pack.md | 22 ++++----- 14 files changed, 108 insertions(+), 159 deletions(-) create mode 100644 _partials/tutorials/_checkout_tutorial_tag.mdx create mode 100644 _partials/tutorials/_download_tutorial_image_docker.mdx create mode 100644 _partials/tutorials/_download_tutorial_image_podman.mdx create mode 100644 _partials/tutorials/_run_tutorial_container_docker.mdx create mode 100644 _partials/tutorials/_run_tutorial_container_podman.mdx create mode 100644 _partials/tutorials/_stop_tutorial_container_docker.mdx create mode 100644 _partials/tutorials/_stop_tutorial_container_podman.mdx diff --git a/.prettierignore b/.prettierignore index 575fe84caf..23e3699038 100644 --- a/.prettierignore +++ b/.prettierignore @@ -12,3 +12,6 @@ vale/ tsconfig.json src/components/IconMapper/dynamicFontAwesomeImports.js docs/docs-content/security-bulletins/cve-reports.md + +# Ignore partials +_partials/ diff --git a/_partials/tutorials/_checkout_tutorial_tag.mdx b/_partials/tutorials/_checkout_tutorial_tag.mdx new file mode 100644 index 0000000000..56e75876ba --- /dev/null +++ b/_partials/tutorials/_checkout_tutorial_tag.mdx @@ -0,0 +1,10 @@ +--- +partial_category: tutorials +partial_name: checkout-tutorials-tag +--- + +Check out the following git tag. + +```shell +git checkout v1.1.7 +``` \ No newline at end of file diff --git a/_partials/tutorials/_download_tutorial_image_docker.mdx b/_partials/tutorials/_download_tutorial_image_docker.mdx new file mode 100644 index 0000000000..c18832f4e3 --- /dev/null +++ b/_partials/tutorials/_download_tutorial_image_docker.mdx @@ -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 +``` \ No newline at end of file diff --git a/_partials/tutorials/_download_tutorial_image_podman.mdx b/_partials/tutorials/_download_tutorial_image_podman.mdx new file mode 100644 index 0000000000..3253854732 --- /dev/null +++ b/_partials/tutorials/_download_tutorial_image_podman.mdx @@ -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 +``` \ No newline at end of file diff --git a/_partials/tutorials/_run_tutorial_container_docker.mdx b/_partials/tutorials/_run_tutorial_container_docker.mdx new file mode 100644 index 0000000000..f4fd61f73c --- /dev/null +++ b/_partials/tutorials/_run_tutorial_container_docker.mdx @@ -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 +``` \ No newline at end of file diff --git a/_partials/tutorials/_run_tutorial_container_podman.mdx b/_partials/tutorials/_run_tutorial_container_podman.mdx new file mode 100644 index 0000000000..3f63f1485f --- /dev/null +++ b/_partials/tutorials/_run_tutorial_container_podman.mdx @@ -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 +``` \ No newline at end of file diff --git a/_partials/tutorials/_stop_tutorial_container_docker.mdx b/_partials/tutorials/_stop_tutorial_container_docker.mdx new file mode 100644 index 0000000000..df328259c8 --- /dev/null +++ b/_partials/tutorials/_stop_tutorial_container_docker.mdx @@ -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 +``` \ No newline at end of file diff --git a/_partials/tutorials/_stop_tutorial_container_podman.mdx b/_partials/tutorials/_stop_tutorial_container_podman.mdx new file mode 100644 index 0000000000..12d30606a7 --- /dev/null +++ b/_partials/tutorials/_stop_tutorial_container_podman.mdx @@ -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 +``` \ No newline at end of file diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index f6044aec99..d0d3255fc6 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -830,17 +830,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -```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 -``` + Navigate to the tutorial code. @@ -866,17 +858,9 @@ Use the following command and ensure you receive an output displaying the instal podman info ``` -Download the tutorial image to your local machine. + -```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 -``` + Navigate to the tutorial code. @@ -900,11 +884,7 @@ Change the directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -```shell -git checkout v1.1.3 -``` + Change the directory to the tutorial code. @@ -1354,19 +1334,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/getting-started/terraform.md b/docs/docs-content/getting-started/terraform.md index 380ffd4626..e8d8515519 100644 --- a/docs/docs-content/getting-started/terraform.md +++ b/docs/docs-content/getting-started/terraform.md @@ -75,17 +75,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -```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 -``` + Navigate to the tutorial code. @@ -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. + -```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 -``` + Navigate to the tutorial code. @@ -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 -``` + Change the directory to the tutorial code. @@ -531,19 +511,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md b/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md index dcec2ac935..2a3a49d9b5 100644 --- a/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md +++ b/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md @@ -389,21 +389,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -
- -```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 -``` + Navigate to the tutorial code. @@ -431,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.
+ -```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 -``` + Navigate to the tutorial code. @@ -473,13 +451,7 @@ Change directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -
- -```shell -git checkout v1.0.4 -``` + Change directory to the tutorial code. @@ -1294,19 +1266,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md index b82f05d84d..1fac9cd1d2 100644 --- a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md @@ -828,17 +828,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -```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 -``` + Navigate to the tutorial code. @@ -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. + -```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 -``` + Navigate to the tutorial code. @@ -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 -``` + Change the directory to the tutorial code. @@ -1352,19 +1332,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md index e6ec9f5c1c..1b1476743f 100644 --- a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md @@ -96,11 +96,7 @@ Change the directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -```shell -git checkout v1.1.3 -``` + Change the directory to the tutorial code. diff --git a/docs/docs-content/tutorials/profiles/deploy-pack.md b/docs/docs-content/tutorials/profiles/deploy-pack.md index 4782781ce2..ceeb14b2be 100644 --- a/docs/docs-content/tutorials/profiles/deploy-pack.md +++ b/docs/docs-content/tutorials/profiles/deploy-pack.md @@ -94,17 +94,17 @@ the currently active containers. docker ps ``` -Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.2` image to your local machine. This +Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.7` image to your local machine. This Docker image includes the necessary tools. ```bash -docker pull ghcr.io/spectrocloud/tutorials:1.1.2 +docker pull ghcr.io/spectrocloud/tutorials:1.1.7 ``` Next, start the container and open a bash session into it. ```bash -docker run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.2 bash +docker run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash ``` @@ -117,17 +117,17 @@ Ensure that Podman is available by issuing a command to list the currently activ podman ps ``` -Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.2` image to your local machine. This image +Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.7` image to your local machine. This image includes the necessary tools. ```bash -podman pull ghcr.io/spectrocloud/tutorials:1.1.2 +podman pull ghcr.io/spectrocloud/tutorials:1.1.7 ``` Next, start the container and open a bash session into it. ```bash -podman run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.2 bash +podman run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash ``` @@ -1290,19 +1290,13 @@ the following commands. -```bash -docker container rm --force tutorialContainer -docker image rm --force ghcr.io/spectrocloud/tutorials:1.1.2 -``` + -```bash -podman container rm --force tutorialContainer -podman image rm --force ghcr.io/spectrocloud/tutorials:1.1.2 -``` +