diff --git a/.github/workflows/CI.yaml b/.github/workflows/CI.yaml index 89d818f705..1bfd732079 100644 --- a/.github/workflows/CI.yaml +++ b/.github/workflows/CI.yaml @@ -14,6 +14,7 @@ on: - "docs-new/**" - "**.md" - "netlify.toml" + - "mkdocs.yml" env: GO_VERSION: "~1.20" diff --git a/docs-new/docs/components/scheduling/assets/gate-removed.yaml b/docs-new/docs/components/assets/gate-removed.yaml similarity index 100% rename from docs-new/docs/components/scheduling/assets/gate-removed.yaml rename to docs-new/docs/components/assets/gate-removed.yaml diff --git a/docs-new/docs/components/scheduling/assets/gated.yaml b/docs-new/docs/components/assets/gated.yaml similarity index 100% rename from docs-new/docs/components/scheduling/assets/gated.yaml rename to docs-new/docs/components/assets/gated.yaml diff --git a/docs-new/docs/components/scheduling/assets/scheduler.yaml b/docs-new/docs/components/assets/scheduler.yaml similarity index 100% rename from docs-new/docs/components/scheduling/assets/scheduler.yaml rename to docs-new/docs/components/assets/scheduler.yaml diff --git a/docs-new/docs/components/certificate-operator/index.md b/docs-new/docs/components/certificate-operator.md similarity index 93% rename from docs-new/docs/components/certificate-operator/index.md rename to docs-new/docs/components/certificate-operator.md index cd4b7806ac..ff846acdcc 100644 --- a/docs-new/docs/components/certificate-operator/index.md +++ b/docs-new/docs/components/certificate-operator.md @@ -5,7 +5,7 @@ The Keptn Cert Manager automatically configures TLS certificates to [secure communication with the Kubernetes API](https://kubernetes.io/docs/concepts/security/controlling-access/#transport-security). You can instead -[use cert-manager.io](../../installation/configuration/cert-manager.md) +[use cert-manager.io](../installation/configuration/cert-manager.md) for this purpose. Keptn includes a Mutating Webhook @@ -32,7 +32,7 @@ It is included to simplify installation for new users and because it is much smaller than most standard certificate managers. However, Keptn is compatible with most certificate managers and can be configured to use another certificate manager if you prefer. -See [Use Keptn with cert-manager.io](../../installation/configuration/cert-manager.md) +See [Use Keptn with cert-manager.io](../installation/configuration/cert-manager.md) for instructions. ## Invalid certificate errors diff --git a/docs-new/docs/components/metrics-operator/index.md b/docs-new/docs/components/metrics-operator.md similarity index 89% rename from docs-new/docs/components/metrics-operator/index.md rename to docs-new/docs/components/metrics-operator.md index d9b919067f..b10fd720ee 100644 --- a/docs-new/docs/components/metrics-operator/index.md +++ b/docs-new/docs/components/metrics-operator.md @@ -22,7 +22,7 @@ so they are compatible with the Kubernetes (HPA), which enables the horizontal scaling of workloads based on metrics collected from multiple observability platforms. See -[Using the HorizontalPodAutoscaler](../../use-cases/hpa.md) +[Using the HorizontalPodAutoscaler](../use-cases/hpa.md) for instructions. The Metrics Operator consists of the following components: @@ -49,18 +49,18 @@ which can be used to gain insight into the behavior and performance of applications running on a Kubernetes cluster. The **Metrics controller** fetches metrics from an SLI provider. -The controller reconciles a [`KeptnMetric`](../../reference/crd-reference/metric.md) +The controller reconciles a [`KeptnMetric`](../reference/crd-reference/metric.md) resource and updates its status with the metric value provided by the selected metric provider. Each `KeptnMetric` is identified by `name` and is associated with an instance of an observability platform that is defined in a -[KeptnMetricsProvider](../../reference/crd-reference/metricsprovider.md) +[KeptnMetricsProvider](../reference/crd-reference/metricsprovider.md) resource. The steps in which the controller fetches metrics are given below: -1. When a [`KeptnMetric`](../../reference/crd-reference/metric.md) +1. When a [`KeptnMetric`](../reference/crd-reference/metric.md) resource is found or modified, the controller checks whether the metric has been updated within the interval that is defined in the `spec.fetchintervalseconds` field. @@ -80,7 +80,7 @@ The steps in which the controller fetches metrics are given below: in the `status` field of the `KeptnMetric` object. * If the evaluation fails, the error and reason is written to the - [KeptnMetricStatus](../../reference/api-reference/metrics/v1beta1/index.md#keptnmetricstatus) + [KeptnMetricStatus](../reference/api-reference/metrics/v1beta1/index.md#keptnmetricstatus) resource. The error is described in both human-readable language and as raw data to help identify the source of the problem diff --git a/docs-new/docs/components/scheduling/index.md b/docs-new/docs/components/scheduling.md similarity index 97% rename from docs-new/docs/components/scheduling/index.md rename to docs-new/docs/components/scheduling.md index 294fce3414..48ca50f143 100644 --- a/docs-new/docs/components/scheduling/index.md +++ b/docs-new/docs/components/scheduling.md @@ -26,7 +26,7 @@ to gate Pods until the required deployment checks pass. When a workload is applied to a Kubernetes cluster, the Mutating Webhook checks each Pod for annotations. If -[Keptn specific annotations](../../guides/integrate.md#basic-annotations) +[Keptn specific annotations](../guides/integrate.md#basic-annotations) are present, the Webhook adds a scheduling gate to the Pod called `keptn-prechecks-gate`. This spec tells the Kubernetes scheduling framework @@ -67,7 +67,7 @@ a [Permit plugin](https://kubernetes.io/docs/concepts/scheduling-eviction/schedu ### How does the Keptn Scheduler works Firstly the Mutating Webhook checks for annotations on Pods to see if it is annotated with -[Keptn specific annotations](../../guides/integrate.md#basic-annotations). +[Keptn specific annotations](../guides/integrate.md#basic-annotations). If the annotations are present, the Webhook assigns the **Keptn Scheduler** to the Pod. This ensures that the Keptn Scheduler only gets Pods that have been annotated for it. A Pod `test-pod` modified by the Mutating Webhook looks as follows: diff --git a/docs-new/docs/contribute/docs/contrib-guidelines-docs/index.md b/docs-new/docs/contribute/docs/contrib-guidelines-docs.md similarity index 94% rename from docs-new/docs/contribute/docs/contrib-guidelines-docs/index.md rename to docs-new/docs/contribute/docs/contrib-guidelines-docs.md index 3391288cd2..18ad3e4595 100644 --- a/docs-new/docs/contribute/docs/contrib-guidelines-docs/index.md +++ b/docs-new/docs/contribute/docs/contrib-guidelines-docs.md @@ -1,6 +1,6 @@ # Contribution guidelines for documentation -The [Contribution Guidelines](../../general/contrib-guidelines-gen/index.md) page +The [Contribution Guidelines](../general/contrib-guidelines-gen.md) page contains guidelines that are relevant for both documentation and software contributions. This page lists additional guidelines @@ -86,7 +86,7 @@ that are relevant only to documentation * Always build the documentation locally to check the formatting and verify that all links are working properly. - See [Build Documentation Locally](../local-building/index.md) + See [Build Documentation Locally](./local-building.md) for details. * Always run the following to fix most markdown issues in your PR @@ -96,5 +96,5 @@ that are relevant only to documentation make markdownlint-fix ``` - See [Markdownlint](../linter-requirements/index.md#markdownlint) + See [Markdownlint](./linter-requirements.md#markdownlint) for details. diff --git a/docs-new/docs/contribute/docs/linter-requirements/index.md b/docs-new/docs/contribute/docs/linter-requirements.md similarity index 100% rename from docs-new/docs/contribute/docs/linter-requirements/index.md rename to docs-new/docs/contribute/docs/linter-requirements.md diff --git a/docs-new/docs/contribute/docs/local-building/index.md b/docs-new/docs/contribute/docs/local-building.md similarity index 100% rename from docs-new/docs/contribute/docs/local-building/index.md rename to docs-new/docs/contribute/docs/local-building.md diff --git a/docs-new/docs/contribute/docs/publish/index.md b/docs-new/docs/contribute/docs/publish.md similarity index 100% rename from docs-new/docs/contribute/docs/publish/index.md rename to docs-new/docs/contribute/docs/publish.md diff --git a/docs-new/docs/contribute/docs/source-file-structure/index.md b/docs-new/docs/contribute/docs/source-file-structure.md similarity index 87% rename from docs-new/docs/contribute/docs/source-file-structure/index.md rename to docs-new/docs/contribute/docs/source-file-structure.md index 894230d4cf..ce8cf702f8 100644 --- a/docs-new/docs/contribute/docs/source-file-structure/index.md +++ b/docs-new/docs/contribute/docs/source-file-structure.md @@ -71,7 +71,7 @@ For background information, see: #### API Reference The -[API Reference](../../../reference/api-reference/index.md) +[API Reference](../../reference/api-reference/index.md) pages are autogenerated from the source code. This is a comprehensive list of all APIs and resources Keptn uses, most of which users seldom see. @@ -97,7 +97,7 @@ in the root directory of your `lifecycle-toolkit` clone: #### CRD Reference The -[CRD Reference](../../../reference/crd-reference/index.md) +[CRD Reference](../../reference/crd-reference/index.md) pages describe the YAML files used to populate resources for the small set of CRDs that users must populate themselves. @@ -111,7 +111,7 @@ provide introductory material about how to use various features. A template to use to create a new CRD Reference page is available -[here](../templates/yaml-crd-ref-template.md). +[here](./yaml-crd-ref-template.md). ## Contributing guide @@ -150,20 +150,23 @@ leaving links to the various sections in the *CONTRIBUTING.md* guides. This section discusses how the individual files and directories are assembled into the documentation set. See -[Published Doc Structure](../publish/index.md) +[Published Doc Structure](./publish.md) for information about the branches where the documentation is published. -All files in the directories are built -except for files that are explicitly `ignored` -and files that include the `hidden: true` string in the file's metadata section. +All files in the directories are built. The order in which the files are displayed -is determined by the value of the `weight` field -in the metadata section of *_index.md*, *index.md*, -and *topic.md* files that are located throughout the directory tree. +is determined by their order in the `nav` field +of the `mkdocs.yml` file. -The metadata section of these files contains at least three fields. -As an example, the metadata section for the *Installation and upgrade* section -of the documentation includes the following fields: +## Subdirectory structure -```yaml +Each subdirectory contains topical subdirectories for each chapter in that section. +Each topical subdirectory may contain: + +* An *index.md* file that has the text for the section. + If this is a subdirectory that contains subdirectories for other pages, + the *index.md* file + contains introductory content for the section. +* An *assets* subdirectory where graphical files for that topic are stored. + No *assets* subdirectory is present if the topic has no graphics. diff --git a/docs-new/docs/contribute/docs/word-list/index.md b/docs-new/docs/contribute/docs/word-list.md similarity index 96% rename from docs-new/docs/contribute/docs/word-list/index.md rename to docs-new/docs/contribute/docs/word-list.md index 50cf191042..696c92d76c 100644 --- a/docs-new/docs/contribute/docs/word-list/index.md +++ b/docs-new/docs/contribute/docs/word-list.md @@ -94,10 +94,10 @@ It is important to use the related terminology correctly: Most of the time, we recommend just using the term "resource". * The first occurence of a CRD name in a section should be a link to the - CRD YAML Reference under the right [component](../../../components/index.md) + [CRD YAML Reference](../../reference/crd-reference/index.md) page if there is one. Otherwise, it should be a link to the appropriate spot in the - [API Reference](../../../reference/api-reference/index.md) + [API Reference](../../reference/api-reference/index.md) section. * Occurrences of a resource name that are not links to a reference page diff --git a/docs-new/docs/contribute/docs/templates/yaml-crd-ref-template.md b/docs-new/docs/contribute/docs/yaml-crd-ref-template.md similarity index 100% rename from docs-new/docs/contribute/docs/templates/yaml-crd-ref-template.md rename to docs-new/docs/contribute/docs/yaml-crd-ref-template.md diff --git a/docs-new/docs/contribute/general/codespace/index.md b/docs-new/docs/contribute/general/codespace.md similarity index 100% rename from docs-new/docs/contribute/general/codespace/index.md rename to docs-new/docs/contribute/general/codespace.md diff --git a/docs-new/docs/contribute/general/contrib-guidelines-gen/index.md b/docs-new/docs/contribute/general/contrib-guidelines-gen.md similarity index 95% rename from docs-new/docs/contribute/general/contrib-guidelines-gen/index.md rename to docs-new/docs/contribute/general/contrib-guidelines-gen.md index a837f6ffba..572d436361 100644 --- a/docs-new/docs/contribute/general/contrib-guidelines-gen/index.md +++ b/docs-new/docs/contribute/general/contrib-guidelines-gen.md @@ -7,7 +7,7 @@ making contributions towards the repository. These guidelines are appropriate for both software and documentation. For additional guidelines that are relevant only to documentation, see -[Contribution guidelines for documentation](../../docs/contrib-guidelines-docs/index.md). +[Contribution guidelines for documentation](../docs/contrib-guidelines-docs.md). ## Guidelines for contributing diff --git a/docs-new/docs/contribute/general/dco/index.md b/docs-new/docs/contribute/general/dco.md similarity index 100% rename from docs-new/docs/contribute/general/dco/index.md rename to docs-new/docs/contribute/general/dco.md diff --git a/docs-new/docs/contribute/general/git/branch-create/index.md b/docs-new/docs/contribute/general/git/branch-create.md similarity index 89% rename from docs-new/docs/contribute/general/git/branch-create/index.md rename to docs-new/docs/contribute/general/git/branch-create.md index 598dcb9ded..9153197f19 100644 --- a/docs-new/docs/contribute/general/git/branch-create/index.md +++ b/docs-new/docs/contribute/general/git/branch-create.md @@ -1,7 +1,7 @@ # Create local branch After you -[fork and clone](../fork-clone/index.md) +[fork and clone](./fork-clone.md) the Keptn repository and set `upstream` in your local machine, you need to create a local branch where you will make your changes. @@ -34,7 +34,7 @@ then create a PR to add these changes to the documentation set. or at `localhost:1314/docs-dev` to ensure that it is rendering correctly and that all links are valid.. - See [Build Documentation Locally](../../../docs/local-building/index.md) + See [Build Documentation Locally](../../docs/local-building.md) for more information. * Run `make markdownlint-fix` to check and fix the markdown code. @@ -45,4 +45,4 @@ then create a PR to add these changes to the documentation set. When you have completed the checking and testing of your work, it is time to push your changes and create a PR that can be reviewed. -See [Create PR](../pr-create/index.md) for details. +See [Create PR](./pr-create.md) for details. diff --git a/docs-new/docs/contribute/general/git/fork-clone/index.md b/docs-new/docs/contribute/general/git/fork-clone.md similarity index 97% rename from docs-new/docs/contribute/general/git/fork-clone/index.md rename to docs-new/docs/contribute/general/git/fork-clone.md index f1acf6e31c..cfe6a323ee 100644 --- a/docs-new/docs/contribute/general/git/fork-clone/index.md +++ b/docs-new/docs/contribute/general/git/fork-clone.md @@ -51,5 +51,5 @@ of the Keptn repository on your local machine: ``` You are now ready to -[create a local branch](../branch-create/index.md) +[create a local branch](./branch-create.md) and begin to create the software or documentation modifications. diff --git a/docs-new/docs/contribute/general/git/pr-create/index.md b/docs-new/docs/contribute/general/git/pr-create.md similarity index 98% rename from docs-new/docs/contribute/general/git/pr-create/index.md rename to docs-new/docs/contribute/general/git/pr-create.md index 97c6d4ea65..1eadd15325 100644 --- a/docs-new/docs/contribute/general/git/pr-create/index.md +++ b/docs-new/docs/contribute/general/git/pr-create.md @@ -2,7 +2,7 @@ When you have completed the checking and testing of your work on your local branch as described in -[Create local branch](../branch-create/index.md), +[Create local branch](./branch-create.md), it is time to push your changes and create a PR that can be reviewed. This is a two-step process: @@ -193,4 +193,4 @@ The most common errors for documentation PRs are: When you have resolved all build errors you move into the -[PR review process](../review/index.md). +[PR review process](./review.md). diff --git a/docs-new/docs/contribute/general/git/review/index.md b/docs-new/docs/contribute/general/git/review.md similarity index 98% rename from docs-new/docs/contribute/general/git/review/index.md rename to docs-new/docs/contribute/general/git/review.md index cb980c1d11..fd5679609c 100644 --- a/docs-new/docs/contribute/general/git/review/index.md +++ b/docs-new/docs/contribute/general/git/review.md @@ -1,7 +1,7 @@ # PR review process After you -[create your PR](../pr-create/index.md), +[create your PR](./pr-create.md), your PR must be approved and then merged before it becomes part of the Keptn product. This page discusses what you need to do during the review phase. diff --git a/docs-new/docs/contribute/general/technologies/index.md b/docs-new/docs/contribute/general/technologies.md similarity index 100% rename from docs-new/docs/contribute/general/technologies/index.md rename to docs-new/docs/contribute/general/technologies.md diff --git a/docs-new/docs/contribute/software/dev-environ/index.md b/docs-new/docs/contribute/software/dev-environ.md similarity index 89% rename from docs-new/docs/contribute/software/dev-environ/index.md rename to docs-new/docs/contribute/software/dev-environ.md index ade32b05f2..d683f996d7 100644 --- a/docs-new/docs/contribute/software/dev-environ/index.md +++ b/docs-new/docs/contribute/software/dev-environ.md @@ -23,11 +23,11 @@ To prepare to contribute to the Keptn project, we recommend that you: * [keptn-cert-manager](https://github.com/keptn/lifecycle-toolkit/tree/main/keptn-cert-manager) Each of these is described in the - [Architecture](../../../components/index.md) + [Components](../../components/index.md) section of the documentation and most include a *README* file with more information. * Study the material in - [Technologies and concepts you should know](../../general/technologies/index.md). + [Technologies and concepts you should know](../general/technologies.md). * Create an account for yourself on [GitHub](https://github.com) if you do not already have an account. @@ -39,7 +39,7 @@ When you view the [lifecycle-toolkit](https://github.com/keptn/lifecycle-toolkit) repository, you see that Keptn is composed of multiple components, each of which is discussed in the Architecture -[Architecture](../../../components/index.md) +[Components](../../components/index.md) documentation: * Three Kubernetes operators @@ -53,7 +53,7 @@ you also see the `runtimes` directory. This defines the runners that you can use when defining tasks to be run either pre- or post-deployment. These are discussed in -[Runners and containers](../../../guides/tasks.md#runners-and-containers). +[Runners and containers](../../guides/tasks.md#runners-and-containers). ## Install software @@ -64,13 +64,13 @@ you need to install the following on your system: which allows software applications to run in isolated environments and makes it easier to deploy and manage them. * A Kubernetes cluster running an appropriate version of Kubernetes. - See [Supported Kubernetes versions](../../../installation/index.md#supported-kubernetes-versions) + See [Supported Kubernetes versions](../../installation/index.md#supported-kubernetes-versions) for details. Most contributors create a local Kubernetes-in-Docker(KinD) cluster. This is adequate for developing software for Keptn. See - [Kubernetes cluster](../../../installation/k8s.md#create-local-kubernetes-cluster) + [Kubernetes cluster](../../installation/k8s.md#create-local-kubernetes-cluster) for instructions. * [**kubectl**](https://kubernetes.io/docs/tasks/tools/): a command-line interface tool used for deploying @@ -86,7 +86,7 @@ you need to install the following on your system: ## First steps 1. Follow the instructions in - [Fork and clone the repository](../../general/git/fork-clone/index.md) + [Fork and clone the repository](../general/git/fork-clone.md) to get a local copy of the software. 1. Keptn provides a tool that deploys the development version of the software @@ -114,7 +114,7 @@ you need to install the following on your system: You are now ready to make your changes to the source code. 1. Follow the instructions in - [Create local branch](../../general/git/branch-create/index.md) + [Create local branch](../general/git/branch-create.md) to create a branch for your changes. 1. Make your changes to the appropriate component. @@ -170,8 +170,8 @@ Study these errors, modify your code, and rerun the test until it passes. When all the tests have passed, you can follow the instructions in -[Create PR](../../general/git/pr-create/index.md) +[Create PR](../general/git/pr-create.md) to create your PR. Be sure to monitor your PR as discussed in -[PR review process](../../general/git/review/index.md) +[PR review process](../general/git/review.md) until it is merged. diff --git a/docs-new/docs/getting-started/metrics.md b/docs-new/docs/getting-started/metrics.md index 24b600c526..e75330ee26 100644 --- a/docs-new/docs/getting-started/metrics.md +++ b/docs-new/docs/getting-started/metrics.md @@ -281,6 +281,6 @@ for detailed information. To learn more about the Keptn Metrics Server, see: - Architecture: - [Keptn Metrics Operator](../components/metrics-operator/index.md) + [Keptn Metrics Operator](../components/metrics-operator.md) - More information about implementing Keptn Metrics: [Keptn Metrics](../guides/evaluatemetrics.md) diff --git a/docs-new/docs/installation/configuration/cert-manager.md b/docs-new/docs/installation/configuration/cert-manager.md index af8cd65785..485efb7d69 100644 --- a/docs-new/docs/installation/configuration/cert-manager.md +++ b/docs-new/docs/installation/configuration/cert-manager.md @@ -7,7 +7,7 @@ Bundling the cert-manager simplifies the installation for new users and provides the functionality Keptn needs without the overhead of other cert-managers. For a description of the architecture, see -[Keptn Certificate Manager](../../components/certificate-operator/index.md). +[Keptn Certificate Manager](../../components/certificate-operator.md). Keptn also works well with `cert-manager.io`. If you are already using `cert-manager.io`, diff --git a/docs-new/docs/installation/configuration/vcluster.md b/docs-new/docs/installation/configuration/vcluster.md index 544ec5153f..90efe54a82 100644 --- a/docs-new/docs/installation/configuration/vcluster.md +++ b/docs-new/docs/installation/configuration/vcluster.md @@ -2,7 +2,7 @@ Keptn running on Kubernetes versions 1.26 and older uses a custom -[scheduler](../../components/scheduling/index.md), +[scheduler](../../components/scheduling.md), so it does not work with [Virtual Kubernetes Clusters](https://www.vcluster.com/) ("vClusters") out of the box. @@ -10,7 +10,7 @@ This is also an issue if the `lifecycleOperator.schedulingGatesEnabled` Helm value is set to `false` for Kubernetes version 1.27 and later. See -[Keptn integration with Scheduling](../../components/scheduling/index.md) +[Keptn integration with Scheduling](../../components/scheduling.md) for details. To solve this problem: diff --git a/docs-new/docs/installation/index.md b/docs-new/docs/installation/index.md index 734398724e..aa91b77562 100644 --- a/docs-new/docs/installation/index.md +++ b/docs-new/docs/installation/index.md @@ -40,7 +40,7 @@ implemented using [Kubernetes scheduling gates](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-scheduling-readiness/), unless the `schedulingGatesEnabled` Helm value is set to `false`. See -[Keptn integration with Scheduling](../components/scheduling/index.md) +[Keptn integration with Scheduling](../components/scheduling.md) for details. If Keptn is installed on a [vCluster](https://www.vcluster.com/) with @@ -142,7 +142,7 @@ The following table summarizes the Keptn `values.yaml` files. | [Keptn](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/README.md) | Installs subcharts, global configuration | [keptn/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/values.yaml) | | [lifecycle-operator](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-lifecycle-operator/README.md) | [Observability](../guides/otel.md), [Release Lifecycle Management](../core-concepts/index.md#release-lifecycle-management) | [keptn-lifecycle-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-lifecycle-operator/values.yaml) | | [metrics-operator](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/README.md) | [Keptn metrics](../guides/evaluatemetrics.md), [Analysis](../guides/slo.md) | [keptn-metrics-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/values.yaml) | -| [cert-manager](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md) | [TLS Certificate management for all Keptn components](../components/certificate-operator/index.md) | [keptn-cert-manager/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/values.yaml) | +| [cert-manager](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md) | [TLS Certificate management for all Keptn components](../components/certificate-operator.md) | [keptn-cert-manager/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/values.yaml) | ## Customizing the configuration of components @@ -230,7 +230,7 @@ you can disable Keptn `cert-manager` by setting the {% include "./assets/values-remove-certmanager.yaml" %} For more information on using `cert-manager` with Keptn, see -[Use Keptn with cert-manager.io](../components/certificate-operator/index.md). +[Use Keptn with cert-manager.io](../components/certificate-operator.md). For the full list of Helm values, see the [keptn-cert-manager Helm chart README](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md). diff --git a/docs-new/docs/reference/crd-reference/metric.md b/docs-new/docs/reference/crd-reference/metric.md index fa30d9384f..0eca29020e 100644 --- a/docs-new/docs/reference/crd-reference/metric.md +++ b/docs-new/docs/reference/crd-reference/metric.md @@ -159,4 +159,4 @@ spec: * [KeptnMetricsProvider](metricsprovider.md) * Implementing [Keptn Metrics](../../guides/evaluatemetrics.md) * [Getting started with Keptn metrics](../../getting-started/metrics.md) -* Architecture of the [Keptn Metrics Operator](../../components/metrics-operator/index.md) +* Architecture of the [Keptn Metrics Operator](../../components/metrics-operator.md) diff --git a/mkdocs.yml b/mkdocs.yml index 5820e18417..0356ffc715 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -106,9 +106,9 @@ nav: - docs/components/lifecycle-operator/index.md - Flow of deployment: docs/components/lifecycle-operator/deployment-flow.md - Keptn Applications and Keptn Workloads: docs/components/lifecycle-operator/keptn-apps.md - - Metrics Operator: docs/components/metrics-operator/index.md - - Scheduler and Scheduling Gates: docs/components/scheduling/index.md - - Keptn Certificate Manager: docs/components/certificate-operator/index.md + - Metrics Operator: docs/components/metrics-operator.md + - Scheduler and Scheduling Gates: docs/components/scheduling.md + - Keptn Certificate Manager: docs/components/certificate-operator.md - Reference: - docs/reference/index.md - API Reference: @@ -148,25 +148,25 @@ nav: - docs/contribute/index.md - General information about contributing: - docs/contribute/general/index.md - - Technologies and concepts you should know: docs/contribute/general/technologies/index.md - - Codespaces: docs/contribute/general/codespace/index.md - - DCO: docs/contribute/general/dco/index.md + - Technologies and concepts you should know: docs/contribute/general/technologies.md + - Codespaces: docs/contribute/general/codespace.md + - DCO: docs/contribute/general/dco.md - Working with Git: - docs/contribute/general/git/index.md - - Fork and clone the repository: docs/contribute/general/git/fork-clone/index.md - - Create local branch: docs/contribute/general/git/branch-create/index.md - - Create PR: docs/contribute/general/git/pr-create/index.md - - PR review process: docs/contribute/general/git/review/index.md - - Contribution Guidelines: docs/contribute/general/contrib-guidelines-gen/index.md + - Fork and clone the repository: docs/contribute/general/git/fork-clone.md + - Create local branch: docs/contribute/general/git/branch-create.md + - Create PR: docs/contribute/general/git/pr-create.md + - PR review process: docs/contribute/general/git/review.md + - Contribution Guidelines: docs/contribute/general/contrib-guidelines-gen.md - Software contributions: - docs/contribute/software/index.md - - Software development environment: docs/contribute/software/dev-environ/index.md + - Software development environment: docs/contribute/software/dev-environ.md - Documentation contributions: - docs/contribute/docs/index.md - - CRD name: docs/contribute/docs/templates/yaml-crd-ref-template.md - - Contribution guidelines for documentation: docs/contribute/docs/contrib-guidelines-docs/index.md - - Build Documentation Locally: docs/contribute/docs/local-building/index.md - - Linter Requirements: docs/contribute/docs/linter-requirements/index.md - - Source File Structure: docs/contribute/docs/source-file-structure/index.md - - Published Doc Structure: docs/contribute/docs/publish/index.md - - Word list: docs/contribute/docs/word-list/index.md + - CRD name: docs/contribute/docs/yaml-crd-ref-template.md + - Contribution guidelines for documentation: docs/contribute/docs/contrib-guidelines-docs.md + - Build Documentation Locally: docs/contribute/docs/local-building.md + - Linter Requirements: docs/contribute/docs/linter-requirements.md + - Source File Structure: docs/contribute/docs/source-file-structure.md + - Published Doc Structure: docs/contribute/docs/publish.md + - Word list: docs/contribute/docs/word-list.md