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

Adding new doc file may break existing URLs #35

Open
XiangRongLin opened this issue Dec 1, 2021 · 1 comment
Open

Adding new doc file may break existing URLs #35

XiangRongLin opened this issue Dec 1, 2021 · 1 comment

Comments

@XiangRongLin
Copy link
Contributor

With #31 I added a new doc file in between and incremented the number in the file names of the other files.

This means that any existing link out there to a specific file will break because the URL contains that number.
For example https://teamnewpipe.github.io/documentation/05_releasing/ will result in a 404 when that PR goes live.


One solution would be to remove the enumeration. This will break all URLs once, but then it can't occur anymore.

@TheAssassin
Copy link
Member

TheAssassin commented Dec 1, 2021

Why are they enumerated at all? To ensure their order in the sidebar?

... I really don't like this mkdocs stuff...

We might be able to preserve the old URLs by adding redirections. As the docs are located on GitHub (which we don't control), we'd have to use tags.

Edit: in case stripping the numbers is possible without having mkdocs reorder them in the table of contents, I'd go that route.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants