docs: set up structure for yaml ref pages, guide section (#1184)

keptn · Apr 6, 2023 · c164595 · c164595
1 parent 0125462
commit c164595
Show file tree

Hide file tree

Showing 14 changed files with 107 additions and 0 deletions.
diff --git a/docs/content/en/docs/implementing/_index.md b/docs/content/en/docs/implementing/_index.md
@@ -0,0 +1,14 @@
+---
+title: Implementing Keptn applications
+description: Learn how to implement your KLT application
+icon: concepts
+layout: quickstart
+weight: 30
+hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
+---
+
+> **Note**
+This section is under development.
+Information that is published here has been reviewed for technical accuracy
+but the format and content is still evolving.
+We welcome your input!**
diff --git a/docs/content/en/docs/implementing/evaluatemetrics.md b/docs/content/en/docs/implementing/evaluatemetrics.md
@@ -0,0 +1,5 @@
+---
+title: Evaluate metrics
+description: Define all workloads and checks associated with an application
+weight: 130
+---
diff --git a/docs/content/en/docs/implementing/evaluations.md b/docs/content/en/docs/implementing/evaluations.md
@@ -0,0 +1,5 @@
+---
+title: Evaluations
+description: Understand Keptn evaluations and how to use them
+weight: 110
+---
diff --git a/docs/content/en/docs/implementing/observe.md b/docs/content/en/docs/implementing/observe.md
@@ -0,0 +1,5 @@
+---
+title: Implement Observability
+description: Learn how to implement observability in your application
+weight: 80
+---
diff --git a/docs/content/en/docs/implementing/otel.md b/docs/content/en/docs/implementing/otel.md
@@ -0,0 +1,5 @@
+---
+title: Integrating OpenTelemetry
+description: How to integrate OpenTelemetry into your application
+weight: 140
+---
diff --git a/docs/content/en/docs/implementing/slack.md b/docs/content/en/docs/implementing/slack.md
@@ -0,0 +1,5 @@
+---
+title: Implement Slack notifications
+description: Learn how to implement Slack notification as a post-deployment task
+weight: 80
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/_index.md b/docs/content/en/docs/yaml-crd-ref/_index.md
@@ -0,0 +1,33 @@
+---
+title: CRD YAML Reference
+description: Reference pages for the YAML files that define the KLT CRDs
+weight: 100
+hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
+---
+
+This section provides comprehensive reference information about the
+YAML files used to define the Keptn Lifecycle Toolkit
+[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
+that are defined for the Keptn Lifecycle Toolkit.
+
+> **Note**
+This section is under development.
+Information that is published here has been reviewed for technical accuracy
+but the format and content is still evolving.
+We welcome your input!**
+
+Each CRD is an object of an API library.
+Keptn APIs follow the Kubernetes API versioning scheme.
+and are themselves composed of objects and sub-objects.
+By introducing CRDs, Keptn is extending the base Kubernetes API with new objects and functionality.
+Keptn APIs follow API versioning conventions recommended by Kubernetes.
+
+For more information, see the Kubernetes documentation:
+
+* [API Overview](https://kubernetes.io/docs/reference/using-api/)
+
+* [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
+
+* [API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning)
+
+* [Understanding Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/)
diff --git a/docs/content/en/docs/yaml-crd-ref/app.md b/docs/content/en/docs/yaml-crd-ref/app.md
@@ -0,0 +1,5 @@
+---
+title: KeptnApp
+description: Define all workloads and checks associated with an application
+weight: 10
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/config.md b/docs/content/en/docs/yaml-crd-ref/config.md
@@ -0,0 +1,5 @@
+---
+title: KeptnConfig
+description: Define configuration values
+weight: 20
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/evaluationdefnition.md b/docs/content/en/docs/yaml-crd-ref/evaluationdefnition.md
@@ -0,0 +1,5 @@
+---
+title: KeptnEvaluationDefinition
+description: Define all workloads and checks associated with an application
+weight: 20
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/evaluationprovider.md b/docs/content/en/docs/yaml-crd-ref/evaluationprovider.md
@@ -0,0 +1,5 @@
+---
+title: KeptnEvaluationProvider
+description: Define the evaluation provider
+weight: 13
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/metric.md b/docs/content/en/docs/yaml-crd-ref/metric.md
@@ -0,0 +1,5 @@
+---
+title: KeptnMetric
+description: Define all workloads and checks associated with an application
+weight: 50
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/metricsprovider.md b/docs/content/en/docs/yaml-crd-ref/metricsprovider.md
@@ -0,0 +1,5 @@
+---
+title: KeptnMetricsProvider
+description: Define all workloads and checks associated with an application
+weight: 55
+---
diff --git a/docs/content/en/docs/yaml-crd-ref/taskdefinition.md b/docs/content/en/docs/yaml-crd-ref/taskdefinition.md
@@ -0,0 +1,5 @@
+---
+title: KeptnTaskDefinition
+description: Define tasks that can be run pre- or post-deployment
+weight: 89
+---