Skip to content

Commit

Permalink
some fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Giovanni Liva <[email protected]>
  • Loading branch information
thisthat committed Nov 30, 2023
1 parent 3f85d53 commit 51dec50
Show file tree
Hide file tree
Showing 14 changed files with 19 additions and 19 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
[Architecture](../../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.
Expand All @@ -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)
[Architecture](../../components/index.md)
documentation:

* Three Kubernetes operators
Expand All @@ -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

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs-new/docs/getting-started/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs-new/docs/installation/configuration/cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
4 changes: 2 additions & 2 deletions docs-new/docs/installation/configuration/vcluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

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.
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:
Expand Down
6 changes: 3 additions & 3 deletions docs-new/docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -228,7 +228,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).
Expand Down
2 changes: 1 addition & 1 deletion docs-new/docs/reference/crd-reference/metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 51dec50

Please sign in to comment.