docs: improve spelling in docs

Signed-off-by: Nico Braun <[email protected]>

.github/workflows/check.yaml

@@ -12,7 +12,6 @@ on:
       - reopened
       - ready_for_review
 
-
 jobs:
   validation:
     runs-on: ubuntu-latest

.github/workflows/pages.yaml

@@ -0,0 +1,22 @@
+name: pages
+
+on:
+  workflow_dispatch: {}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set git config
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Actions"
+
+      - name: Build and publish the docs to github pages
+        run: make github-pages

Makefile

@@ -91,7 +91,7 @@ artifacts: bin/kustomize build ## Create all release artifacts and put the in .d
 	bin/kustomize build manifests/dist/ -o .dist/kobold.manifests.yaml
 	cp assets/schema.json .dist/kobold.schema.json
 	$(MAKE) image-build BUILDX_FLAGS='--set *.attest=type=sbom \
-		--set gitgo.output=type=tar,dest=.dist/kobold-gitgo.oci.tar \
+		--set gitgo.output=type=tar,dest=.dist/kobold.oci.tar \
 		--set gitexec.output=type=tar,dest=.dist/kobold-gitexec.oci.tar'
 
 
@@ -128,7 +128,7 @@ bin/kind:
 	curl -fsSL https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64 | install /dev/stdin bin/kind
 
 bin/mdbook:
-	curl -fsSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -C bin -xzf -
+	curl -fsSL https://github.com/rust-lang/mdBook/releases/download/v0.4.32/mdbook-v0.4.32-x86_64-unknown-linux-gnu.tar.gz | tar -C bin -xzf -
 
 bin/go-licenses:
 	go install github.com/google/go-licenses@latest

docs/publish.sh

@@ -1,20 +1,18 @@
 #!/usr/bin/env bash
 set -o nounset -o errexit -o errtrace -o pipefail
 
-mkdir -p bin
+script_abs="$(readlink -f "$0")"
+script_dir="$(dirname "$script_abs")"
 
-if ! test -x bin/mdbook; then
-  curl -fsSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz |
-    tar -C bin -xzf -
-fi
+cd "$script_dir/../"
 
 git worktree add /tmp/gh-pages
 
 git -C /tmp/gh-pages/ update-ref -d refs/heads/gh-pages
 
 mv /tmp/gh-pages/.git /tmp/mygit
 
-bin/mdbook build --dest-dir /tmp/gh-pages/ docs/
+mdbook build --dest-dir /tmp/gh-pages/ docs/
 
 mv /tmp/mygit /tmp/gh-pages/.git
 

docs/src/comments/exact.md

@@ -1,7 +1,7 @@
 # Exact Match
 
 When using the type `exact` as comment option. The tag from the webhook event
-must patch exactly the tag in the comment option.
+must match exactly the tag in the comment option.
 
 ```yaml
 image: bluebrown/busybox # kobold: tag: latest; type: exact

docs/src/comments/index.md

@@ -4,7 +4,7 @@ Once a webhook event is received, kobold performs a search in any
 [repository](../configuration/repositories.md) that is
 [subscribed](../configuration/subscriptions.md) to the origin
 [endpoint](../configuration/endpoints.md). It looks for image nodes containing
-an inline comment with some options to configure the bahvior on case by case
+an inline comment with some options to configure the behavior on case by case
 basis.
 
 Inline comments keep the logic lean and avoid verbosity while preserving valid

docs/src/configuration/endpoints.md

@@ -25,5 +25,5 @@ Currently supported endpoint types are `acr`, `dockerhub` and `generic`. The
 generic type can be used if you want to dispatch events manually, perhaps via
 pipeline.
 
-> **Note** If there is no type for your registry of choice, please open an issue so that we
-can add it to the codebase.
+> **Note** If there is no type for your registry of choice, please open an issue
+so that we can add it to the codebase.

docs/src/configuration/registry-auth.md

@@ -70,17 +70,17 @@ account` as service account name.
 
 ```yaml
 registryAuth:
-  namespace: "no service account"
+  serviceAccount: "no service account"
 ```
 
 By doing this, you could remove the resource `serviceaccounts` from the rbac
 role.
 
 If you don't provide a `registryAuth` key in your config and use the k8s chain,
 kobold will default to the values of the environment variables `$NAMESPACE` and
-`$SERVICE_ACCOUNT`, if set. Otherwise it will use the default namespace and `no
-service account`. This allows to use the other parts of the k8s chain without
-the actual need for rbac.
+`$SERVICE_ACCOUNT`, if set. Otherwise it will use the `default` namespace and
+`no service account`. This allows to use the other parts of the k8s chain
+without the actual need for rbac.
 
 ## Bare Metal
 

docs/src/configuration/scopes.md

@@ -14,9 +14,10 @@ subscriptions:
 This is useful if you want to use different strategies within the same
 repository. For example you could use the `commit` strategy for your staging
 environment and `pull-request` for the production environment.  
-This could be used to new application versions automatically deployed to staging
-for review by your stakeholders. Once they are happy, you can merge the pull
-request for your production environment.
+
+It could be used to rollout new application versions automatically to a staging
+environment, for review by your stakeholders. Once they are happy, you can merge
+the pull request for your production environment.
 
 ```yaml
 subscriptions:

docs/src/webhooks/index.md

@@ -5,6 +5,7 @@ Kobold listens for webhooks event using the
 The webhook endpoints can have different types such as dockerhub or ACR. This is
 because webhooks events from the various registries send different payloads.
 
-Since kobold requires the digest to work, some registries require kobold to fetch the
-digest upon receiving the event because its not part of the payload. If such a registry
-is used, kobold requires to be able to authenticate against the registry.
+Since kobold requires the digest to work, some registries require kobold to
+fetch the digest upon receiving the event because its not part of the payload.
+If such a registry is used, kobold requires to be able to
+[authenticate](../configuration/registry-auth.md) against the registry.