Skip to content
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.

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

docs: set up get-started directory tree #1303

Merged
merged 8 commits into from
Apr 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions docs/content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Getting started
description: Familiarize yourself with the Keptn Lifecycle Toolkit
weight: 15
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

> **Note**
This section is under development.
We welcome your input!**

This section provides excercises to introduce you to
the Keptn Lifecycle Toolkit.
Choose the exercise that interest you the most.

The [Introducing Keptn Lifecycle Toolkit](https://youtu.be/449HAFYkUlY)
video discusses three common use cases for the Lifecycle Toolkit
and walks you through the implementation process for each.
The following exercises provide more detailed instructions
for implementing these use cases:

* [Getting started with Keptn metrics](metrics)
* [Standardize access to observability data](observability)
* [Orchestrate deployment checks](orchestrate)

If you prefer,
[Getting started with Lifecycle Toolkit](generic-gs)
provides an exercise that introduces you to
all the things KLT can do.
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
title: Getting Started
linktitle: Getting Started
title: Getting started with the Lifecycle Toolkit
description: Learn how to use the Keptn Lifecycle Toolkit.
weight: 15
weight: 85
---


This page gives instructions for installing the Keptn Lifecycle Toolkit
and running a simple Keptn application to familiarize yourself
with how KLT works.
with how the Keptn Lifecycle Toolkit works.

You will learn how to do the following:

Expand Down
6 changes: 6 additions & 0 deletions docs/content/en/docs/getting-started/metrics/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Getting started with Keptn metrics
description: Learn how Keptn metrics enhances your deployment
weight: 25
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Standardize access to observability data
description: Learn how the Keptn Lifecycle Toolkit standardizes access to observability data.
weight: 45
---

6 changes: 6 additions & 0 deletions docs/content/en/docs/getting-started/orchestrate/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Getting started with the Lifecycle Toolkit
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has the same title as the previous section. Maybe we can call this Deployment Orchestration. This can be done in a follow up :)
@StackScribe

description: Learn how the Keptn Lifecycle Toolkit can orchestrate deployment checks.
weight: 55
---

1 change: 0 additions & 1 deletion docs/content/en/docs/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@ or as part of an existing production cluster.
This step is only required if you want to replace the default KLT cert-manager
with another cert-manager.
1. [Install the Keptn Lifecycle Controller](install.md)
1. [Integrate the Keptn Lifecycle Controller into your Kubernetes cluster](integrate.md)
1. [Upgrade](upgrade.md) to a new version of the Keptn Lifecycle Toolkit