refactor: rename doc components to improve URL SEO#761
Conversation
Rename source folders and Antora component names for clearer URLs: - docs/admc/ + name: admc → docs/admission-controller/ + name: admission-controller - docs/sboms/ + name: sboms → docs/sbom-scanner/ + name: sbom-scanner Update playbook start_paths and cross-component xrefs accordingly. Signed-off-by: Flavio Castelli <fcastelli@suse.com> Assisted-by: Claude Sonnet 4.6
github-project-automation
Bot
moved this to Pending review
in Kubewarden Admission Controller
✅ Deploy Preview for docs-kubewarden-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The Netlify deploy preview and the GHA test workflow were both fetching content from the remote main branch, causing PR builds to ignore the branch's own changes. - Switch test.yml to `make community-local` so CI builds from the checked-out PR branch - Switch kw-remote-community-netlify-playbook.yml to use `url: ./` and `branches: HEAD` so Netlify deploy previews reflect PR content The production deploy (deploy.yml + kw-remote-community-playbook.yml) is unchanged and continues to fetch from remote main after merge. Signed-off-by: Flavio Castelli <fcastelli@suse.com> Assisted-by: Claude Sonnet 4.6
|
Sure, we can do this. The playbooks will need adjusting as well. Also, maybe move docs/kw to docs/kubewarden. If you like, assign to me and I'll do all that and make sure it builds ok. Thanks for the change to the netlify build. Yes, it should do a community-local build and use HEAD. The playbook for community-remote for gh-pages will need adjusting to the new paths. And in the community-local playbook (for building on your own workstation). Maybe I can reduce the number of playbooks back down to 2. |
|
This sounds like a good change, +1 (can't formally approve, github chokes when going to the files tab for approving...)
That would also be useful. |
Sorry for not mentioning that into the PR body, I just fired the PR and ran to have lunch 😄 I think it would be good to go down to one playbook, maybe with another PR? |
The logo in the top-left navbar was hardcoded to https://docs.kubewarden.io/, causing it to redirect away from the current build when using local or PR preview builds. Replace the hardcoded URL with `{{{siteRootPath}}}`, which Antora resolves to a relative path to the site root at build time. Signed-off-by: Flavio Castelli <fcastelli@suse.com> Assisted-by: Claude Sonnet 4.6
|
I've pushed one final commit and updated the PR body to mention all the changes. If you're fine with that I would merge this PR and then reduce the number of netlify playbooks with another PR |
github-project-automation
Bot
moved this from Pending review
to Done
in Kubewarden Admission Controller
3 participants
Rename source folders and Antora component names for clearer URLs:
Other changes:
main, not from the PR branch)