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: restructure getting-started section #2294

Merged
merged 8 commits into from
Oct 24, 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
593 changes: 2 additions & 591 deletions docs/content/en/docs/getting-started/_index.md

Large diffs are not rendered by default.

594 changes: 594 additions & 0 deletions docs/content/en/docs/getting-started/observability/_index.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Getting started with Release Lifecycle Management
title: Release Lifecycle Management
description: Add KeptnTasks to deployments
weight: 25
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
weight: 50
---

The Release Lifecycle Management tools run
Expand Down Expand Up @@ -151,7 +150,8 @@ Incidentally, this is exactly how you can use Keptn with [applications deployed

Annotate the demo application `Deployment` manifest to have Keptn automatically trigger the task after every deployment.

Recall the `Deployment` from the [getting started guide](../../getting-started/_index.md#step-3-deploy-demo-application).
Recall the `Deployment` from the [Observability](../../getting-started/observability/_index.md#step-3-deploy-demo-application)
Getting started guide.

Add a new label so the `labels` section looks like this:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Custom Keptn metrics
title: Keptn metrics
description: Enhance your deployment with custom Keptn metrics
weight: 30
---

The Custom Keptn metrics component
The Keptn metrics component
allows you to define any type of metric
from multiple instances
of any type of data source in your Kubernetes cluster.
Expand All @@ -29,7 +29,7 @@ Each has plugins but it is difficult to maintain them,
especially if you are using multiple tools,
and multiple observability platforms,
and multiple instances of some tools or observability platforms.
The Custom Keptn metrics feature unites all these metrics
The Keptn metrics feature unites all these metrics
integrates metrics from all these sources into a single set of metrics.

## Using this exercise
Expand All @@ -48,11 +48,11 @@ series.
After completing this exercise,
you may want to do the other exercises:

- In [Standardize observability](usecase-observability.md),
- In [Standardize observability](../intro/usecase-observability.md),
you learn how to standardize access
to the observability data for your cluster.
- In
[Manage release lifecycle](usecase-orchestrate.md),
[Manage release lifecycle](../intro/usecase-orchestrate.md),
you learn how to implement
pre- and post-deployment tasks and evaluations
to orchestrate the flow of all the `workloads`
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/implementing/evaluatemetrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ or another standard dashboard application that you configure
or can be retrieved using standard Kubernetes commands.

For an introduction to Keptn metrics, see
[Getting started with Keptn metrics](../intro/usecase_metrics.md).
[Getting started with Keptn metrics](../getting-started/usecase_metrics.md).

## Keptn metric basics

Expand Down
14 changes: 7 additions & 7 deletions docs/content/en/docs/intro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ simplifying configuration and integration into a single set of metrics.

To learn more, see:

* [Custom Keptn metrics](usecase_metrics.md)
* [Keptn metrics](../getting-started/usecase_metrics.md) getting started guide
* [Keptn Metrics](../implementing/evaluatemetrics.md) guide

## Observability
Expand Down Expand Up @@ -86,7 +86,7 @@ to ensure that your deployments are observable.

To learn more, see:

* [Getting started with Keptn Observability](../getting-started)
* [Getting started with Keptn Observability](../getting-started/observability)
* [Standardize observability](usecase-observability.md/)
* [DORA metrics](../implementing/dora) guide
* [OpenTelemetry observability](../implementing/otel.md) guide
Expand Down Expand Up @@ -134,15 +134,15 @@ or a
which is a single, cohesive unit that groups multiple workloads.
For more information, see:

* [Keptn tasks](../implementing/tasks)
* [Evaluations](../implementing/evaluations.md)
* [Keptn tasks](../implementing/tasks) guide
* [Evaluations](../implementing/evaluations.md) guide
* [KeptnApp and KeptnWorkflow resources](../architecture/keptn-apps)

## Next steps

To learn more, see:

* [Getting started with release lifecycle management](../tutorials/tasks/)
* [Getting started with release lifecycle management](../getting-started/tasks/)
* [Manage release lifecycle](usecase-orchestrate.md)
* [Deployment tasks](../implementing/tasks)
* [Evaluations](../implementing/evaluations.md)
* [Deployment tasks](../implementing/tasks) guide
* [Evaluations](../implementing/evaluations.md) guide
4 changes: 2 additions & 2 deletions docs/content/en/docs/intro/usecase-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This is the second of three exercises in the
series:

- In the
[Getting started with Keptn metrics](usecase_metrics.md)
[Getting started with Keptn metrics](../getting-started/usecase_metrics.md)
exercise, you learn how to define and use Keptn metrics.
You may want to complete that exercise before doing this exercise
although that is not required.
Expand Down Expand Up @@ -116,7 +116,7 @@ which allows you to trace everything done in the context of that deployment.
You can supplement the DORA Metrics and OpenTelemetry information
with information you explicitly define using Keptn metrics.
The
[Getting started with Keptn metrics](usecase_metrics.md)
[Getting started with Keptn metrics](../getting-started/usecase_metrics.md)
exercise discusses how to define Keptn metrics.

## View the results
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/intro/usecase-orchestrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ and can do the following:
* Validate any Keptn metric,
either pre- or post-deployment,
using the metrics from the Keptn Metrics Server introduced in
[Getting started with Keptn metrics](usecase_metrics.md).
[Getting started with Keptn metrics](../getting-started/usecase_metrics.md).

This means that you can be sure that the environment is healthy
and has adequate resources before you begin the deployment.
Expand Down Expand Up @@ -62,7 +62,7 @@ You may want to complete the other exercises before doing this exercise
although that is not required:

* In the
[Getting started with Keptn metrics](usecase_metrics.md)
[Getting started with Keptn metrics](../getting-started/usecase_metrics.md)
exercise, you learn how to define and use Keptn metrics.
* In [Standardize observability](usecase-observability.md),
you learn how to standardize access
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,5 +156,5 @@ spec:
* [KeptnEvaluationDefinition](evaluationdefinition.md)
* [KeptnMetricsProvider](metricsprovider.md)
* Implementing [Keptn Metrics](../implementing/evaluatemetrics.md)
* [Getting started with Keptn metrics](../intro/usecase_metrics.md)
* [Getting started with Keptn metrics](../getting-started/usecase_metrics.md)
* Architecture of the [Keptn Metrics Operator](../architecture/components/metrics-operator/_index.md)