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

Use absolute slug for packages documentations #23712

Closed
wants to merge 2 commits into from

Conversation

lunny
Copy link
Member

@lunny lunny commented Mar 26, 2023

Look like there is a duplicated packages in https://docs.gitea.com/packages/usage/packages/cargo , It maybe caused by the relative slug in packages documentations.

@lunny lunny added the type/docs This PR mainly updates/creates documentation label Mar 26, 2023
@delvh delvh added the type/bug label Mar 26, 2023
@delvh delvh added this to the 1.20.0 milestone Mar 26, 2023
@delvh delvh added the outdated/backport/v1.19 This PR should be backported to Gitea 1.19 label Mar 26, 2023
@GiteaBot GiteaBot added the lgtm/need 1 This PR needs approval from one additional maintainer to be merged. label Mar 26, 2023
@jolheiser
Copy link
Member

jolheiser commented Mar 26, 2023

Isn't it because the parent https://github.com/go-gitea/gitea/blob/main/docs/content/doc/packages.en-us.md is packages, but the package docs use usage/packages/XYZ?

@lunny
Copy link
Member Author

lunny commented Mar 26, 2023

Isn't it because the parent https://github.com/go-gitea/gitea/blob/main/docs/content/doc/packages.en-us.md is packages, but the package docs use usage/packages/XYZ?

Maybe, let me change it.

@lunny
Copy link
Member Author

lunny commented Mar 26, 2023

Isn't it because the parent https://github.com/go-gitea/gitea/blob/main/docs/content/doc/packages.en-us.md is packages, but the package docs use usage/packages/XYZ?

Done. But for hugo, it will not join the parent slug maybe docusaurus will.

@jolheiser jolheiser mentioned this pull request Mar 27, 2023
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 28, 2023
@lunny lunny added the pr/wip This PR is not ready for review label Mar 28, 2023
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>
@lunny
Copy link
Member Author

lunny commented Apr 28, 2023

replaced by #23752

@lunny lunny closed this Apr 28, 2023
@GiteaBot GiteaBot removed this from the 1.20.0 milestone Apr 28, 2023
@lunny lunny deleted the lunny/fix_docs_packages_slug branch April 28, 2023 03:34
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Aug 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. outdated/backport/v1.19 This PR should be backported to Gitea 1.19 pr/wip This PR is not ready for review type/bug type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants