githaven-fork/docs/content/doc/contributing
John Olheiser bb25f85ce8
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/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>
2023-04-28 11:33:41 +08:00
..
_index.de-de.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
guidelines-backend.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
guidelines-frontend.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
guidelines-refactoring.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
localization.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
localization.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
localization.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
translation.de-de.md Update docs markdown file weight to make it clear (#23909) 2023-04-04 21:47:31 +08:00
translation.en-us.md Update docs markdown file weight to make it clear (#23909) 2023-04-04 21:47:31 +08:00