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

Add RTD docs redirects following next release #3567

Closed
stichbury opened this issue Jan 29, 2024 · 4 comments
Closed

Add RTD docs redirects following next release #3567

stichbury opened this issue Jan 29, 2024 · 4 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

Once latest becomes stable we need to add the following redirects:

API docs changes

We can't add redirects for every page but makes sense to change the top level:

From Heap, the most popular API pages

  • /en/stable/kedro.io.DataCatalog.html --> /en/stable/api/kedro.io.DataCatalog.html
  • /en/stable/kedro.framework.session.session.KedroSession.html --> /en/stable/api/kedro.framework.session.session.KedroSession.html
  • /en/stable/kedro.framework.context.KedroContext.html --> /en/stable/api/kedro.framework.context.KedroContext.html
  • /en/stable/kedro.pipeline.html --> /en/stable/api/kedro.pipeline.html
  • /en/stable/kedro.config.OmegaConfigLoader.html --> /en/stable/api/kedro.config.OmegaConfigLoader.html
  • /en/stable/kedro.pipeline.node.html --> /en/stable/api/kedro.pipeline.node.html
  • /en/stable/kedro.io.AbstractDataset.html --> /en/stable/api/kedro.io.AbstractDataset.html
  • /en/stable/kedro.pipeline.Pipeline.html --> /en/stable/api/kedro.pipeline.Pipeline.html
  • /en/stable/kedro.pipeline.node.Node.html --> /en/stable/api/kedro.pipeline.node.Node.html
  • /en/stable/kedro.framework.hooks.html --> /en/stable/api/kedro.framework.hooks.html
  • /en/stable/kedro.framework.hooks.specs.PipelineSpecs.html --> /en/stable/api/kedro.framework.hooks.specs.PipelineSpecs.html
  • /en/stable/kedro.framework.hooks.specs.html --> /en/stable/api/kedro.framework.hooks.specs.html

Other docs page changes

To come as needed

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jan 29, 2024
@astrojuanlu
Copy link
Member

Thanks for pulling the most popular ones 👍🏽 Looks sensible enough. Our redirect debt is already quite grim...

@astrojuanlu
Copy link
Member

Prioritising this as "high" directly, since it's affected by the release timing

@stichbury
Copy link
Contributor Author

Our redirect debt is already quite grim...

I consolidated a load recently but it is still painfully bad. Maybe remove the URLs with numbers since it's been a while and only the 0.17.7 release uses them.

It's a shame we can't see from Heap and/or RTD who is hitting pages from redirects, and what those redirects are.

@astrojuanlu
Copy link
Member

Done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants