Prevent indexing of old kedro docs using RTD-Enabled JavaScript script #4516
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.
Description
To address #3741, in collaboration with the Read the Docs (RTD) team, we have developed a JavaScript script that runs during every documentation build. This script injects a
noindex
meta tag into all documentation versions—except for the stable versions of Kedro and Kedro-Viz, and kedro-datasets-6.0.0 for Kedro-Datasets—to prevent outdated versions from being indexed by search engines.Currently, the script is temporarily executed from this storage location, manually enabled by RTD.
Once this PR is merged and the next release is published, we will need to request RTD to manually enable script execution again. In the future, when RTD completes their planned feature update, script selection will be configurable directly from the RTD console.
Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-by
line in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.md
file