From afc9f7038a40970c9b02c68a4df15991c6c8ee2a Mon Sep 17 00:00:00 2001 From: Alexander Mnich <56564725+a-mnich@users.noreply.github.com> Date: Tue, 10 Dec 2024 08:32:26 +0100 Subject: [PATCH] fix typos (#58) Signed-off-by: Alexander Mnich <56564725+a-mnich@users.noreply.github.com> --- docs/blog/posts/2024/containerssh-0.5.md | 2 +- docs/getting-started/configuration.md | 2 +- docs/reference/auth-oauth2.md | 2 +- docs/reference/index.md | 2 +- docs/reference/installation.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/blog/posts/2024/containerssh-0.5.md b/docs/blog/posts/2024/containerssh-0.5.md index b5b8e1637..42890e242 100644 --- a/docs/blog/posts/2024/containerssh-0.5.md +++ b/docs/blog/posts/2024/containerssh-0.5.md @@ -123,7 +123,7 @@ A new health check service has been created that can be used with Kubernetes or ## Changes to the Prometheus integration -The name of some prometheus metrics and units has been altered to adhere to the convension of the metric name ending with the unit. +The name of some prometheus metrics and units has been altered to adhere to the convention of the metric name ending with the unit. In detail the following metrics have been modified: diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index 1d7e2f5b7..f2460d99e 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -59,7 +59,7 @@ ssh: === "OAuth2" !!! warning "Feature Preview" - OAuth2 support is considered as a feature preview as it doesn't have adequate test coverate + OAuth2 support is considered as a feature preview as it doesn't have adequate test coverage The OAuth2 authentication backend authenticates users using any OIDC-compliant OAuth2 servers for authentication (such as KeyCloak, Microsoft Active Directory Federation Services, etc) and features explicit support for GitHub and GitHub Enterprise. diff --git a/docs/reference/auth-oauth2.md b/docs/reference/auth-oauth2.md index f41669e0c..270e3ec34 100644 --- a/docs/reference/auth-oauth2.md +++ b/docs/reference/auth-oauth2.md @@ -7,7 +7,7 @@ title: OAuth2 authentication | OAuth2 backend | :material-close: | :material-close: | :material-check-bold: | :material-close: | !!! warning "Feature Preview" - OAuth2 support is considered as a feature preview as it doesn't have adequate test coverate + OAuth2 support is considered as a feature preview as it doesn't have adequate test coverage The OAuth2 authentication backend authenticates users using any OIDC-compliant OAuth2 servers for authentication (such as KeyCloak, Microsoft Active Directory Federation Services, etc) and features explicit support for GitHub and GitHub Enterprise. Authentication is done using the `keyboard-interactive` SSH authentication mechanism which is supported by most, but not all, SSH clients. diff --git a/docs/reference/index.md b/docs/reference/index.md index e542cf43b..97e0b3443 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -122,7 +122,7 @@ A new health check service has been created that can be used with Kubernetes or ## Changes to the Prometheus integration -The name of some prometheus metrics and units has been altered to adhere to the convension of the metric name ending with the unit. +The name of some prometheus metrics and units has been altered to adhere to the convention of the metric name ending with the unit. In detail the following metrics have been modified: diff --git a/docs/reference/installation.md b/docs/reference/installation.md index 8975e1c2a..b2ec0ac23 100644 --- a/docs/reference/installation.md +++ b/docs/reference/installation.md @@ -59,7 +59,7 @@ === "Kubernetes" - When running ContainerSSH inside a Kubernetes cluster you must furst create a `Secret` that contains the host key. + When running ContainerSSH inside a Kubernetes cluster you must first create a `Secret` that contains the host key. ```bash openssl genrsa | kubectl create secret generic containerssh-hostkey --from-file=host.key=/dev/stdin