Skip to content

Commit 97137ed

Browse files
uuserf16Gearheads
authored andcommitted
fix(docs): Typos corrected
1 parent 3adc10e commit 97137ed

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/book/src/getting-started.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ kconnect help
1212

1313
The general workflow for using kconnect is the following:
1414

15-
- `kconnect configure` - import configuration that contains defaults for your origanisation - **1 time**
15+
- `kconnect configure` - import configuration that contains defaults for your organisation - **1 time**
1616
- `kconnect use` - connect to a cluster for the first time - **only the first time**
1717
- `kconnect to` - use to reconnect to a cluster that you have already connected to - **most used command day-to-day**
1818

1919
## Creating and importing configuration
2020

21-
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.
21+
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.
2222

2323
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).
2424

@@ -64,4 +64,4 @@ kconnect to 01EM615GB2YX3C6WZ9MCWBDWBF
6464

6565
Flags can be replaced with environment variables by following the format `UPPERCASED_SNAKE_CASE` and appending to the `KCONNECT_` prefix.
6666

67-
For example`--username`can be set as`KCONNECT_USERNAME`; or `--idp-protocol` as`KCONNECT_IDP_PROTOCOL`.
67+
For example `--username` can be set as `KCONNECT_USERNAME`; or `--idp-protocol` as `KCONNECT_IDP_PROTOCOL`.

docs/book/src/installation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<em>NOTE:</em> `kconnect` requires [az cli](https://github.com/Azure/azure-cli) for interactive authentication to Azure AKS clusters.
1515

16-
<em>NOTE:></em> For specific tested and pinned versions, use the `install-kconnect.sh` script or the `with-deps` docker image
16+
<em>NOTE:></em> For specific tested and pinned versions, use the `install-kconnect.sh` script or the `with-deps` docker image
1717

1818
## kubectl plugin
1919

@@ -55,7 +55,7 @@ We are working on publishing as a snap.
5555

5656
The latest [release](https://github.com/fidelity/kconnect/releases) contains a binary for Windows.
5757

58-
We have an open issue to support chocolatey in the future/
58+
We have an open issue to support chocolatey in the future.
5959

6060
## Docker
6161

@@ -75,4 +75,4 @@ chmod 700 install-kconnect.sh
7575
./install-kconnect.sh
7676
```
7777

78-
This works on Linux, Macos and Windows (using GitBash terminal)
78+
This works on Linux, macOS and Windows (using GitBash terminal)

docs/book/src/release.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ git push origin 0.3.0
3030
```bash
3131
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
3232
```
33-
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)
33+
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)
3434

3535
## Implementation
3636

3737
We use [goreleaser](https://goreleaser.com/) to do the majority of the build, packaging and release. The [.goreleaser.yml](https://github.com/fidelity/kconnect/blob/main/.goreleaser.yml) configuration file drives this.
3838

3939
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).
4040

41-
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).
41+
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).
4242

0 commit comments

Comments
 (0)