Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): Typos corrected #693

Merged
merged 1 commit into from
Jul 3, 2024
Merged

fix(docs): Typos corrected #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/book/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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`.
6 changes: 3 additions & 3 deletions docs/book/src/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

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

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

## kubectl plugin

Expand Down Expand Up @@ -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

Expand All @@ -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)
4 changes: 2 additions & 2 deletions docs/book/src/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ 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

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.

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

Loading