Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Prepare update of API reference URLs #16816

Merged
merged 1 commit into from
Jun 10, 2024

Conversation

stinodego
Copy link
Member

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:

  • The py-polars/html path in our current stable docs doesn't make much sense - this is old and was kept for backwards compatibility.
  • Now that our base domain is docs.pola.rs, it doesn't make sense for our dev references to start with docs/....

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:

What Current New
Python stable https://docs.pola.rs/py-polars/html/ https://docs.pola.rs/api/python/stable/
Python dev https://docs.pola.rs/docs/python/dev/ https://docs.pola.rs/api/python/dev/
Python versioned https://docs.pola.rs/docs/python/version/0.20/ https://docs.pola.rs/api/python/version/0.20/
Rust dev https://docs.pola.rs/docs/rust/dev/ https://docs.pola.rs/api/rust/dev/

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.

@github-actions github-actions bot added internal An internal refactor or improvement python Related to Python Polars rust Related to Rust Polars labels Jun 7, 2024
@ritchie46
Copy link
Member

Just to be sure. We will not create dead links? I think it is important for SEO to ensure this works properly.

@stinodego
Copy link
Member Author

Just to be sure. We will not create dead links? I think it is important for SEO to ensure this works properly.

No dead links! Every existing HTML page will continue to exist and they will redirect to their matching new link. This is easily picked up by SEO - we've done this before when moving the user guide to this repo.

@stinodego stinodego merged commit 96bfd1b into main Jun 10, 2024
5 checks passed
@stinodego stinodego deleted the prepare-api-ref-link-change branch June 10, 2024 07:49
@c-peters c-peters added the accepted Ready for implementation label Jun 16, 2024
Wouittone pushed a commit to Wouittone/polars that referenced this pull request Jun 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Ready for implementation internal An internal refactor or improvement python Related to Python Polars rust Related to Rust Polars
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants