diff options
| author | John Olheiser <john.olheiser@gmail.com> | 2023-04-27 22:33:41 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-28 11:33:41 +0800 |
| commit | bb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3 (patch) | |
| tree | 3447bb1fc8d376cd401b2491be7d4d2aed314913 /docs/content/doc/contributing | |
| parent | 83022013c83feb5488952baea3ef0be818dfce21 (diff) | |
| download | gitea-bb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3.tar.gz gitea-bb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3.zip | |
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>
Diffstat (limited to 'docs/content/doc/contributing')
10 files changed, 12 insertions, 0 deletions
diff --git a/docs/content/doc/contributing/_index.de-de.md b/docs/content/doc/contributing/_index.de-de.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/contributing/_index.de-de.md diff --git a/docs/content/doc/contributing/_index.en-us.md b/docs/content/doc/contributing/_index.en-us.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/contributing/_index.en-us.md diff --git a/docs/content/doc/contributing/_index.zh-cn.md b/docs/content/doc/contributing/_index.zh-cn.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/contributing/_index.zh-cn.md diff --git a/docs/content/doc/contributing/_index.zh-tw.md b/docs/content/doc/contributing/_index.zh-tw.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/contributing/_index.zh-tw.md diff --git a/docs/content/doc/contributing/guidelines-backend.en-us.md b/docs/content/doc/contributing/guidelines-backend.en-us.md index 6ae0ba517d..fd0f8b0830 100644 --- a/docs/content/doc/contributing/guidelines-backend.en-us.md +++ b/docs/content/doc/contributing/guidelines-backend.en-us.md @@ -5,6 +5,8 @@ slug: "guidelines-backend" weight: 20 toc: false draft: false +aliases: + - /en-us/guidelines-backend menu: sidebar: parent: "contributing" diff --git a/docs/content/doc/contributing/guidelines-frontend.en-us.md b/docs/content/doc/contributing/guidelines-frontend.en-us.md index bde7d31510..39a70eee97 100644 --- a/docs/content/doc/contributing/guidelines-frontend.en-us.md +++ b/docs/content/doc/contributing/guidelines-frontend.en-us.md @@ -5,6 +5,8 @@ slug: "guidelines-frontend" weight: 20 toc: false draft: false +aliases: + - /en-us/guidelines-frontend menu: sidebar: parent: "contributing" diff --git a/docs/content/doc/contributing/guidelines-refactoring.en-us.md b/docs/content/doc/contributing/guidelines-refactoring.en-us.md index 913ce8d9bb..c8c8ee0ee1 100644 --- a/docs/content/doc/contributing/guidelines-refactoring.en-us.md +++ b/docs/content/doc/contributing/guidelines-refactoring.en-us.md @@ -5,6 +5,8 @@ slug: "guidelines-refactoring" weight: 20 toc: false draft: false +aliases: + - /en-us/guidelines-refactoring menu: sidebar: parent: "contributing" diff --git a/docs/content/doc/contributing/localization.en-us.md b/docs/content/doc/contributing/localization.en-us.md index 3006ca599b..7f78fb3fa8 100644 --- a/docs/content/doc/contributing/localization.en-us.md +++ b/docs/content/doc/contributing/localization.en-us.md @@ -5,6 +5,8 @@ slug: "localization" weight: 10 toc: false draft: false +aliases: + - /en-us/localization menu: sidebar: parent: "contributing" diff --git a/docs/content/doc/contributing/localization.zh-cn.md b/docs/content/doc/contributing/localization.zh-cn.md index c20f4d4138..99a9f3743f 100644 --- a/docs/content/doc/contributing/localization.zh-cn.md +++ b/docs/content/doc/contributing/localization.zh-cn.md @@ -5,6 +5,8 @@ slug: "localization" weight: 20 toc: false draft: false +aliases: + - /zh-cn/localization menu: sidebar: parent: "contributing" diff --git a/docs/content/doc/contributing/localization.zh-tw.md b/docs/content/doc/contributing/localization.zh-tw.md index 815fbc3119..cfdc1dcb9b 100644 --- a/docs/content/doc/contributing/localization.zh-tw.md +++ b/docs/content/doc/contributing/localization.zh-tw.md @@ -5,6 +5,8 @@ slug: "localization" weight: 20 toc: false draft: false +aliases: + - /zh-tw/localization menu: sidebar: parent: "contributing" |