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

Create redirects for contributor documentation moved into the Github wiki #2911

Closed
stichbury opened this issue Aug 8, 2023 · 6 comments
Closed
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

stichbury commented Aug 8, 2023

Introduction

We have moved contributor documentation into the GitHub wiki to separate it from developer docs. We need to add a set of redirects so people with bookmarks can still find it.

Background

Create a set of redirects in RTD for these pages

Also add redirects for the architecture overview page to point to https://github.com/kedro-org/kedro/wiki/Architecture#kedro-architecture-overview

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Aug 8, 2023
@stichbury
Copy link
Contributor Author

@stichbury
Copy link
Contributor Author

I've added these...but they're not working 😢 so I'll check again to see what is happening (will give it an hour or two to propagate).

@astrojuanlu
Copy link
Member

If they're in /en/stable, a new stable build would be needed. Maybe try in /en/latest first?

@stichbury
Copy link
Contributor Author

Ah, interesting. I didn't realise that redirects were built into the docs...I thought they were part of the hosting somehow so as soon as they were set the link would change from RTD page -> GitHub wiki.

@stichbury
Copy link
Contributor Author

From the RTD docs

By default, redirects only apply on pages that don’t exist. Forced redirects allow you to apply redirects on existing pages, but incur a small performance penalty, so aren’t enabled by default. You can ask for them to be enabled via support.

Only Page redirects and Exact redirects can redirect to URLs outside Read the Docs, just include the protocol in To URL, e.g https://example.com.

@stichbury
Copy link
Contributor Author

All is clear now, and I've put in temporary redirects for the release build of the docs, and stable will come into effect when we next release.

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
None yet
Development

No branches or pull requests

2 participants