chore: Prepare update of API reference URLs #16816
Merged
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.
The link to the API references will be updated. The old location will redirect to the new location.
Reasons the old URLs are not great:
py-polars/html
path in our current stable docs doesn't make much sense - this is old and was kept for backwards compatibility.docs.pola.rs
, it doesn't make sense for our dev references to start withdocs/...
.Logic behind the new URLs:
This is not a super important issue, but it's just a nice professional touch if the URLs make sense. We have previously moved our user guide to a new path using redirects and it was easy and was picked up by search engines really quickly.
Links
Here is an overview of what the old/new links will be:
This PR
This PR doesn't change anything yet, except that it will allow me to set up the API docs in the new locations without them being deleted when new commits are merged.
If this is merged, I can manually update the
gh-pages
branch and I will send a second PR to update the GitHub workflows and the hardcoded links in various locations.