[docs] Minor updates (#129)

* minor doc corrections

* fix test actions to not run for any docs-only changes

* tweak gh-pages workflow for admonish install

Author: AshleyDumaine

.github/workflows/build_test_ci.yml

@@ -9,7 +9,7 @@ on:
       - 'docs/**'
   pull_request:
     branches:
-      - main
+      - "*"
     paths-ignore:
       - '**/**.md'
       - 'docs/**'

.github/workflows/codeql.yml

@@ -9,7 +9,7 @@ on:
       - 'docs/**'
   pull_request:
     branches:
-      - main
+      - "*"
     paths-ignore:
       - '**/**.md'
       - 'docs/**'

.github/workflows/gh-pages.yml

@@ -6,7 +6,7 @@ on:
       - main
     paths:
       - 'README.md'
-      - 'docs/book/**'
+      - 'docs/**'
 
 permissions:
   contents: read
@@ -16,21 +16,28 @@ permissions:
 jobs:
   generate-docs:
     runs-on: ubuntu-latest
+    container: docker.io/node:20-bullseye-slim
     timeout-minutes: 2
     steps:
       - uses: actions/checkout@v4
       - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
-        with:
-          mdbook-version: '0.4.35'
+        run: |
+          apt-get update
+          apt-get install curl -y
+          mkdir mdbook
+          curl -sSL https://github.com/rust-lang/mdbook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+          curl -sSL  https://github.com/tommilligan/mdbook-admonish/releases/download/v1.15.0/mdbook-admonish-v1.15.0-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build with mdBook
+        run: |
+          cd docs
+          mdbook build
       - name: Setup Pages
         uses: actions/configure-pages@v4
-      - name: Build with mdBook
-        run: cd docs/book && mdbook build
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: 'docs/book/book'
+          path: 'docs/book'
 
   deploy-page:
     needs: generate-docs

.gitignore

@@ -5,3 +5,4 @@ kind-logs-*
 cover.out
 kubeconfig*
 .devbox/*
+docs/book

README.md

@@ -38,7 +38,7 @@ to create, configure, and manage Kubernetes clusters.
 ## Compatibility
 
 ### Cluster API Versions
-CAPL is compatible only with the `v1beta1` version of CAPI (v1.0.x).
+CAPL is compatible only with the `v1beta1` version of CAPI (v1.x).
 
 ### Kubernetes Versions
 
@@ -48,6 +48,4 @@ CAPL is able to install and manage the [versions of Kubernetes supported by the
 
 ## Documentation
 
-Please see our [Book](https://linode.github.io/cluster-api-provider-linode) for in-depth user documentation.
-
-Additional docs can be found in the [/docs](/docs) directory.
+Please see our [Book](https://linode.github.io/cluster-api-provider-linode) for in-depth user and developer documentation.

docs/README.md

@@ -11,4 +11,4 @@
 
 ## Troubleshooting
 
-- [Troubleshooting guide](ihttps://linode.github.io/cluster-api-provider-linode/topics/troubleshooting.html)
+- [Troubleshooting guide](https://linode.github.io/cluster-api-provider-linode/topics/troubleshooting.html)

docs/book/book.toml renamed to docs/book.toml

@@ -5,12 +5,9 @@ multilingual = false
 src = "src"
 title = "Cluster API Provider Linode Book"
 
-[build]
-build-dir = "book"
-
 [output.html]
 git-repository-url = "https://github.com/linode/cluster-api-provider-linode"
-additional-css = ["./theme/mdbook-admonish.css"]
+additional-css = ["mdbook-admonish.css"]
 
 [preprocessor]