Kuadrant · jasonmadigan · Nov 22, 2024 · Dec 5, 2024
diff --git a/README.md b/README.md
@@ -11,7 +11,12 @@ This repository contains documentation for Kuadrant, built using MkDocs and the
 To run the docs using Docker, mount the current directory to the container and bind it to port `8000`:
 
 ```bash
-docker run -v "$(pwd):/docs" -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:latest "mkdocs serve -s -a 0.0.0.0:8000"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mkdocs serve -s -a 0.0.0.0:8000"
 ```
 
 This will serve the docs at [http://localhost:8000](http://localhost:8000).
@@ -57,7 +62,12 @@ mike serve
 Or, with Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:latest "mike serve -a 0.0.0.0:8000"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike serve -a 0.0.0.0:8000"
 ```
 
 This will serve the docs from the `gh-pages` branch with multi-versioning. For general development, use `mkdocs serve`.
@@ -87,35 +97,50 @@ mike list
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" quay.io/kuadrant/docs.kuadrant.io:latest "mike list"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike list"
 ```
 
 #### Deploy a new release with a custom title
 
 Locally:
 
 ```bash
-mike deploy 0.7.0 -t "0.7.0 (dev)"
+mike deploy 1.0.x -t "1.0.x (latest stable)"
 ```
 
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" quay.io/kuadrant/docs.kuadrant.io:latest "mike deploy 0.7.0 -t '0.7.0 (dev)'"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike deploy 1.0.x -t '1.0.x (latest stable)'"
 ```
 
 #### Delete a release
 
 Locally:
 
 ```bash
-mike delete 0.7.0
+mike delete 1.0.x
 ```
 
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" quay.io/kuadrant/docs.kuadrant.io:latest "mike delete 0.7.0"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike delete 1.0.x"
 ```
 
 #### Serve multi-versioned docs
@@ -129,7 +154,12 @@ mike serve -S
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:latest "mike serve -a 0.0.0.0:8000"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike serve -a 0.0.0.0:8000"
 ```
 
 ---
@@ -138,7 +168,7 @@ docker run -v "$(pwd):/docs" -p 8000:8000 quay.io/kuadrant/docs.kuadrant.io:late
 
 We use two aliases with `mike`:
 
-- `latest`: Points to the latest stable release (e.g., `latest -> 0.7.0`)
+- `latest`: Points to the latest stable release (e.g., `latest -> 1.0.x`)
 - `dev`: Points to `HEAD` of `main`, for unstable or pre-release documentation
 
 ---
@@ -155,47 +185,58 @@ To mark a new release as stable, follow these steps:
 
 > **Note:** This process is currently manual and will be automated soon.
 
-1. Create a release branch from `main` (e.g., `git checkout -b 0.7.x`).
-2. In the release branch (`0.7.x`):
+1. Create a release branch from `main` (e.g., `git checkout -b v1.0.x`).
+2. In the release branch (`v1.0.x`):
     - Update `mkdocs.yml` to replace `branch=` references with specific tags for all components.
     - Set the latest release as default in `mkdocs.yml`:
       ```yaml
       extra:
         version:
           provider: mike
           default:
-            - 0.7.0
+            - 1.0.x
+            - latest
       ```
     - Update any other references for the new release, including `import_url` git refs and other version-specific settings.
 3. Deploy the release with the `latest` alias:
 
 Locally:
 
 ```bash
-mike deploy --update-aliases 0.7.0 latest
+mike deploy --update-aliases 1.0.x latest --push
 ```
 
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" quay.io/kuadrant/docs.kuadrant.io:latest "mike deploy --update-aliases 0.7.0 latest"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike deploy --update-aliases 1.0.x latest --push --allow-empty"
 ```
 
 4. Set this release as the default version:
 
 Locally:
 
 ```bash
-mike set-default 0.7.0
+mike set-default 1.0.x --push
 ```
 
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" quay.io/kuadrant/docs.kuadrant.io:latest "mike set-default 0.7.0"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike set-default 1.0.x --push --allow-empty"
 ```
 
-5. Tag the repo (e.g., `git tag 0.7.0 && git push --tags <upstream-origin>`).
+5. Tag the repo (e.g., `git tag 1.0.x && git push --tags <upstream-origin>`).
 
 ---
 
@@ -211,8 +252,8 @@ For reference:
 
 | Workflow Source | Version to Deploy | Source Branch | Notes               |
 |-----------------|-------------------|---------------|---------------------|
-| main            | 0.10.0            | 0.10.0        | Latest Stable       |
-| main            | 0.8.0             | 0.8           |                     |
+| main            | 1.0.0             | v1.0.x        | Latest Stable       |
+| main            | 0.10.0            | 0.11.0        |                     |
 | main            | dev               | main          | Development - Unstable |
 
 ### Manual Re-release
@@ -224,13 +265,18 @@ For reference:
 Locally:
 
 ```bash
-mike deploy 0.7.0 -t "0.7.0" --push
+mike deploy 1.0.x -t "1.0.x" --push
 ```
 
 Docker / Podman:
 
 ```bash
-docker run -v "$(pwd):/docs" quay.io/kuadrant/docs.kuadrant.io:latest "mike deploy 0.7.0 -t '0.7.0' --push"
+docker run \
+  -v "$(pwd):/docs" \
+  -v "$HOME/.gitconfig:/opt/app-root/src/.gitconfig:ro" \
+  -v "$HOME/.ssh:/opt/app-root/src/.ssh:ro" \
+  quay.io/kuadrant/docs.kuadrant.io:latest \
+  "mike deploy 1.0.x -t '1.0.x' --push"
 ```
 
 4. If there’s a push error, reset to the latest `gh-pages` branch and try again.
@@ -254,3 +300,20 @@ To build the Docker image, run:
 docker build -t quay.io/kuadrant/docs.kuadrant.io:latest .
 docker push quay.io/kuadrant/docs.kuadrant.io:latest
 ```
+
+
+### Troubleshooting
+
+#### Errors with the docs.kuadrant.io container
+
+```bash
+error: failed to push branch gh-pages to origin:
+  /opt/app-root/src/.ssh/config: line 8: Bad configuration option: usekeychain
+  /opt/app-root/src/.ssh/config: terminating, 1 bad configuration options
+  fatal: Could not read from remote repository.
+
+  Please make sure you have the correct access rights
+  and the repository exists.
+```
+
+Remove the `usekeychain` option from your `~/.ssh/config` and try again.
diff --git a/docs/getting-started-single-cluster.md b/docs/getting-started-single-cluster.md
@@ -51,7 +51,7 @@ If you want to make use of the Kuadrant `DNSPolicy` you should setup the followi
 ### Set the release you want to use 
 
 ```bash
-export KUADRANT_REF=main
+export KUADRANT_REF=release-v1.0.0
 ```
 
 ### Set Up a kind cluster and install Kuadrant

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,7 +6,7 @@ extra:
   version:
     provider: mike
     default:
-      - 0.11.0
+      - 1.0.x
       - latest
 theme:
   name: material
@@ -58,25 +58,25 @@ plugins:
       keep_docs_dir: true
       nav_repos:
         - name: kuadrant-operator
-          import_url: 'https://github.com/kuadrant/kuadrant-operator?edit_uri=/blob/main/&branch=main'
+          import_url: 'https://github.com/kuadrant/kuadrant-operator?edit_uri=/blob/release-v1.0.1/&branch=release-v1.0.1'
           imports:
             - /README.md
             - /doc/*
             - /config/samples/*
             - /examples/*
         - name: authorino
-          import_url: 'https://github.com/kuadrant/authorino?edit_uri=/blob/main/&branch=main'
+          import_url: 'https://github.com/kuadrant/authorino?edit_uri=/blob/main/&branch=v0.20.0'
           imports:
             - /README.md
             - /docs/*
             - /docs/user-guides/*
             - /install/crd/*
         - name: authorino-operator
-          import_url: 'https://github.com/kuadrant/authorino-operator?edit_uri=/blob/main/&branch=main'
+          import_url: 'https://github.com/kuadrant/authorino-operator?edit_uri=/blob/main/&branch=kuadrant-v1.0.0'
           imports:
             - /README.md
         - name: limitador
-          import_url: 'https://github.com/kuadrant/limitador?edit_uri=/blob/main/&branch=main'
+          import_url: 'https://github.com/kuadrant/limitador?edit_uri=/blob/main/&branch=v1.6.0'
           imports:
             - /README.md
             - /doc/*
@@ -87,7 +87,7 @@ plugins:
             - /limitador-server/sandbox/*
             - /LICENSE
         - name: limitador-operator
-          import_url: 'https://github.com/kuadrant/limitador-operator?edit_uri=/blob/main/&branch=main'
+          import_url: 'https://github.com/kuadrant/limitador-operator?edit_uri=/blob/main/&branch=kuadrant-v1.0.0'
           imports:
             - /README.md
             - /doc/*
@@ -107,7 +107,7 @@ plugins:
             - /README.md
             - /doc/*
         - name: dns-operator
-          import_url: 'https://github.com/kuadrant/dns-operator?edit_uri=/blob/main/&branch=main'
+          import_url: 'https://github.com/kuadrant/dns-operator?edit_uri=/blob/main/&branch=kuadrant-v1.0.0'
           imports:
             - /README.md
             - /docs/*
@@ -141,6 +141,9 @@ nav:
       - 'Secure, connect and protect - OpenShift': kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-openshift.md
       - 'DNS configuration':
           - 'DNS Providers': dns-operator/docs/provider.md
+          - 'Basic DNS': kuadrant-operator/doc/user-guides/dns/basic-dns-configuration.md
+          - 'DNS Load Balancing': kuadrant-operator/doc/user-guides/dns/load-balanced-dns.md
+          - 'Health Checks': kuadrant-operator/doc/user-guides/dns/dnshealthchecks.md
       - 'TLS configuration':
           - 'Gateway TLS for Cluster Operators': kuadrant-operator/doc/user-guides/tls/gateway-tls.md
       - 'Authentication & Authorization':