From 445abf3bfd581bf87d4809a7c470bf866874c25d Mon Sep 17 00:00:00 2001 From: Yash Pimple <97302447+YashPimple@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:42:46 +0530 Subject: [PATCH] docs: improve guide page section (#3170) Signed-off-by: Yash Pimple Signed-off-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Co-authored-by: Florian Bacher --- docs/docs/guides/dora.md | 2 +- docs/docs/guides/evaluations.md | 2 +- docs/docs/guides/index.md | 40 +++++++++++++++++++++++++++++++++ docs/docs/guides/metadata.md | 2 +- docs/docs/guides/otel.md | 2 +- docs/docs/guides/slo.md | 2 +- docs/docs/guides/tasks.md | 2 +- mkdocs.yml | 12 +++++----- 8 files changed, 52 insertions(+), 12 deletions(-) diff --git a/docs/docs/guides/dora.md b/docs/docs/guides/dora.md index dd4ba3bdfe..57707ada40 100644 --- a/docs/docs/guides/dora.md +++ b/docs/docs/guides/dora.md @@ -2,7 +2,7 @@ comments: true --- -# DORA metrics +# DORA Metrics DORA metrics are an industry-standard set of measurements that are included in Keptn; diff --git a/docs/docs/guides/evaluations.md b/docs/docs/guides/evaluations.md index 0ca5becad2..b9d09d8245 100644 --- a/docs/docs/guides/evaluations.md +++ b/docs/docs/guides/evaluations.md @@ -2,7 +2,7 @@ comments: true --- -# Evaluations +# Evaluations in Keptn A `KeptnEvaluation` does a simple evaluation of the metrics data you capture, to answer a question such as "Do I have more than four CPUs available?" diff --git a/docs/docs/guides/index.md b/docs/docs/guides/index.md index 07e2fa769d..8ae8516430 100644 --- a/docs/docs/guides/index.md +++ b/docs/docs/guides/index.md @@ -5,3 +5,43 @@ comments: true # Guides This section provides comprehensive guides about specific features of Keptn. + +## Metrics + +- [Keptn Metrics](evaluatemetrics.md) - Explore metrics tracking and monitoring capabilities +in Keptn. +- [DORA Metrics](dora.md) - Elevate deployment efficiency with key measurements like frequency +and lead time, seamlessly managed and monitored within Keptn. + +## Observability + +- [OpenTelemetry Observability](otel.md) - Achieve end-to-end traceability and observability +in Kubernetes deployments. +- [Context Metadata](metadata.md) - Understand how to enhance traceability and context +awareness by adding metadata to applications, workloads, and tasks. + +## Deployment Tasks + +- [Deployment Tasks with Keptn](tasks.md) - Understand Deployment Tasks in Keptn, including pre and +post-deployment tasks, to automate and streamline your deployment processes. +- [Redeploy/Restart an Application](restart-application-deployment.md) - Learn how to redeploy +or restart applications using Keptn. + +## Analysis + +- [Analysis with Keptn](slo.md) - Validate your deployments with Keptn Analysis using SLIs and SLOs. +- [Evaluations in Keptn](evaluations.md) - Discover how Keptn conducts evaluations to assess the +performance and quality of your deployments. + +## Auto App Discovery + +- [Auto App Discovery](auto-app-discovery.md) - Learn how Keptn automates workload aggregation +with Auto App Discovery +- [Integrate Keptn with Your Applications](integrate.md) - Guide on integrating Keptn with +your applications for streamlined deployment and monitoring. + +## Multi-Stage Application Delivery + +- [Multi-Stage Application Delivery](multi-stage-application-delivery.md) - Discover how to +deploy applications across multiple stages with Keptn, ensuring consistency and reliability +across different environments. diff --git a/docs/docs/guides/metadata.md b/docs/docs/guides/metadata.md index 972584e91d..6e0e9afdd4 100644 --- a/docs/docs/guides/metadata.md +++ b/docs/docs/guides/metadata.md @@ -2,7 +2,7 @@ comments: true --- -# Context metadata +# Context Metadata This guide walks you through the usage of context metadata in Keptn. diff --git a/docs/docs/guides/otel.md b/docs/docs/guides/otel.md index b469de55c4..6736a03cf5 100644 --- a/docs/docs/guides/otel.md +++ b/docs/docs/guides/otel.md @@ -2,7 +2,7 @@ comments: true --- -# OpenTelemetry observability +# OpenTelemetry Observability Keptn makes any Kubernetes deployment observable. In other words, it creates a distributed, end-to-end trace diff --git a/docs/docs/guides/slo.md b/docs/docs/guides/slo.md index 88edc5e91c..bc7c96a32f 100644 --- a/docs/docs/guides/slo.md +++ b/docs/docs/guides/slo.md @@ -2,7 +2,7 @@ comments: true --- -# Analysis +# Analysis with Keptn The Keptn Metrics Operator Analysis feature allows you to validate a deployment or release diff --git a/docs/docs/guides/tasks.md b/docs/docs/guides/tasks.md index b4ada46366..e85eea3b0d 100644 --- a/docs/docs/guides/tasks.md +++ b/docs/docs/guides/tasks.md @@ -2,7 +2,7 @@ comments: true --- -# Deployment tasks +# Deployment Tasks with Keptn A [KeptnTaskDefinition](../reference/crd-reference/taskdefinition.md) diff --git a/mkdocs.yml b/mkdocs.yml index d8711336da..f03d37daf1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -136,13 +136,13 @@ nav: - Auto app discovery: docs/guides/auto-app-discovery.md - Integrate Keptn with your Applications: docs/guides/integrate.md - Keptn Metrics: docs/guides/evaluatemetrics.md - - Analysis: docs/guides/slo.md - - Deployment tasks: docs/guides/tasks.md + - Analysis with Keptn: docs/guides/slo.md + - Deployment Tasks with Keptn: docs/guides/tasks.md - Redeploy/Restart an Application: docs/guides/restart-application-deployment.md - - Evaluations: docs/guides/evaluations.md - - DORA metrics: docs/guides/dora.md - - OpenTelemetry observability: docs/guides/otel.md - - Context metadata: docs/guides/metadata.md + - Evaluations in Keptn: docs/guides/evaluations.md + - DORA Metrics: docs/guides/dora.md + - OpenTelemetry Observability: docs/guides/otel.md + - Context Metadata: docs/guides/metadata.md - Multi-stage Application delivery: docs/guides/multi-stage-application-delivery.md - Use Cases: - docs/use-cases/index.md