From f25fc995153e6612eae5e09ba266a164a7716421 Mon Sep 17 00:00:00 2001 From: Ashley Dumaine Date: Wed, 21 Feb 2024 09:38:31 -0500 Subject: [PATCH 1/3] minor doc corrections --- .github/workflows/gh-pages.yml | 6 +++--- .gitignore | 1 + README.md | 6 ++---- docs/README.md | 2 +- docs/{book => }/book.toml | 5 +---- docs/book/.gitignore | 1 - docs/book/src/introduction.md | 1 - docs/{book/theme => }/favicon.png | Bin docs/{book/theme => }/mdbook-admonish.css | 0 docs/{book => }/src/SUMMARY.md | 0 docs/{book => }/src/developers/development.md | 0 docs/src/introduction.md | 1 + docs/{book => }/src/reference/reference.md | 0 docs/{book => }/src/topics/addons.md | 0 docs/{book => }/src/topics/getting-started.md | 0 docs/{book => }/src/topics/topics.md | 0 docs/{book => }/src/topics/troubleshooting.md | 0 17 files changed, 9 insertions(+), 14 deletions(-) rename docs/{book => }/book.toml (82%) delete mode 100644 docs/book/.gitignore delete mode 100644 docs/book/src/introduction.md rename docs/{book/theme => }/favicon.png (100%) rename docs/{book/theme => }/mdbook-admonish.css (100%) rename docs/{book => }/src/SUMMARY.md (100%) rename docs/{book => }/src/developers/development.md (100%) create mode 100644 docs/src/introduction.md rename docs/{book => }/src/reference/reference.md (100%) rename docs/{book => }/src/topics/addons.md (100%) rename docs/{book => }/src/topics/getting-started.md (100%) rename docs/{book => }/src/topics/topics.md (100%) rename docs/{book => }/src/topics/troubleshooting.md (100%) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index a79aa4106..8c076907c 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -6,7 +6,7 @@ on: - main paths: - 'README.md' - - 'docs/book/**' + - 'docs/**' permissions: contents: read @@ -26,11 +26,11 @@ jobs: - name: Setup Pages uses: actions/configure-pages@v4 - name: Build with mdBook - run: cd docs/book && mdbook build + run: cd docs && mdbook build - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: - path: 'docs/book/book' + path: 'docs/book' deploy-page: needs: generate-docs diff --git a/.gitignore b/.gitignore index dea5abdff..8564cb648 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ kind-logs-* cover.out kubeconfig* .devbox/* +docs/book diff --git a/README.md b/README.md index 3c8325229..d2006fb16 100644 --- a/README.md +++ b/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. diff --git a/docs/README.md b/docs/README.md index c478ab34e..dcf46e0e5 100644 --- a/docs/README.md +++ b/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) diff --git a/docs/book/book.toml b/docs/book.toml similarity index 82% rename from docs/book/book.toml rename to docs/book.toml index e2f1c07b5..0a0a0a3d4 100644 --- a/docs/book/book.toml +++ b/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] diff --git a/docs/book/.gitignore b/docs/book/.gitignore deleted file mode 100644 index 7585238ef..000000000 --- a/docs/book/.gitignore +++ /dev/null @@ -1 +0,0 @@ -book diff --git a/docs/book/src/introduction.md b/docs/book/src/introduction.md deleted file mode 100644 index 3bad00702..000000000 --- a/docs/book/src/introduction.md +++ /dev/null @@ -1 +0,0 @@ -{{#include ../../../README.md}} diff --git a/docs/book/theme/favicon.png b/docs/favicon.png similarity index 100% rename from docs/book/theme/favicon.png rename to docs/favicon.png diff --git a/docs/book/theme/mdbook-admonish.css b/docs/mdbook-admonish.css similarity index 100% rename from docs/book/theme/mdbook-admonish.css rename to docs/mdbook-admonish.css diff --git a/docs/book/src/SUMMARY.md b/docs/src/SUMMARY.md similarity index 100% rename from docs/book/src/SUMMARY.md rename to docs/src/SUMMARY.md diff --git a/docs/book/src/developers/development.md b/docs/src/developers/development.md similarity index 100% rename from docs/book/src/developers/development.md rename to docs/src/developers/development.md diff --git a/docs/src/introduction.md b/docs/src/introduction.md new file mode 100644 index 000000000..676d71c10 --- /dev/null +++ b/docs/src/introduction.md @@ -0,0 +1 @@ +{{#include ../../README.md}} diff --git a/docs/book/src/reference/reference.md b/docs/src/reference/reference.md similarity index 100% rename from docs/book/src/reference/reference.md rename to docs/src/reference/reference.md diff --git a/docs/book/src/topics/addons.md b/docs/src/topics/addons.md similarity index 100% rename from docs/book/src/topics/addons.md rename to docs/src/topics/addons.md diff --git a/docs/book/src/topics/getting-started.md b/docs/src/topics/getting-started.md similarity index 100% rename from docs/book/src/topics/getting-started.md rename to docs/src/topics/getting-started.md diff --git a/docs/book/src/topics/topics.md b/docs/src/topics/topics.md similarity index 100% rename from docs/book/src/topics/topics.md rename to docs/src/topics/topics.md diff --git a/docs/book/src/topics/troubleshooting.md b/docs/src/topics/troubleshooting.md similarity index 100% rename from docs/book/src/topics/troubleshooting.md rename to docs/src/topics/troubleshooting.md From 46050b6ceaf83a05b85b275724ce44b2f5f7513e Mon Sep 17 00:00:00 2001 From: Ashley Dumaine Date: Wed, 21 Feb 2024 09:54:10 -0500 Subject: [PATCH 2/3] fix test actions to not run for any docs-only changes --- .github/workflows/build_test_ci.yml | 2 +- .github/workflows/codeql.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_test_ci.yml b/.github/workflows/build_test_ci.yml index 6ae6ff2d9..0da8dc538 100644 --- a/.github/workflows/build_test_ci.yml +++ b/.github/workflows/build_test_ci.yml @@ -9,7 +9,7 @@ on: - 'docs/**' pull_request: branches: - - main + - "*" paths-ignore: - '**/**.md' - 'docs/**' diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 1b9b404b3..422b8bd7e 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -9,7 +9,7 @@ on: - 'docs/**' pull_request: branches: - - main + - "*" paths-ignore: - '**/**.md' - 'docs/**' From f76a7baae90c51dc59a1e3678e2d7617ddece8be Mon Sep 17 00:00:00 2001 From: Ashley Dumaine Date: Wed, 21 Feb 2024 10:15:39 -0500 Subject: [PATCH 3/3] tweak gh-pages workflow for admonish install --- .github/workflows/gh-pages.yml | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 8c076907c..7c040c2fa 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -16,17 +16,24 @@ 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 && mdbook build - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: