fix: Remove redirect_facility to fix broken redirects #678
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This came up in stackabletech/crddocs#44. Initial investigation revealed that the roles-and-role-groups.html file was not present in the stable (24.7) and nightly (soon 24.11) version of generated files when using the production antor playbook. This playbook is used when Netlify deploys the docs using 'make netlify-build'. Local builds using 'make' on the other hand included the file in both versions and as such, the redirect works. Finally, the 'redirect_facility: netlify' option was identified as the cause. The generated '_redirects' file only contained a redirect from concepts/roles-and-role-groups.html to concepts/stacklet. This matched with the behaviour we experiences when surfing the live site. Removing this option (and thus using the default facility) potentially fixes the issue. Netlify already provides redirect using the "Pretty URLs" post-processing feature. References: - https://docs.antora.org/antora/latest/playbook/urls-redirect-facility/#redirect-facility-key - https://docs.netlify.com/site-deploys/post-processing/#post-processing-features - https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file
✅ Deploy Preview for stackable-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
NickLarsenNZ
previously approved these changes
Nov 14, 2024
NickLarsenNZ
approved these changes
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes stackabletech/crddocs#44
This came up in stackabletech/crddocs#44. Initial investigation revealed that the
roles-and-role-groups.htmlfile was not present in the stable (24.7) and nightly (soon 24.11) version of generated files when using the production antor playbook.This playbook is used when Netlify deploys the docs using
make netlify-build. Local builds usingmakeon the other hand included the file in both versions and as such, the redirect works.Finally, the
redirect_facility: netlifyoption was identified as the cause. The generated_redirectsfile only contained a redirect fromconcepts/roles-and-role-groups.htmltoconcepts/stacklet.html. This matched with the behaviour we experiences when surfing the live site.Removing this option (and thus using the default facility) potentially fixes the issue. Netlify already provides redirect using the "Pretty URLs" post-processing feature.
References: