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>
- **Installation**: includes how to install Gitea and related other
tools, also includes upgrade Gitea
- **Administration**: includes how to configure Gitea, customize Gitea
and manage Gitea instance out of Gitea admin UI
- **Usage**: includes how to use Gitea's functionalities. A sub
documentation is about packages, in future we could also include CI/CD
and others.
- **Development**: includes how to integrate with Gitea's API, how to
develop new features within Gitea
- **Contributing**: includes how to contribute code to Gitea
repositories.
After this is merged, I think we can have a sub-documentation of `Usage`
part named `Actions` to describe how to use Gitea actions
---------
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
It seems that migrating from Gogs `0.12.x` and above may require more
work as time goes on and the projects continue to diverge.
This PR updates the docs to make it more clear.
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Update "Upgrade from Gogs" en-us doc
- Move "Change gogs specific information" FROM/TO steps up
to just beneath matching section header, adjust indention
and explicitly specify syntax of code sample to provide
highlighting
- Adjust header levels to match what appears to be the
intended level, remove trailing decoration (see below)
- Move "Upgrading to most recent ..." section down, remove
decoration (section header formatting likely covers this
well enough already)
refs go-gitea/gitea#4286, go-gitea/gitea#3558
* Update "Upgrade from Gogs" fr-fr doc
- Adjust indention and explicitly specify syntax of code
sample to provide highlighting
- Adjust header levels to match what appears to be the
intended level, remove trailing decoration since
section header formatting likely covers this
well enough already
refs go-gitea/gitea#4286, go-gitea/gitea#3558
John Olheiser
Lunny Xiao
Greg Myers
techknowlogick
Patrick Schratz
6543
guillep2k
kolaente
Johan Van de Wauw
Aidan Fitzgerald
Shikiryu
Deoren Moor
Victor Polevoy
Michael Lustfield
techknowlogick