From 97137ed5f851b602535a162554034a1c8dc425f4 Mon Sep 17 00:00:00 2001 From: "Koshelyev, Serhiy" Date: Wed, 29 May 2024 15:57:59 +0100 Subject: [PATCH] fix(docs): Typos corrected --- docs/book/src/getting-started.md | 6 +++--- docs/book/src/installation.md | 6 +++--- docs/book/src/release.md | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/book/src/getting-started.md b/docs/book/src/getting-started.md index d3cc2817..d7255a63 100644 --- a/docs/book/src/getting-started.md +++ b/docs/book/src/getting-started.md @@ -12,13 +12,13 @@ kconnect help The general workflow for using kconnect is the following: -- `kconnect configure` - import configuration that contains defaults for your origanisation - **1 time** +- `kconnect configure` - import configuration that contains defaults for your organisation - **1 time** - `kconnect use` - connect to a cluster for the first time - **only the first time** - `kconnect to` - use to reconnect to a cluster that you have already connected to - **most used command day-to-day** ## Creating and importing configuration -Before using `kconnect` to connect to a Kubernetes cluster you may want to import an idetitiy provider configuration with your (or your organisations) defaults so that you don't have to supply all connection settings each time you connect to a new cluster. +Before using `kconnect` to connect to a Kubernetes cluster you may want to import an identity provider configuration with your (or your organisations) defaults so that you don't have to supply all connection settings each time you connect to a new cluster. You will need to create a configuration file (see example [here](https://github.com/fidelity/kconnect/blob/main/examples/config.yaml)). The configuration file can be imported from a local file or remote location via HTTP/HTTPS (and from stdin). @@ -64,4 +64,4 @@ kconnect to 01EM615GB2YX3C6WZ9MCWBDWBF Flags can be replaced with environment variables by following the format `UPPERCASED_SNAKE_CASE` and appending to the `KCONNECT_` prefix. -For example`--username`can be set as`KCONNECT_USERNAME`; or `--idp-protocol` as`KCONNECT_IDP_PROTOCOL`. +For example `--username` can be set as `KCONNECT_USERNAME`; or `--idp-protocol` as `KCONNECT_IDP_PROTOCOL`. diff --git a/docs/book/src/installation.md b/docs/book/src/installation.md index ca182d26..dde24313 100644 --- a/docs/book/src/installation.md +++ b/docs/book/src/installation.md @@ -13,7 +13,7 @@ NOTE: `kconnect` requires [az cli](https://github.com/Azure/azure-cli) for interactive authentication to Azure AKS clusters. -NOTE:> For specific tested and pinned versions, use the `install-kconnect.sh` script or the `with-deps` docker image +NOTE:> For specific tested and pinned versions, use the `install-kconnect.sh` script or the `with-deps` docker image ## kubectl plugin @@ -55,7 +55,7 @@ We are working on publishing as a snap. The latest [release](https://github.com/fidelity/kconnect/releases) contains a binary for Windows. -We have an open issue to support chocolatey in the future/ +We have an open issue to support chocolatey in the future. ## Docker @@ -75,4 +75,4 @@ chmod 700 install-kconnect.sh ./install-kconnect.sh ``` -This works on Linux, Macos and Windows (using GitBash terminal) +This works on Linux, macOS and Windows (using GitBash terminal) diff --git a/docs/book/src/release.md b/docs/book/src/release.md index 6aa86439..4e78fda4 100644 --- a/docs/book/src/release.md +++ b/docs/book/src/release.md @@ -30,7 +30,7 @@ git push origin 0.3.0 ```bash sudo docker run -v /path/to/repo/.krew.yaml:/tmp/template-file.yaml rajatjindal/krew-release-bot:v0.0.38 krew-release-bot template --tag 0.3.0 --template-file /tmp/template-file.yaml ``` -10. Take the output of this command (excluding logging output). Update this file https://github.com/fidelity/krew-index/blob/main/plugins/connect.yaml with the output you just obtainted (note: these manual steps will be automated in future) +10. Take the output of this command (excluding logging output). Update this file https://github.com/fidelity/krew-index/blob/main/plugins/connect.yaml with the output you just obtained (note: these manual steps will be automated in future) ## Implementation @@ -38,5 +38,5 @@ We use [goreleaser](https://goreleaser.com/) to do the majority of the build, pa The **goreleaser** GitHub Action that kicks off goreleaser on tagging the main branch is located [here](https://github.com/fidelity/kconnect/blob/main/.github/workflows/release.yml). -There is an additional GitHub workflow thats used to publish the docs to GitHub pages and that's located [here](https://github.com/fidelity/kconnect/blob/main/.github/workflows/release-docs.yml). +There is an additional GitHub workflow that is used to publish the docs to GitHub pages and that is located [here](https://github.com/fidelity/kconnect/blob/main/.github/workflows/release-docs.yml).