From 4b8efc7f74d61d9e65a06707386b7f279fb671e5 Mon Sep 17 00:00:00 2001 From: AnaisUrlichs Date: Thu, 18 May 2023 15:07:33 +0100 Subject: [PATCH 1/2] feat: adding playground tutorial Signed-off-by: AnaisUrlichs --- docs/getting-started/getting-started.md | 2 ++ docs/tutorials/playground.md | 13 +++++++++++++ mkdocs.yml | 1 + 3 files changed, 16 insertions(+) create mode 100644 docs/tutorials/playground.md diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index d51c858..3daa602 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -1,5 +1,7 @@ # Getting Started Guide +You can either get started with K8sGPT in your own environment, the details are provided below or you can use our [Playground example on Killrcoda](../tutorials/playground.md). + ## Prerequisites 1. Ensure `k8sgpt` is installed correctly on your environment by following the [installation](./installation.md). diff --git a/docs/tutorials/playground.md b/docs/tutorials/playground.md new file mode 100644 index 0000000..d2b0ad1 --- /dev/null +++ b/docs/tutorials/playground.md @@ -0,0 +1,13 @@ +# K8sGPT Playground + +If you want to try out K8sGPT, we highly suggest you to follow this Killrcoda example: + +Link: [**K8sGPT CLI Tutorial**](https://killercoda.com/matthisholleville/scenario/k8sgpt-cli) + +This tutorials covers: + +- Run a simple analysis and explore possible options +- Discover how AI works Explanation +- Stay on the down-low with the anonymize option (because we don't want any trouble with the feds) +- Filter ressources like a boss +- Use Integrations diff --git a/mkdocs.yml b/mkdocs.yml index 1da7b1b..5b38b4a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,7 @@ nav: - Tutorials: - Overview: tutorials/index.md - Content Collection: tutorials/content-collection/content-collection.md + - K8sGPT Playground: tutorials/playground.md - Reference: - CLI: - Overview: reference/cli/index.md From 25a4c2635fb5180b79dc0039a6c4fa41d9ee68d3 Mon Sep 17 00:00:00 2001 From: AnaisUrlichs Date: Thu, 18 May 2023 15:09:55 +0100 Subject: [PATCH 2/2] feat: adding playground tutorial Signed-off-by: AnaisUrlichs --- docs/tutorials/playground.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/playground.md b/docs/tutorials/playground.md index d2b0ad1..f817f2e 100644 --- a/docs/tutorials/playground.md +++ b/docs/tutorials/playground.md @@ -9,5 +9,5 @@ This tutorials covers: - Run a simple analysis and explore possible options - Discover how AI works Explanation - Stay on the down-low with the anonymize option (because we don't want any trouble with the feds) -- Filter ressources like a boss +- Filter resources like a boss - Use Integrations