Skip to content

Commit

Permalink
docs: fix typos and grammar issues (#1925)
Browse files Browse the repository at this point in the history
  • Loading branch information
mowies committed Aug 23, 2023
1 parent 44074a2 commit 5570d55
Show file tree
Hide file tree
Showing 29 changed files with 53 additions and 61 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 300
---

Before using the **Keptn Lifecycle Toolkit**
as a contributor to the Kepth Lifecycle Toolkit repository,
as a contributor to the Keptn Lifecycle Toolkit repository,
it is expected that you comply with the guidelines while
making contributions towards the repository.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ As an example, the metadata section for the *Concepts* section of the documentat
```yaml
title: Concepts
description: Learn about underlying concepts of the keptn lifecycle toolkit.
icon: concepts
layout: quickstart
weight: 50
```
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/contribute/general/technologies/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ please submit an issue.
* [ ] [Philosophy](https://youtu.be/ZuIQurh_kDk)
* [ ] [Kubernetes Deconstructed: Understanding Kubernetes by Breaking It Down](https://www.youtube.com/watch?v=90kZRyPcRZw)
* **CRD**
* [ ] [Custom Resouce Definition (CRD)](https://www.youtube.com/watch?v=xGafiZEX0YA)
* [ ] [Custom Resource Definition (CRD)](https://www.youtube.com/watch?v=xGafiZEX0YA)
* [ ] [Kubernetes Operator simply explained in 10 mins](https://www.youtube.com/watch?v=ha3LjlD6g7g)
* [ ] [Writing Kubernetes Controllers for CRDs](https://www.youtube.com/watch?v=7wdUa4Ulwxg)
* **Kube-builder Tutorial**
Expand Down
1 change: 0 additions & 1 deletion docs/content/en/docs/concepts/architecture/cert-manager.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Keptn Certificate Manager
description: Learn how the cert-manager works
icon: concepts
layout: quickstart
weight: 100
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ all your metrics data, regardless of its source,
so you can use multiple instances of multiple observability platforms.

Keptn metrics are integrated with the Kubernetes
[Custom Metrics API](https://github.com/kubernetes/metrics#custom-metrics-api)
[Custom Metrics API](https://github.com/kubernetes/metrics#custom-metrics-api),
so they are compatible with the Kubernetes
[HorizontalPodAutoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
(HPA), which enables the horizontal scaling of workloads
Expand Down Expand Up @@ -52,7 +52,7 @@ where external monitoring and alerting tools can scrape them.
It is an important component of the metrics operator
as it allows for the collection and exposure of custom metrics,
which can be used to gain insight into the behavior and performance
of applications running on a Kubenetes cluster.
of applications running on a Kubernetes cluster.

The **Metrics controller** fetches metrics from an SLI provider.
The controller reconciles a [`KeptnMetric`](../../../../yaml-crd-ref/metric.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,11 @@ KLT automatically generates appropriate
[KeptnApp](../../../yaml-crd-ref/app.md)
resources that are used for observability,
based on whether the `keptn.sh/app` or `app.kubernetes.io/part-of`
annotation/label is poulated:
annotation/label is populated:
resource for each defined group.
that together constitute a single deployable Keptn Application.

* If either of these labels/allotations are populated,
* If either of these labels/annotations are populated,
KLT automatically generates a `KeptnApp` resource
that includes all workloads that have the same annotation/label,
thus creating a `KeptnApp` resource for each defined grouping
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefiniton |
| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefinition |
| `status` _KeptnState_ | |
| `name` _string_ | Name is the name of the Evaluation/Task |
| `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | |
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `name` _string_ | Name is the name of the referenced KeptnTaksDefinition. |
| `name` _string_ | Name is the name of the referenced KeptnTaskDefinition. |


#### FunctionStatus
Expand Down Expand Up @@ -169,7 +169,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefiniton |
| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefinition |
| `status` _KeptnState_ | |
| `name` _string_ | Name is the name of the Evaluation/Task |
| `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | StartTime represents the time at which the Item (Evaluation/Task) started. |
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,15 +263,15 @@ These metrics can then be visualised in Grafana.
For example:

- `keptn_app_active` tracks the number of applications that Keptn manages
- `keptn_deployment_active` tracks the currently live number of deployments occuring.
- `keptn_deployment_active` tracks the currently live number of deployments occurring.
Expect this metric to be `0` when everything is currently deployed.
It will occasionally rise to `n` during deployments and then fall back to `0` when deployments are completed.

There are many other Keptn metrics.

## Step 7: Make DORA metrics more user friendly

It is much more user friendly to provide dashboards for metrics, logs and traces.
It is much more user-friendly to provide dashboards for metrics, logs and traces.
So let's install new Observability components to help us:

- [Cert manager](https://cert-manager.io): Jaeger requires cert-manager
Expand Down
1 change: 0 additions & 1 deletion docs/content/en/docs/implementing/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Implementing Keptn applications
description: Learn how to implement your KLT application
icon: concepts
layout: quickstart
weight: 40
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To get this working, we need to modify our application manifest with two things:

### TL;DR

You can also used the prepared manifest and apply it directly using: `kubectl apply -k sample-app/version-2/` and
You can also use the prepared manifest and apply it directly using: `kubectl apply -k sample-app/version-2/` and
proceed [here](#watch-application-behavior).

---
Expand Down
13 changes: 6 additions & 7 deletions docs/content/en/docs/implementing/integrate/_index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: Integrate KLT with your applications
description: How to integrate the Keptn Lifecycle Toolkit into your Kubernetes cluster
icon: concepts
layout: quickstart
weight: 45
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

The Keptn Lifecycle Toolkit works
on top of the default scheduler for the cluster
on top of the default scheduler for the cluster,
so it can trace all activities of all deployment workloads on the cluster,
no matter what tool is used for the deployment.
This same mechanism allows KLT to inject pre- and post-deployment checks
Expand Down Expand Up @@ -78,7 +77,7 @@ keptn.sh/version: myAwesomeWorkloadVersion
keptn.sh/app: myAwesomeAppName
```

Alternatively, you can use Kubernete keys for annotations or labels.
Alternatively, you can use Kubernetes keys for annotations or labels.
These are part of the Kubernetes
[Recommended Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/):

Expand Down Expand Up @@ -166,8 +165,8 @@ In general, annotations are more appropriate than labels
for integrating KLT with your applications
because they store references, names, and version information
so the 63 char limitation is quite restrictive.
However labels can be used if you specifically need them
and can accomodate the size restriction.
However, labels can be used if you specifically need them
and can accommodate the size restriction.

## Pre- and post-deployment checks

Expand Down Expand Up @@ -201,7 +200,7 @@ do the following:
[Working with Keptn tasks](../tasks)
for more information.
* Annotate your [Workloads](https://kubernetes.io/docs/concepts/workloads/)
([Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/),
[Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/),
[StatefulSets](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/),
and
[DaemonSets](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/)
Expand Down Expand Up @@ -242,7 +241,7 @@ The deployment is kept in a pending state
until the infrastructure is capable of accepting deployments again.

If everything is fine, the deployment continues and afterward,
a slack notification is sent with the result of the deployment
a Slack notification is sent with the result of the deployment

## Use Keptn automatic app discovery

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/implementing/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ kubectl apply -f config/prometheus/

### Integrate OpenTelemetry into the Keptn Lifecycle Toolkit

To integrate OpenTelementry into the Keptn Lifecycle Toolkit:
To integrate OpenTelemetry into the Keptn Lifecycle Toolkit:

- Apply
[basic annotations](../implementing/integrate/#basic-annotations)
Expand All @@ -138,7 +138,7 @@ To integrate OpenTelementry into the Keptn Lifecycle Toolkit:

The
[otel-collector.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/examples/support/observability/config/otel-collector.yaml)
is the OpenTelementry manifest file for the PodtatoHead example,
is the OpenTelemetry manifest file for the PodtatoHead example,
located in the `config` directory.
To deploy and configure the OpenTelemetry collector
using this manifest, the command is:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Restart an Application Deployment
description: Learn how to restart an unsuccessful Keptn Application Deployment.
icon: concepts
layout: quickstart
weight: 100
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
Expand Down
5 changes: 2 additions & 3 deletions docs/content/en/docs/implementing/tasks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ defines the runner to use for the container:
that you define to includes a runtime, an application
and its runtime dependencies.
This gives you the greatest flexibility
to define tasks using the lanugage and facilities of your choice
to define tasks using the language and facilities of your choice

KLT also includes two "pre-defined" runners:

Expand Down Expand Up @@ -212,8 +212,7 @@ spec:

### Pass secrets to a function

Kubernetes
[secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
[Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
can be passed to the function
using the `secureParameters` field.

Expand Down
1 change: 0 additions & 1 deletion docs/content/en/docs/install/k8s.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Kubernetes cluster
description: Bring or install a Kubernetes cluster
icon: concepts
layout: quickstart
weight: 25
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
Expand Down
3 changes: 1 addition & 2 deletions docs/content/en/docs/install/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Upgrade
description: How to upgrade to the latest version of the Lifecycle Toolkit
icon: concepts
layout: quickstart
weight: 45
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
Expand All @@ -19,7 +18,7 @@ helm upgrade --install keptn klt/klt \
```

Use the `--set` flag or download and edit the `values.yaml` file
to modify the configuration as discused on the
to modify the configuration as discussed on the
[Install the Lifecycle Toolkit](../install/) page.

> **Warning**
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/intro-klt/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 20
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

This section contains tutorials on how to use the Keptn Lifecyle Toolkit.
This section contains tutorials on how to use the Keptn Lifecycle Toolkit.

When you understand the toolkit, begin with the [getting started guide](../getting-started/).

Expand Down Expand Up @@ -148,7 +148,7 @@ the Keptn Lifecycle Toolkit:
and the concepts that drive the Keptn Lifecycle Toolkit,
then gives a simple demonstration of a Keptn Lifecycle Controller implementation.

* [Introducing Keptn Lifecyle Toolkit](https://youtu.be/449HAFYkUlY)
* [Introducing Keptn Lifecycle Toolkit](https://youtu.be/449HAFYkUlY)
gives an overview of what KLT does and how to implement it.

* [Keptn Lifecycle Toolkit Demo Tutorial on k3s, with ArgoCD for GitOps, OTel, Prometheus and Grafana](https://www.youtube.com/watch?v=6J_RzpmXoCc)
Expand Down
8 changes: 4 additions & 4 deletions docs/content/en/docs/intro-klt/usecase-orchestrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: How KLT orchestrates pre- and post-deployment evaluations and tasks
weight: 20
---

In this exercise, we will configure the Keptn Lifecyle Toolkit
In this exercise, we will configure the Keptn Lifecycle Toolkit
to run deployment checks as part of your deployment.
Whether you are deploying your software with
Argo, Flux, another deployment engine, or even `kubectl apply`,
Expand All @@ -13,7 +13,7 @@ the Lifecycle Toolkit can do the following:
* Pre-deploy: Validate external dependencies,
confirm that images are scanned, and so forth

* Post-deply: Execute tests, notify stakeholders,
* Post-deploy: Execute tests, notify stakeholders,
promote to the next stage

* Automatically validate against your SLO (Service Level Objectives)
Expand Down Expand Up @@ -89,7 +89,7 @@ you need to do the following:

An `evaluation` is a KeptnMetric that has a defined target value.
Evaluations are resources that are defined in a
[KeptinEvaluationDefinition](../yaml-crd-ref/evaluationdefinition.md)
[KeptnEvaluationDefinition](../yaml-crd-ref/evaluationdefinition.md)
yaml file.
In our example, evaluations are defined in the
[keptn-evaluations.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-evaluations.yaml)
Expand Down Expand Up @@ -127,7 +127,7 @@ In our example, the tasks are defined in the
[keptn-tasks.yaml](https://github.com/keptn-sandbox/klt-on-k3s-with-argocd/blob/main/simplenode-dev/keptn-tasks.yaml)
file.
As an example,
we have a `notify` task that composes some markdown text
we have a `notify` task that composes some Markdown text
to be sent as Slack notifications
The `KeptnTaskDefinition` looks like this:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/intro-klt/usecase_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ metadata:
spec:
type: dynatrace
targetServer: "https://hci34192.live.dynatrace.com"
secretKeyRef
secretKeyRef:
name: dynatrace
key: DT_TOKEN
...
Expand Down
12 changes: 6 additions & 6 deletions docs/content/en/docs/migrate/strategy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Some key points:
using Kubernetes capabilities.

* KLT provides extensive observability data
using OpenTelementry and Prometheus
using OpenTelemetry and Prometheus
rather than storing the data in a special Keptn database.
This data can be displayed using Grafana and Jaeger
or the dashboard of your choice.
Expand Down Expand Up @@ -151,7 +151,7 @@ For example:
a `KeptnTask` using the `container-runner`.
* A Keptn v1 service that runs a database
can probably be translated
into a Kubenetes `StateFulSet` workload; see
into a Kubernetes `StateFulSet` workload; see
[Workload Resources](https://kubernetes.io/docs/concepts/workloads/controllers/)
for more information.
* A Keptn v1 service that runs a webserver
Expand Down Expand Up @@ -273,7 +273,7 @@ When migrating to KLT, you need to define a
[KeptnMetricsProvider](../../yaml-crd-ref/metricsprovider.md)
resource for the data provider(s) you are using.
Note that KLT allows you to support multiple data providers
and multiple instances of each data provider for your SLI's
and multiple instances of each data provider for your SLIs
whereas Keptn v1 only allows you to use one SLI per project.

The queries defined for the Keptn v1 SLIs
Expand All @@ -286,7 +286,7 @@ resources.
KLT at this time does not support the full range
of Quality Gates evaluations that are represented by
[SLOs](https://keptn.sh/docs/1.0.x/reference/files/slo/).
Facilities such as weighting of SLI's and scoring of the evaluation
Facilities such as weighting of SLIs and scoring of the evaluation
do not currently exist.
This functionality is under development; see
[Epic 1646](https://github.com/keptn/lifecycle-toolkit/issues/1646).
Expand All @@ -299,7 +299,7 @@ resources.

KLT does not currently support the same level of
[remediations](https://keptn.sh/docs/1.0.x/reference/files/remediation/)
as Keptn v1 does
as Keptn v1 does,
but it does provide limited "Day 2" facilities:

* Any query that is possible for your data provider post-deployment
Expand All @@ -309,7 +309,7 @@ but it does provide limited "Day 2" facilities:
* `KeptnMetricsDefinition` resources can be retrieved and used
to implement the Kubernetes HorizontalPodAutoscaler (HPA),
which can detect the need for additional resources
(more pods, memory, disk space, etc)
(more pods, memory, disk space, etc.)
and automatically add those resources to your configuration
based on the `ReplicaSet` resources you have defined.
See
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ to get further information refer to this [issue](https://github.com/keptn/lifecy

## I cannot see DORA metrics or OpenTelemetry traces

KLT will automatically generate DORA metrics and Otel traces for every deployment, but
KLT will automatically generate DORA metrics and OTel traces for every deployment, but
by default it does not know where to send them.

You need an OpenTelemetry collector
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/tutorials/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ weight: 40
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

This section contains tutorials on how to use the Keptn Lifecyle Toolkit.
This section contains tutorials on how to use the Keptn Lifecycle Toolkit.

Begin with the [getting started guide](../getting-started/) first, then come back here to complete these tutorials.
2 changes: 1 addition & 1 deletion docs/content/en/docs/yaml-crd-ref/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ The Keptn Lifecycle Toolkit adds the concept of applications
defined as a set of workloads that can be executed.
A `KeptnApp` resource is added
into the repository of the deployment engine
(ArgoCD, Flux, etc)
(ArgoCD, Flux, etc.)
and is then deployed by that deployment engine.

A `KeptnApp` resource is created automatically, using the
Expand Down
Loading

0 comments on commit 5570d55

Please sign in to comment.