📖 Replace embedded quick-start with link to upstream CAPI docs#3110
📖 Replace embedded quick-start with link to upstream CAPI docs#3110larainema wants to merge 1 commit intokubernetes-sigs:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
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 Tip We noticed you've done this a few times! Consider joining the org to skip this step and gain Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/ok-to-test |
|
@lentzi90 who has the rights to set this up in netlify? could you share more details on that? |
|
Hmm I need to check. I am not sure if I even have those rights in netlify. |
|
I don't think we can do this unfortunately. 😞 |
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.
b936b68 to
55bab43
Compare
|
Thanks for the suggestion @lentzi90! I've pivoted the PR to replace the Changes:
This way the content always stays up to date (readers go directly to the source) and we avoid the stale embed problem entirely. |
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_dispatchfor manual triggering.Setup required by maintainers
After merging, a maintainer with Netlify access needs to:
weekly-docs-rebuild)NETLIFY_BUILD_HOOK