Skip to content

📖 Replace embedded quick-start with link to upstream CAPI docs#3110

Open
larainema wants to merge 1 commit intokubernetes-sigs:mainfrom
larainema:ci/periodic-docs-build
Open

📖 Replace embedded quick-start with link to upstream CAPI docs#3110
larainema wants to merge 1 commit intokubernetes-sigs:mainfrom
larainema:ci/periodic-docs-build

Conversation

@larainema
Copy link
Copy Markdown
Contributor

What problem does this PR solve?

The docs site at https://cluster-api-openstack.sigs.k8s.io embeds content from external repositories using mdbook-embed. For example, the getting-started page is embedded directly from CAPI.

Since the site is deployed via Netlify and only rebuilds on push to main, the embedded external content becomes stale if no PRs are merged for some time.

Fixes #2811

Solution

Add a weekly scheduled GitHub Actions workflow that triggers a Netlify build via a build hook. This Add a weekly scheduled GitHub Actions workflow that triggers a Netlify build via a [build hook](https://docs.netlify.com/conmmits.

The workflow also supports workflow_dispatch for manual triggering.

Setup required by maintainers

After merging, a maintainer with Netlify access needs to:

  1. Create a **1. Create a **1. Create a **1. Create a **Build & deploy > Build hooks_ (name it e.g. weekly-docs-rebuild)
  2. Add the hook URL as a GitHub Actions secret named NETLIFY_BUILD_HOOK

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign neolit123 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 9, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @larainema. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 9, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 9, 2026

Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

Name Link
🔨 Latest commit 55bab43
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-cluster-api-openstack/deploys/69e23738ac28b000084030aa
😎 Deploy Preview https://deploy-preview-3110--kubernetes-sigs-cluster-api-openstack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@nikParasyr
Copy link
Copy Markdown
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 9, 2026
@bnallapeta
Copy link
Copy Markdown
Contributor

@lentzi90 who has the rights to set this up in netlify? could you share more details on that?

@lentzi90
Copy link
Copy Markdown
Contributor

Hmm I need to check. I am not sure if I even have those rights in netlify.

@lentzi90
Copy link
Copy Markdown
Contributor

I don't think we can do this unfortunately. 😞
Perhaps it would be better if we just link to https://cluster-api.sigs.k8s.io/user/quick-start instead of embedding it like we do now. Then there is never the issue of keeping it up to date.
What do you think?

Replace the embed-github preprocessor usage in getting-started.md
with a direct link to the upstream Cluster API quick-start guide.
This avoids the problem of embedded content becoming stale and
removes the need for periodic rebuilds.

Also removes the now-unused mdbook-embed preprocessor from
book.toml and both Makefiles.
@larainema larainema force-pushed the ci/periodic-docs-build branch from b936b68 to 55bab43 Compare April 17, 2026 13:35
@larainema larainema changed the title Add weekly scheduled workflow to rebuild docs site 📖 Replace embedded quick-start with link to upstream CAPI docs Apr 17, 2026
@larainema
Copy link
Copy Markdown
Contributor Author

Thanks for the suggestion @lentzi90! I've pivoted the PR to replace the embed-github usage with a direct link to the upstream CAPI quick-start guide instead.

Changes:

  • Replaced {{#embed-github ...}} in getting-started.md with a link to https://cluster-api.sigs.k8s.io/user/quick-start
  • Removed the [preprocessor.embed] config from book.toml
  • Removed mdbook-embed from both docs/book/Makefile and hack/tools/Makefile

This way the content always stays up to date (readers go directly to the source) and we avoid the stale embed problem entirely.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

Periodically build documentation

5 participants