Use absolute slug for packages documentations #23712
Closed
Conversation
This file contains 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
delvh
added
the
outdated/backport/v1.19
delvh
approved these changes
Mar 26, 2023
GiteaBot
added
the
lgtm/need 1
|
Isn't it because the parent https://github.com/go-gitea/gitea/blob/main/docs/content/doc/packages.en-us.md is |
Maybe, let me change it. |
Done. But for hugo, it will not join the parent slug maybe docusaurus will. |
Merged
wolfogre
approved these changes
Mar 28, 2023
GiteaBot
added
lgtm/done
lunny
pushed a commit
that referenced
this pull request
Apr 28, 2023
This was intended to be a small followup for #23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see #23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
|
replaced by #23752 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Look like there is a duplicated
packagesin https://docs.gitea.com/packages/usage/packages/cargo , It maybe caused by the relative slug in packages documentations.