Fix /changelog/ and /contributing/ docs URLs#1541
Merged
Conversation
PR #1474 moved the docs to the `docs/` directory, and also changed casing of some filenames. - `docs/changelog.md` -> `docs/CHANGELOG.md` - `docs/contributing.md` -> `docs/CONTRIBUTING.md` This changed URL path parameters as well. URL paths to these pages must now be uppercased when accessing the deployed docs (#1540). For example, navigating to https://pipx.pypa.io/stable/CONTRIBUTING/ shows the correct page, but navigating to https://pipx.pypa.io/stable/contributing/ displays a (poorly styled) `404` page. This commit will move the pages back to `docs/changelog.md` and `docs/contributing.md` to restore the previous URLs to these pages. Note that the casing changes to not affect the homepage because MkDocs automatically handles `README.md` as `index.md`. https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages
Contributor
|
Thanks; this'll be a |
Contributor
Author
Makes sense. Re-categorized as |
Gitznik
approved these changes
Sep 11, 2024
Contributor
Gitznik
left a comment
Gitznik
left a comment
There was a problem hiding this comment.
Thanks for this contribution 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
changelog.d/(if the patch affects the end users)Summary of changes
Closes #1540
PR #1474 moved the docs to the
docs/directory, and also changed casing of some filenames.docs/changelog.md->docs/CHANGELOG.mddocs/contributing.md->docs/CONTRIBUTING.mdThis changed URL path parameters as well. URL paths to these pages must now be uppercased when accessing the deployed docs.
How to reproduce
For example, navigating to https://pipx.pypa.io/stable/CONTRIBUTING/ shows the correct page.
But navigating to https://pipx.pypa.io/stable/contributing/ displays a (poorly styled)
404page:This PR will move the pages back to
docs/changelog.mdanddocs/contributing.mdto restore the previous URLs to these pages.Note that the casing changes do not affect the homepage because MkDocs automatically handles
README.mdasindex.md.Test plan
Tested by running