Merge pull request #27 from AnaisUrlichs/typos

fix: typos

.codespellignore

@@ -0,0 +1,11 @@
+k8sgpt
+
+k8sgptdocs
+
+K8sGPT
+
+helm
+
+Kubernetes
+
+kubectl

.github/workflows/typos.yml

@@ -0,0 +1,16 @@
+name: typos
+
+on:
+  pull_request:
+    paths-ignore:
+      - '*.md'
+
+jobs:
+  build:
+    name: Detect typos
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Run typo checks
+      run: make typos

Makefile

@@ -1,6 +1,17 @@
 MKDOCS_IMAGE := ghcr.io/k8sgpt-ai/k8sgptdocs:dev
 MKDOCS_PORT := 8000
 
+.PHONY: mkdocs-serve
 mkdocs-serve:
 	docker build -t $(MKDOCS_IMAGE) -f docs/build/Dockerfile docs/build
-	docker run --name mkdocs-serve --rm -v $(PWD):/docs -p $(MKDOCS_PORT):8000 $(MKDOCS_IMAGE)
+	docker run --name mkdocs-serve --rm -v $(PWD):/docs -p $(MKDOCS_PORT):8000 $(MKDOCS_IMAGE)
+
+.PHONY: typos
+typos:
+	which codespell || pip install codespell
+	codespell -S _examples,.tfsec,.terraform,.git,go.sum --ignore-words .codespellignore -f
+
+.PHONY: fix-typos
+fix-typos:
+	which codespell || pip install codespell
+	codespell -S .terraform,go.sum --ignore-words .codespellignore -f -w -i1

README.md

@@ -31,4 +31,4 @@ make mkdocs-serve
 
 ## Contributing
 This documentation follows the [Diataxis](https://diataxis.fr/) framework.
-If you are proposing completely new content to the documentation, please familiarise yourself with the framwork first.
+If you are proposing completely new content to the documentation, please familiarise yourself with the framework first.

docs/getting-started/in-cluster-operator.md

@@ -58,7 +58,7 @@ This option allows the cluster deployment to use the `backend` to filter and imp
 Those responses will appear as `details` within the `Result` custom resources that are created.
 
 The default backend in this example is [OpenAI](https://openai.com/) and allows for additional details to be generated and solutions provided for issues.
-If you wish to disable out-of-cluster communication and any Artifical Intelligence processing through models, simply set `enableAI` to `false`.
+If you wish to disable out-of-cluster communication and any Artificial Intelligence processing through models, simply set `enableAI` to `false`.
 
 _It should also be noted that `localai` is supported and in-cluster models will be supported in the near future_
 

docs/reference/cli/index.md

@@ -2,7 +2,7 @@
 
 This section provides an overview of the different `k8sgpt` CLI commands.
 
-**Prerequisits**
+**Prerequisites**
 * You need to be connected to a Kubernetes cluster, K8sGPT will access it through your kubeconfig.
 * [Signed-up to OpenAI ChatGPT](https://openai.com/)
 * Have the [K8sGPT CLI installed](../../getting-started/installation.md)

docs/reference/guidelines/community.md

@@ -1,6 +1,6 @@
 # Community Information
 
-All community related information are kept in a separate respository from the docs.
+All community related information are kept in a separate repository from the docs.
 
 Link to the repository: [k8sgpt-ai/community](https://github.com/k8sgpt-ai/community)
 

mkdocs.yml

@@ -29,7 +29,7 @@ nav:
 
 theme:
   name: material
-  anguage: "en"
+  language: "en"
   logo: imgs/icon-logo-01.svg
   features:
     - navigation.tabs