From e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 23 Mar 2023 23:18:24 +0800 Subject: [PATCH] Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) - **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 --- Makefile | 3 +- docs/Makefile | 2 +- docs/config.yaml | 5 ++++ docs/content/doc/administration.en-us.md | 14 +++++++++ ...anced.fr-fr.md => administration.fr-fr.md} | 6 ++-- docs/content/doc/administration.zh-cn.md | 13 ++++++++ docs/content/doc/administration.zh-tw.md | 13 ++++++++ .../adding-legal-pages.en-us.md | 4 +-- .../backup-and-restore.en-us.md | 2 +- .../backup-and-restore.zh-cn.md | 2 +- .../backup-and-restore.zh-tw.md | 2 +- .../cmd-embedded.en-us.md | 8 ++--- .../command-line.en-us.md | 4 +-- .../config-cheat-sheet.en-us.md | 6 ++-- .../config-cheat-sheet.zh-cn.md | 4 +-- .../customizing-gitea.en-us.md | 6 ++-- .../customizing-gitea.zh-cn.md | 4 +-- .../email-setup.en-us.md | 4 +-- .../environment-variables.en-us.md | 4 +-- .../environment-variables.zh-cn.md | 4 +-- .../external-renderers.en-us.md | 4 +-- .../fail2ban-setup.en-us.md | 2 +- .../fail2ban-setup.zh-cn.md | 2 +- .../git-lfs-support.en-us.md | 2 +- .../https-support.en-us.md | 4 +-- .../logging-documentation.en-us.md | 4 +-- .../mail-templates.en-us.md | 2 +- .../repo-indexer.en-us.md | 2 +- .../reverse-proxies.en-us.md | 4 +-- .../reverse-proxies.zh-cn.md | 4 +-- .../search-engines-indexation.en-us.md | 4 +-- .../signing.en-us.md | 4 +-- docs/content/doc/advanced.zh-tw.md | 13 -------- ...slation.en-us.md => contributing.en-us.md} | 8 ++--- ...slation.de-de.md => contributing.fr-fr.md} | 4 +-- ...slation.zh-tw.md => contributing.zh-tw.md} | 8 ++--- .../guidelines-backend.en-us.md | 2 +- .../guidelines-frontend.en-us.md | 2 +- .../guidelines-refactoring.en-us.md | 2 +- .../localization.en-us.md | 2 +- .../localization.zh-cn.md | 2 +- .../localization.zh-tw.md | 2 +- .../translation.de-de.md} | 2 +- .../translation.en-us.md} | 2 +- docs/content/doc/developers.en-us.md | 13 -------- docs/content/doc/developers.zh-cn.md | 13 -------- docs/content/doc/developers.zh-tw.md | 13 -------- docs/content/doc/development.en-us.md | 13 ++++++++ ...advanced.en-us.md => development.zh-cn.md} | 10 +++---- ...advanced.zh-cn.md => development.zh-tw.md} | 10 +++---- .../api-usage.en-us.md | 2 +- .../api-usage.zh-cn.md | 2 +- .../hacking-on-gitea.en-us.md | 8 ++--- .../hacking-on-gitea.zh-cn.md | 6 ++-- .../integrations.en-us.md | 2 +- .../integrations.zh-tw.md | 2 +- .../migrations.en-us.md | 2 +- .../migrations.zh-tw.md | 2 +- .../oauth2-provider.en-us.md | 2 +- .../oauth2-provider.zh-tw.md | 2 +- docs/content/doc/features.en-us.md | 13 -------- docs/content/doc/features.zh-cn.md | 13 -------- docs/content/doc/features.zh-tw.md | 13 -------- docs/content/doc/help.en-us.md | 2 +- docs/content/doc/help.fr-fr.md | 2 +- docs/content/doc/help.zh-cn.md | 2 +- docs/content/doc/help.zh-tw.md | 2 +- docs/content/doc/help/faq.en-us.md | 30 +++++++++---------- .../comparison.en-us.md | 2 +- .../comparison.zh-cn.md | 2 +- .../comparison.zh-tw.md | 2 +- .../database-preparation.en-us.md | 2 +- .../doc/installation/from-binary.en-us.md | 6 ++-- .../doc/installation/from-binary.zh-cn.md | 4 +-- .../doc/installation/from-source.en-us.md | 4 +-- .../upgrade-from-gitea.en-us.md} | 8 ++--- .../upgrade-from-gogs.en-us.md} | 6 ++-- .../upgrade-from-gogs.fr-fr.md} | 4 +-- .../upgrade-from-gogs.zh-cn.md} | 4 +-- .../upgrade-from-gogs.zh-tw.md} | 6 ++-- .../with-docker-rootless.en-us.md | 2 +- .../doc/installation/with-docker.en-us.md | 2 +- .../doc/installation/with-docker.fr-fr.md | 2 +- .../doc/installation/with-docker.zh-cn.md | 2 +- .../doc/installation/with-docker.zh-tw.md | 2 +- docs/content/doc/packages.en-us.md | 9 +++--- docs/content/doc/packages/cargo.en-us.md | 4 +-- docs/content/doc/packages/chef.en-us.md | 2 +- docs/content/doc/packages/composer.en-us.md | 4 +-- docs/content/doc/packages/conan.en-us.md | 4 +-- docs/content/doc/packages/conda.en-us.md | 2 +- docs/content/doc/packages/container.en-us.md | 4 +-- docs/content/doc/packages/generic.en-us.md | 6 ++-- docs/content/doc/packages/helm.en-us.md | 4 +-- docs/content/doc/packages/maven.en-us.md | 4 +-- docs/content/doc/packages/npm.en-us.md | 4 +-- docs/content/doc/packages/nuget.en-us.md | 6 ++-- docs/content/doc/packages/overview.en-us.md | 2 +- docs/content/doc/packages/pub.en-us.md | 4 +-- docs/content/doc/packages/pypi.en-us.md | 4 +-- docs/content/doc/packages/rubygems.en-us.md | 4 +-- docs/content/doc/packages/storage.en-us.md | 6 ++-- docs/content/doc/packages/swift.en-us.md | 6 ++-- docs/content/doc/packages/vagrant.en-us.md | 4 +-- docs/content/doc/upgrade.en-us.md | 13 -------- docs/content/doc/upgrade.fr-fr.md | 13 -------- docs/content/doc/upgrade.zh-cn.md | 13 -------- docs/content/doc/upgrade.zh-tw.md | 13 -------- docs/content/doc/usage.en-us.md | 2 +- docs/content/doc/usage.zh-cn.md | 2 +- docs/content/doc/usage.zh-tw.md | 2 +- .../authentication.en-us.md | 2 +- .../authentication.zh-cn.md | 2 +- .../authentication.zh-tw.md | 2 +- .../{advanced => usage}/clone-filter.en-us.md | 2 +- .../doc/usage/linked-references.en-us.md | 2 +- .../protected-tags.en-us.md | 2 +- .../content/doc/usage/push-to-create.en-us.md | 2 +- .../{advanced => usage}/repo-mirror.en-us.md | 2 +- .../secrets.en-us.md} | 8 ++--- .../doc/{features => usage}/webhooks.en-us.md | 2 +- .../doc/{features => usage}/webhooks.zh-cn.md | 2 +- .../doc/{features => usage}/webhooks.zh-tw.md | 2 +- 123 files changed, 261 insertions(+), 346 deletions(-) create mode 100644 docs/content/doc/administration.en-us.md rename docs/content/doc/{advanced.fr-fr.md => administration.fr-fr.md} (64%) create mode 100644 docs/content/doc/administration.zh-cn.md create mode 100644 docs/content/doc/administration.zh-tw.md rename docs/content/doc/{advanced => administration}/adding-legal-pages.en-us.md (96%) rename docs/content/doc/{usage => administration}/backup-and-restore.en-us.md (99%) rename docs/content/doc/{usage => administration}/backup-and-restore.zh-cn.md (98%) rename docs/content/doc/{usage => administration}/backup-and-restore.zh-tw.md (98%) rename docs/content/doc/{advanced => administration}/cmd-embedded.en-us.md (96%) rename docs/content/doc/{usage => administration}/command-line.en-us.md (99%) rename docs/content/doc/{advanced => administration}/config-cheat-sheet.en-us.md (99%) rename docs/content/doc/{advanced => administration}/config-cheat-sheet.zh-cn.md (99%) rename docs/content/doc/{advanced => administration}/customizing-gitea.en-us.md (97%) rename docs/content/doc/{advanced => administration}/customizing-gitea.zh-cn.md (99%) rename docs/content/doc/{usage => administration}/email-setup.en-us.md (97%) rename docs/content/doc/{advanced => administration}/environment-variables.en-us.md (97%) rename docs/content/doc/{advanced => administration}/environment-variables.zh-cn.md (97%) rename docs/content/doc/{advanced => administration}/external-renderers.en-us.md (99%) rename docs/content/doc/{usage => administration}/fail2ban-setup.en-us.md (99%) rename docs/content/doc/{usage => administration}/fail2ban-setup.zh-cn.md (99%) rename docs/content/doc/{usage => administration}/git-lfs-support.en-us.md (95%) rename docs/content/doc/{usage => administration}/https-support.en-us.md (97%) rename docs/content/doc/{advanced => administration}/logging-documentation.en-us.md (99%) rename docs/content/doc/{advanced => administration}/mail-templates.en-us.md (99%) rename docs/content/doc/{advanced => administration}/repo-indexer.en-us.md (98%) rename docs/content/doc/{usage => administration}/reverse-proxies.en-us.md (99%) rename docs/content/doc/{usage => administration}/reverse-proxies.zh-cn.md (98%) rename docs/content/doc/{advanced => administration}/search-engines-indexation.en-us.md (90%) rename docs/content/doc/{advanced => administration}/signing.en-us.md (99%) delete mode 100644 docs/content/doc/advanced.zh-tw.md rename docs/content/doc/{translation.en-us.md => contributing.en-us.md} (52%) rename docs/content/doc/{translation.de-de.md => contributing.fr-fr.md} (75%) rename docs/content/doc/{translation.zh-tw.md => contributing.zh-tw.md} (55%) rename docs/content/doc/{developers => contributing}/guidelines-backend.en-us.md (99%) rename docs/content/doc/{developers => contributing}/guidelines-frontend.en-us.md (99%) rename docs/content/doc/{developers => contributing}/guidelines-refactoring.en-us.md (98%) rename docs/content/doc/{features => contributing}/localization.en-us.md (97%) rename docs/content/doc/{features => contributing}/localization.zh-cn.md (97%) rename docs/content/doc/{features => contributing}/localization.zh-tw.md (97%) rename docs/content/doc/{translation/guidelines.de-de.md => contributing/translation.de-de.md} (98%) rename docs/content/doc/{translation/guidelines.en-us.md => contributing/translation.en-us.md} (93%) delete mode 100644 docs/content/doc/developers.en-us.md delete mode 100644 docs/content/doc/developers.zh-cn.md delete mode 100644 docs/content/doc/developers.zh-tw.md create mode 100644 docs/content/doc/development.en-us.md rename docs/content/doc/{advanced.en-us.md => development.zh-cn.md} (50%) rename docs/content/doc/{advanced.zh-cn.md => development.zh-tw.md} (50%) rename docs/content/doc/{developers => development}/api-usage.en-us.md (99%) rename docs/content/doc/{developers => development}/api-usage.zh-cn.md (99%) rename docs/content/doc/{developers => development}/hacking-on-gitea.en-us.md (98%) rename docs/content/doc/{developers => development}/hacking-on-gitea.zh-cn.md (98%) rename docs/content/doc/{developers => development}/integrations.en-us.md (97%) rename docs/content/doc/{developers => development}/integrations.zh-tw.md (96%) rename docs/content/doc/{developers => development}/migrations.en-us.md (98%) rename docs/content/doc/{developers => development}/migrations.zh-tw.md (98%) rename docs/content/doc/{developers => development}/oauth2-provider.en-us.md (99%) rename docs/content/doc/{developers => development}/oauth2-provider.zh-tw.md (99%) delete mode 100644 docs/content/doc/features.en-us.md delete mode 100644 docs/content/doc/features.zh-cn.md delete mode 100644 docs/content/doc/features.zh-tw.md rename docs/content/doc/{features => installation}/comparison.en-us.md (99%) rename docs/content/doc/{features => installation}/comparison.zh-cn.md (99%) rename docs/content/doc/{features => installation}/comparison.zh-tw.md (99%) rename docs/content/doc/{upgrade/from-gitea.en-us.md => installation/upgrade-from-gitea.en-us.md} (97%) rename docs/content/doc/{upgrade/from-gogs.en-us.md => installation/upgrade-from-gogs.en-us.md} (98%) rename docs/content/doc/{upgrade/from-gogs.fr-fr.md => installation/upgrade-from-gogs.fr-fr.md} (98%) rename docs/content/doc/{upgrade/from-gogs.zh-cn.md => installation/upgrade-from-gogs.zh-cn.md} (95%) rename docs/content/doc/{upgrade/from-gogs.zh-tw.md => installation/upgrade-from-gogs.zh-tw.md} (98%) delete mode 100644 docs/content/doc/upgrade.en-us.md delete mode 100644 docs/content/doc/upgrade.fr-fr.md delete mode 100644 docs/content/doc/upgrade.zh-cn.md delete mode 100644 docs/content/doc/upgrade.zh-tw.md rename docs/content/doc/{features => usage}/authentication.en-us.md (99%) rename docs/content/doc/{features => usage}/authentication.zh-cn.md (98%) rename docs/content/doc/{features => usage}/authentication.zh-tw.md (90%) rename docs/content/doc/{advanced => usage}/clone-filter.en-us.md (98%) rename docs/content/doc/{advanced => usage}/protected-tags.en-us.md (99%) rename docs/content/doc/{advanced => usage}/repo-mirror.en-us.md (99%) rename docs/content/doc/{secrets/overview.en-us.md => usage/secrets.en-us.md} (91%) rename docs/content/doc/{features => usage}/webhooks.en-us.md (99%) rename docs/content/doc/{features => usage}/webhooks.zh-cn.md (96%) rename docs/content/doc/{features => usage}/webhooks.zh-tw.md (99%) diff --git a/Makefile b/Makefile index 58873ccd92..462bb657cc 100644 --- a/Makefile +++ b/Makefile @@ -77,6 +77,7 @@ ifeq ($(RACE_ENABLED),true) endif STORED_VERSION_FILE := VERSION +HUGO_VERSION ?= 0.111.3 ifneq ($(DRONE_TAG),) VERSION ?= $(subst v,,$(DRONE_TAG)) @@ -817,7 +818,7 @@ release-docs: | $(DIST_DIRS) docs .PHONY: docs docs: @hash hugo > /dev/null 2>&1; if [ $$? -ne 0 ]; then \ - curl -sL https://github.com/gohugoio/hugo/releases/download/v0.74.3/hugo_0.74.3_Linux-64bit.tar.gz | tar zxf - -C /tmp && mv /tmp/hugo /usr/bin/hugo && chmod +x /usr/bin/hugo; \ + curl -sL https://github.com/gohugoio/hugo/releases/download/v$(HUGO_VERSION)/hugo_$(HUGO_VERSION)_Linux-64bit.tar.gz | tar zxf - -C /tmp && mv /tmp/hugo /usr/bin/hugo && chmod +x /usr/bin/hugo; \ fi cd docs; make trans-copy clean build-offline; diff --git a/docs/Makefile b/docs/Makefile index 0178cd3587..6a5a374845 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ THEME := themes/gitea PUBLIC := public ARCHIVE := https://dl.gitea.com/theme/main.tar.gz -HUGO_PACKAGE := github.com/gohugoio/hugo@v0.82.0 +HUGO_PACKAGE := github.com/gohugoio/hugo@v0.111.3 .PHONY: all all: build diff --git a/docs/config.yaml b/docs/config.yaml index 26f096b1cf..fbc4bc9a98 100644 --- a/docs/config.yaml +++ b/docs/config.yaml @@ -26,6 +26,11 @@ params: repo: "https://github.com/go-gitea/gitea" docContentPath: "docs/content" +markup: + tableOfContents: + startLevel: 1 + endLevel: 9 + outputs: home: - HTML diff --git a/docs/content/doc/administration.en-us.md b/docs/content/doc/administration.en-us.md new file mode 100644 index 0000000000..5d3ba385d9 --- /dev/null +++ b/docs/content/doc/administration.en-us.md @@ -0,0 +1,14 @@ +--- +date: "2016-12-01T16:00:00+02:00" +title: "Administration" +slug: "administration" +weight: 30 +toc: false +draft: false +menu: + sidebar: + name: "Administration" + weight: 20 + collapse: true + identifier: "administration" +--- diff --git a/docs/content/doc/advanced.fr-fr.md b/docs/content/doc/administration.fr-fr.md similarity index 64% rename from docs/content/doc/advanced.fr-fr.md rename to docs/content/doc/administration.fr-fr.md index 04734a8f81..957ff7b194 100644 --- a/docs/content/doc/advanced.fr-fr.md +++ b/docs/content/doc/administration.fr-fr.md @@ -1,13 +1,13 @@ --- date: "2017-08-23T09:00:00+02:00" title: "Avancé" -slug: "advanced" +slug: "administration" weight: 30 toc: false draft: false menu: sidebar: name: "Avancé" - weight: 40 - identifier: "advanced" + weight: 20 + identifier: "administration" --- diff --git a/docs/content/doc/administration.zh-cn.md b/docs/content/doc/administration.zh-cn.md new file mode 100644 index 0000000000..6e032d3266 --- /dev/null +++ b/docs/content/doc/administration.zh-cn.md @@ -0,0 +1,13 @@ +--- +date: "2016-12-01T16:00:00+02:00" +title: "运维" +slug: "administration" +weight: 30 +toc: false +draft: false +menu: + sidebar: + name: "运维" + weight: 20 + identifier: "administration" +--- diff --git a/docs/content/doc/administration.zh-tw.md b/docs/content/doc/administration.zh-tw.md new file mode 100644 index 0000000000..daf8e3f105 --- /dev/null +++ b/docs/content/doc/administration.zh-tw.md @@ -0,0 +1,13 @@ +--- +date: "2016-12-01T16:00:00+02:00" +title: "運維" +slug: "administration" +weight: 30 +toc: false +draft: false +menu: + sidebar: + name: "運維" + weight: 20 + identifier: "administration" +--- diff --git a/docs/content/doc/advanced/adding-legal-pages.en-us.md b/docs/content/doc/administration/adding-legal-pages.en-us.md similarity index 96% rename from docs/content/doc/advanced/adding-legal-pages.en-us.md rename to docs/content/doc/administration/adding-legal-pages.en-us.md index 5816fdbf3f..9ba8c4fd81 100644 --- a/docs/content/doc/advanced/adding-legal-pages.en-us.md +++ b/docs/content/doc/administration/adding-legal-pages.en-us.md @@ -7,10 +7,10 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Adding Legal Pages" identifier: "adding-legal-pages" - weight: 9 + weight: 110 --- Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance. diff --git a/docs/content/doc/usage/backup-and-restore.en-us.md b/docs/content/doc/administration/backup-and-restore.en-us.md similarity index 99% rename from docs/content/doc/usage/backup-and-restore.en-us.md rename to docs/content/doc/administration/backup-and-restore.en-us.md index cae097082e..16e8654b74 100644 --- a/docs/content/doc/usage/backup-and-restore.en-us.md +++ b/docs/content/doc/administration/backup-and-restore.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "Backup and Restore" weight: 11 identifier: "backup-and-restore" diff --git a/docs/content/doc/usage/backup-and-restore.zh-cn.md b/docs/content/doc/administration/backup-and-restore.zh-cn.md similarity index 98% rename from docs/content/doc/usage/backup-and-restore.zh-cn.md rename to docs/content/doc/administration/backup-and-restore.zh-cn.md index 43ad108d95..602657f419 100644 --- a/docs/content/doc/usage/backup-and-restore.zh-cn.md +++ b/docs/content/doc/administration/backup-and-restore.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "备份与恢复" weight: 11 identifier: "backup-and-restore" diff --git a/docs/content/doc/usage/backup-and-restore.zh-tw.md b/docs/content/doc/administration/backup-and-restore.zh-tw.md similarity index 98% rename from docs/content/doc/usage/backup-and-restore.zh-tw.md rename to docs/content/doc/administration/backup-and-restore.zh-tw.md index 18e244b19c..cab95217a3 100644 --- a/docs/content/doc/usage/backup-and-restore.zh-tw.md +++ b/docs/content/doc/administration/backup-and-restore.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "備份與還原" weight: 11 identifier: "backup-and-restore" diff --git a/docs/content/doc/advanced/cmd-embedded.en-us.md b/docs/content/doc/administration/cmd-embedded.en-us.md similarity index 96% rename from docs/content/doc/advanced/cmd-embedded.en-us.md rename to docs/content/doc/administration/cmd-embedded.en-us.md index 63ab83bd36..cad0de9787 100644 --- a/docs/content/doc/advanced/cmd-embedded.en-us.md +++ b/docs/content/doc/administration/cmd-embedded.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Embedded data extraction tool" - weight: 40 + weight: 20 identifier: "cmd-embedded" --- @@ -21,7 +21,7 @@ menu: Gitea's executable contains all the resources required to run: templates, images, style-sheets and translations. Any of them can be overridden by placing a replacement in a matching path -inside the `custom` directory (see [Customizing Gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}})). +inside the `custom` directory (see [Customizing Gitea]({{< relref "doc/administration/customizing-gitea.en-us.md" >}})). To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI can be used from the OS shell interface. @@ -85,7 +85,7 @@ The default is the current directory. The `--custom` flag tells Gitea to extract the files directly into the `custom` directory. For this to work, the command needs to know the location of the `app.ini` configuration file (`--config`) and, depending of the configuration, be ran from the directory where -Gitea normally starts. See [Customizing Gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}) for details. +Gitea normally starts. See [Customizing Gitea]({{< relref "doc/administration/customizing-gitea.en-us.md" >}}) for details. The `--overwrite` flag allows any existing files in the destination directory to be overwritten. diff --git a/docs/content/doc/usage/command-line.en-us.md b/docs/content/doc/administration/command-line.en-us.md similarity index 99% rename from docs/content/doc/usage/command-line.en-us.md rename to docs/content/doc/administration/command-line.en-us.md index 70efebd203..3dfad62f3d 100644 --- a/docs/content/doc/usage/command-line.en-us.md +++ b/docs/content/doc/administration/command-line.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "Command Line" - weight: 10 + weight: 1 identifier: "command-line" --- diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/administration/config-cheat-sheet.en-us.md similarity index 99% rename from docs/content/doc/advanced/config-cheat-sheet.en-us.md rename to docs/content/doc/administration/config-cheat-sheet.en-us.md index aca591787e..886aa11186 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/administration/config-cheat-sheet.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Config Cheat Sheet" - weight: 20 + weight: 30 identifier: "config-cheat-sheet" --- @@ -753,7 +753,7 @@ and - `FORCE_TRUST_SERVER_CERT`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe. Consider adding the certificate to the system trust store instead. - `USER`: **\**: Username of mailing user (usually the sender's e-mail address). - `PASSWD`: **\**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password. - - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup]({{< relref "doc/usage/email-setup.en-us.md" >}}) for more information. + - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup]({{< relref "doc/administration/email-setup.en-us.md" >}}) for more information. - `ENABLE_HELO`: **true**: Enable HELO operation. - `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname. - `FROM`: **\**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \ format. diff --git a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md b/docs/content/doc/administration/config-cheat-sheet.zh-cn.md similarity index 99% rename from docs/content/doc/advanced/config-cheat-sheet.zh-cn.md rename to docs/content/doc/administration/config-cheat-sheet.zh-cn.md index 84186d0e9a..9a32238c1a 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md +++ b/docs/content/doc/administration/config-cheat-sheet.zh-cn.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "配置说明" - weight: 20 + weight: 30 identifier: "config-cheat-sheet" --- diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/administration/customizing-gitea.en-us.md similarity index 97% rename from docs/content/doc/advanced/customizing-gitea.en-us.md rename to docs/content/doc/administration/customizing-gitea.en-us.md index 4c0235c04a..9a4c5639a3 100644 --- a/docs/content/doc/advanced/customizing-gitea.en-us.md +++ b/docs/content/doc/administration/customizing-gitea.en-us.md @@ -7,10 +7,10 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Customizing Gitea" identifier: "customizing-gitea" - weight: 9 + weight: 100 --- # Customizing Gitea @@ -84,7 +84,7 @@ directory at the top of this document). Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/), which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory. -To obtain any embedded file (including templates), the [`gitea embedded` tool]({{< relref "doc/advanced/cmd-embedded.en-us.md" >}}) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using). +To obtain any embedded file (including templates), the [`gitea embedded` tool]({{< relref "doc/administration/cmd-embedded.en-us.md" >}}) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using). Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and shouldn't be touched without fully understanding these components. diff --git a/docs/content/doc/advanced/customizing-gitea.zh-cn.md b/docs/content/doc/administration/customizing-gitea.zh-cn.md similarity index 99% rename from docs/content/doc/advanced/customizing-gitea.zh-cn.md rename to docs/content/doc/administration/customizing-gitea.zh-cn.md index bb55f35e17..200f958245 100644 --- a/docs/content/doc/advanced/customizing-gitea.zh-cn.md +++ b/docs/content/doc/administration/customizing-gitea.zh-cn.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "自定义 Gitea 配置" - weight: 9 + weight: 100 identifier: "customizing-gitea" --- diff --git a/docs/content/doc/usage/email-setup.en-us.md b/docs/content/doc/administration/email-setup.en-us.md similarity index 97% rename from docs/content/doc/usage/email-setup.en-us.md rename to docs/content/doc/administration/email-setup.en-us.md index 6d6b18786c..27ecb0d2f2 100644 --- a/docs/content/doc/usage/email-setup.en-us.md +++ b/docs/content/doc/administration/email-setup.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "Email setup" weight: 12 identifier: "email-setup" @@ -58,7 +58,7 @@ Restart Gitea for the configuration changes to take effect. To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration. -For the full list of options check the [Config Cheat Sheet]({{< relref "doc/advanced/config-cheat-sheet.en-us.md" >}}) +For the full list of options check the [Config Cheat Sheet]({{< relref "doc/administration/config-cheat-sheet.en-us.md" >}}) Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through: diff --git a/docs/content/doc/advanced/environment-variables.en-us.md b/docs/content/doc/administration/environment-variables.en-us.md similarity index 97% rename from docs/content/doc/advanced/environment-variables.en-us.md rename to docs/content/doc/administration/environment-variables.en-us.md index 288358f69d..17a0250164 100644 --- a/docs/content/doc/advanced/environment-variables.en-us.md +++ b/docs/content/doc/administration/environment-variables.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Environment variables" - weight: 20 + weight: 10 identifier: "environment-variables" --- diff --git a/docs/content/doc/advanced/environment-variables.zh-cn.md b/docs/content/doc/administration/environment-variables.zh-cn.md similarity index 97% rename from docs/content/doc/advanced/environment-variables.zh-cn.md rename to docs/content/doc/administration/environment-variables.zh-cn.md index 3de8dcfbc7..c8a8fcba71 100644 --- a/docs/content/doc/advanced/environment-variables.zh-cn.md +++ b/docs/content/doc/administration/environment-variables.zh-cn.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "环境变量清单" - weight: 20 + weight: 10 identifier: "environment-variables" --- diff --git a/docs/content/doc/advanced/external-renderers.en-us.md b/docs/content/doc/administration/external-renderers.en-us.md similarity index 99% rename from docs/content/doc/advanced/external-renderers.en-us.md rename to docs/content/doc/administration/external-renderers.en-us.md index 244fcd7c83..da2f493c71 100644 --- a/docs/content/doc/advanced/external-renderers.en-us.md +++ b/docs/content/doc/administration/external-renderers.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "External renderers" - weight: 40 + weight: 60 identifier: "external-renderers" --- diff --git a/docs/content/doc/usage/fail2ban-setup.en-us.md b/docs/content/doc/administration/fail2ban-setup.en-us.md similarity index 99% rename from docs/content/doc/usage/fail2ban-setup.en-us.md rename to docs/content/doc/administration/fail2ban-setup.en-us.md index f00551e3ef..746222420a 100644 --- a/docs/content/doc/usage/fail2ban-setup.en-us.md +++ b/docs/content/doc/administration/fail2ban-setup.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "Fail2ban setup" weight: 16 identifier: "fail2ban-setup" diff --git a/docs/content/doc/usage/fail2ban-setup.zh-cn.md b/docs/content/doc/administration/fail2ban-setup.zh-cn.md similarity index 99% rename from docs/content/doc/usage/fail2ban-setup.zh-cn.md rename to docs/content/doc/administration/fail2ban-setup.zh-cn.md index 446d192aa6..37a0838b24 100644 --- a/docs/content/doc/usage/fail2ban-setup.zh-cn.md +++ b/docs/content/doc/administration/fail2ban-setup.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "设置 Fail2ban" weight: 16 identifier: "fail2ban-setup" diff --git a/docs/content/doc/usage/git-lfs-support.en-us.md b/docs/content/doc/administration/git-lfs-support.en-us.md similarity index 95% rename from docs/content/doc/usage/git-lfs-support.en-us.md rename to docs/content/doc/administration/git-lfs-support.en-us.md index 8b2c997bf9..86cc3a5028 100644 --- a/docs/content/doc/usage/git-lfs-support.en-us.md +++ b/docs/content/doc/administration/git-lfs-support.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "Git LFS setup" weight: 12 identifier: "git-lfs-setup" diff --git a/docs/content/doc/usage/https-support.en-us.md b/docs/content/doc/administration/https-support.en-us.md similarity index 97% rename from docs/content/doc/usage/https-support.en-us.md rename to docs/content/doc/administration/https-support.en-us.md index 7c9024743d..fd7badc64a 100644 --- a/docs/content/doc/usage/https-support.en-us.md +++ b/docs/content/doc/administration/https-support.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "HTTPS setup" weight: 12 identifier: "https-setup" @@ -24,7 +24,7 @@ menu: Before you enable HTTPS, make sure that you have valid SSL/TLS certificates. You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate. -If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide]({{< relref "doc/usage/reverse-proxies.en-us.md" >}}). +If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide]({{< relref "doc/administration/reverse-proxies.en-us.md" >}}). To use Gitea's built-in HTTPS support, you must change your `app.ini` file: diff --git a/docs/content/doc/advanced/logging-documentation.en-us.md b/docs/content/doc/administration/logging-documentation.en-us.md similarity index 99% rename from docs/content/doc/advanced/logging-documentation.en-us.md rename to docs/content/doc/administration/logging-documentation.en-us.md index 145c8c320c..8d49ff3f14 100644 --- a/docs/content/doc/advanced/logging-documentation.en-us.md +++ b/docs/content/doc/administration/logging-documentation.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Logging Configuration" - weight: 55 + weight: 40 identifier: "logging-configuration" --- diff --git a/docs/content/doc/advanced/mail-templates.en-us.md b/docs/content/doc/administration/mail-templates.en-us.md similarity index 99% rename from docs/content/doc/advanced/mail-templates.en-us.md rename to docs/content/doc/administration/mail-templates.en-us.md index bd419a617b..a4dc7453ee 100644 --- a/docs/content/doc/advanced/mail-templates.en-us.md +++ b/docs/content/doc/administration/mail-templates.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Mail templates" weight: 45 identifier: "mail-templates" diff --git a/docs/content/doc/advanced/repo-indexer.en-us.md b/docs/content/doc/administration/repo-indexer.en-us.md similarity index 98% rename from docs/content/doc/advanced/repo-indexer.en-us.md rename to docs/content/doc/administration/repo-indexer.en-us.md index 4b81bd27e9..11ce547a0d 100644 --- a/docs/content/doc/advanced/repo-indexer.en-us.md +++ b/docs/content/doc/administration/repo-indexer.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Repository indexer" weight: 45 identifier: "repo-indexer" diff --git a/docs/content/doc/usage/reverse-proxies.en-us.md b/docs/content/doc/administration/reverse-proxies.en-us.md similarity index 99% rename from docs/content/doc/usage/reverse-proxies.en-us.md rename to docs/content/doc/administration/reverse-proxies.en-us.md index b8cebee574..7b30ab78aa 100644 --- a/docs/content/doc/usage/reverse-proxies.en-us.md +++ b/docs/content/doc/administration/reverse-proxies.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "Reverse Proxies" weight: 16 identifier: "reverse-proxies" @@ -48,7 +48,7 @@ server { server_name git.example.com; # Note: Trailing slash - location /git/ { + location /git/ { # Note: Trailing slash proxy_pass http://localhost:3000/; proxy_set_header Host $host; diff --git a/docs/content/doc/usage/reverse-proxies.zh-cn.md b/docs/content/doc/administration/reverse-proxies.zh-cn.md similarity index 98% rename from docs/content/doc/usage/reverse-proxies.zh-cn.md rename to docs/content/doc/administration/reverse-proxies.zh-cn.md index f6d92e2a61..1355d09e8a 100644 --- a/docs/content/doc/usage/reverse-proxies.zh-cn.md +++ b/docs/content/doc/administration/reverse-proxies.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "usage" + parent: "administration" name: "反向代理" weight: 16 identifier: "reverse-proxies" @@ -48,7 +48,7 @@ server { server_name git.example.com; # 注意: /git/ 最后需要有一个路径符号 - location /git/ { + location /git/ { # 注意: 反向代理后端 URL 的最后需要有一个路径符号 proxy_pass http://localhost:3000/; proxy_set_header Host $host; diff --git a/docs/content/doc/advanced/search-engines-indexation.en-us.md b/docs/content/doc/administration/search-engines-indexation.en-us.md similarity index 90% rename from docs/content/doc/advanced/search-engines-indexation.en-us.md rename to docs/content/doc/administration/search-engines-indexation.en-us.md index ec367b74de..cabedb3a5d 100644 --- a/docs/content/doc/advanced/search-engines-indexation.en-us.md +++ b/docs/content/doc/administration/search-engines-indexation.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "Search Engines Indexation" weight: 60 identifier: "search-engines-indexation" @@ -21,7 +21,7 @@ If you don't want your repository to be visible for search engines read further. ## Block search engines indexation using robots.txt To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations, -create a file called `robots.txt` in the [`custom` folder or `CustomPath`]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}) +create a file called `robots.txt` in the [`custom` folder or `CustomPath`]({{< relref "doc/administration/customizing-gitea.en-us.md" >}}) Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt). diff --git a/docs/content/doc/advanced/signing.en-us.md b/docs/content/doc/administration/signing.en-us.md similarity index 99% rename from docs/content/doc/advanced/signing.en-us.md rename to docs/content/doc/administration/signing.en-us.md index 83a8b386b9..8dd4ffdfb7 100644 --- a/docs/content/doc/advanced/signing.en-us.md +++ b/docs/content/doc/administration/signing.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "administration" name: "GPG Commit Signatures" - weight: 20 + weight: 50 identifier: "signing" --- diff --git a/docs/content/doc/advanced.zh-tw.md b/docs/content/doc/advanced.zh-tw.md deleted file mode 100644 index ebfe519780..0000000000 --- a/docs/content/doc/advanced.zh-tw.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "進階" -slug: "advanced" -weight: 30 -toc: false -draft: false -menu: - sidebar: - name: "進階" - weight: 40 - identifier: "advanced" ---- diff --git a/docs/content/doc/translation.en-us.md b/docs/content/doc/contributing.en-us.md similarity index 52% rename from docs/content/doc/translation.en-us.md rename to docs/content/doc/contributing.en-us.md index c281088503..6cc96d91b2 100644 --- a/docs/content/doc/translation.en-us.md +++ b/docs/content/doc/contributing.en-us.md @@ -1,13 +1,13 @@ --- date: "2021-01-22T00:00:00+02:00" -title: "Translation" -slug: "translation" +title: "Contributing" +slug: "contributing" weight: 35 toc: false draft: false menu: sidebar: - name: "Translation" + name: "Contributing" weight: 50 - identifier: "translation" + identifier: "contributing" --- diff --git a/docs/content/doc/translation.de-de.md b/docs/content/doc/contributing.fr-fr.md similarity index 75% rename from docs/content/doc/translation.de-de.md rename to docs/content/doc/contributing.fr-fr.md index 3470faa59b..3175668329 100644 --- a/docs/content/doc/translation.de-de.md +++ b/docs/content/doc/contributing.fr-fr.md @@ -1,7 +1,7 @@ --- date: "2021-01-22T00:00:00+02:00" title: "Übersetzung" -slug: "translation" +slug: "contributing" weight: 35 toc: false draft: false @@ -9,5 +9,5 @@ menu: sidebar: name: "Übersetzung" weight: 50 - identifier: "translation" + identifier: "contributing" --- diff --git a/docs/content/doc/translation.zh-tw.md b/docs/content/doc/contributing.zh-tw.md similarity index 55% rename from docs/content/doc/translation.zh-tw.md rename to docs/content/doc/contributing.zh-tw.md index 5374e87e89..73a3f94a7c 100644 --- a/docs/content/doc/translation.zh-tw.md +++ b/docs/content/doc/contributing.zh-tw.md @@ -1,13 +1,13 @@ --- date: "2021-01-22T00:00:00+02:00" -title: "翻譯" -slug: "translation" +title: "貢獻" +slug: "contributing" weight: 35 toc: false draft: false menu: sidebar: - name: "翻譯" + name: "貢獻" weight: 50 - identifier: "translation" + identifier: "contributing" --- diff --git a/docs/content/doc/developers/guidelines-backend.en-us.md b/docs/content/doc/contributing/guidelines-backend.en-us.md similarity index 99% rename from docs/content/doc/developers/guidelines-backend.en-us.md rename to docs/content/doc/contributing/guidelines-backend.en-us.md index f35111522f..6ae0ba517d 100644 --- a/docs/content/doc/developers/guidelines-backend.en-us.md +++ b/docs/content/doc/contributing/guidelines-backend.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "contributing" name: "Guidelines for Backend" weight: 20 identifier: "guidelines-backend" diff --git a/docs/content/doc/developers/guidelines-frontend.en-us.md b/docs/content/doc/contributing/guidelines-frontend.en-us.md similarity index 99% rename from docs/content/doc/developers/guidelines-frontend.en-us.md rename to docs/content/doc/contributing/guidelines-frontend.en-us.md index e2bdc7adcb..36c88739ec 100644 --- a/docs/content/doc/developers/guidelines-frontend.en-us.md +++ b/docs/content/doc/contributing/guidelines-frontend.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "contributing" name: "Guidelines for Frontend" weight: 20 identifier: "guidelines-frontend" diff --git a/docs/content/doc/developers/guidelines-refactoring.en-us.md b/docs/content/doc/contributing/guidelines-refactoring.en-us.md similarity index 98% rename from docs/content/doc/developers/guidelines-refactoring.en-us.md rename to docs/content/doc/contributing/guidelines-refactoring.en-us.md index 29025f25f7..913ce8d9bb 100644 --- a/docs/content/doc/developers/guidelines-refactoring.en-us.md +++ b/docs/content/doc/contributing/guidelines-refactoring.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "contributing" name: "Guidelines for Refactoring" weight: 20 identifier: "guidelines-refactoring" diff --git a/docs/content/doc/features/localization.en-us.md b/docs/content/doc/contributing/localization.en-us.md similarity index 97% rename from docs/content/doc/features/localization.en-us.md rename to docs/content/doc/contributing/localization.en-us.md index e57233a622..3006ca599b 100644 --- a/docs/content/doc/features/localization.en-us.md +++ b/docs/content/doc/contributing/localization.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "contributing" name: "Localization" weight: 20 identifier: "localization" diff --git a/docs/content/doc/features/localization.zh-cn.md b/docs/content/doc/contributing/localization.zh-cn.md similarity index 97% rename from docs/content/doc/features/localization.zh-cn.md rename to docs/content/doc/contributing/localization.zh-cn.md index dd2dc1fa90..10df44042f 100644 --- a/docs/content/doc/features/localization.zh-cn.md +++ b/docs/content/doc/contributing/localization.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "contributing" name: "本地化" weight: 20 identifier: "localization" diff --git a/docs/content/doc/features/localization.zh-tw.md b/docs/content/doc/contributing/localization.zh-tw.md similarity index 97% rename from docs/content/doc/features/localization.zh-tw.md rename to docs/content/doc/contributing/localization.zh-tw.md index 7bb3a6e6a2..562aa4ecaf 100644 --- a/docs/content/doc/features/localization.zh-tw.md +++ b/docs/content/doc/contributing/localization.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "contributing" name: "在地化" weight: 20 identifier: "localization" diff --git a/docs/content/doc/translation/guidelines.de-de.md b/docs/content/doc/contributing/translation.de-de.md similarity index 98% rename from docs/content/doc/translation/guidelines.de-de.md rename to docs/content/doc/contributing/translation.de-de.md index 3fa7185562..16cb267931 100644 --- a/docs/content/doc/translation/guidelines.de-de.md +++ b/docs/content/doc/contributing/translation.de-de.md @@ -6,7 +6,7 @@ toc: true draft: false menu: sidebar: - parent: "translation" + parent: "contributing" name: "Übersetzungsrichtlinien" weight: 70 identifier: "translation-guidelines" diff --git a/docs/content/doc/translation/guidelines.en-us.md b/docs/content/doc/contributing/translation.en-us.md similarity index 93% rename from docs/content/doc/translation/guidelines.en-us.md rename to docs/content/doc/contributing/translation.en-us.md index f995743627..23ff18a5b2 100644 --- a/docs/content/doc/translation/guidelines.en-us.md +++ b/docs/content/doc/contributing/translation.en-us.md @@ -6,7 +6,7 @@ toc: true draft: false menu: sidebar: - parent: "translation" + parent: "contributing" name: "Translation Guidelines" weight: 70 identifier: "translation-guidelines" diff --git a/docs/content/doc/developers.en-us.md b/docs/content/doc/developers.en-us.md deleted file mode 100644 index 917049e5df..0000000000 --- a/docs/content/doc/developers.en-us.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "Developers" -slug: "developers" -weight: 40 -toc: false -draft: false -menu: - sidebar: - name: "Developers" - weight: 55 - identifier: "developers" ---- diff --git a/docs/content/doc/developers.zh-cn.md b/docs/content/doc/developers.zh-cn.md deleted file mode 100644 index 97fb3a9782..0000000000 --- a/docs/content/doc/developers.zh-cn.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "开发者" -slug: "developers" -weight: 40 -toc: false -draft: false -menu: - sidebar: - name: "开发者" - weight: 55 - identifier: "developers" ---- diff --git a/docs/content/doc/developers.zh-tw.md b/docs/content/doc/developers.zh-tw.md deleted file mode 100644 index c9ce6634ad..0000000000 --- a/docs/content/doc/developers.zh-tw.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "開發人員" -slug: "developers" -weight: 40 -toc: false -draft: false -menu: - sidebar: - name: "開發人員" - weight: 55 - identifier: "developers" ---- diff --git a/docs/content/doc/development.en-us.md b/docs/content/doc/development.en-us.md new file mode 100644 index 0000000000..e9e8b9c816 --- /dev/null +++ b/docs/content/doc/development.en-us.md @@ -0,0 +1,13 @@ +--- +date: "2016-12-01T16:00:00+02:00" +title: "Development" +slug: "development" +weight: 40 +toc: false +draft: false +menu: + sidebar: + name: "Development" + weight: 40 + identifier: "development" +--- diff --git a/docs/content/doc/advanced.en-us.md b/docs/content/doc/development.zh-cn.md similarity index 50% rename from docs/content/doc/advanced.en-us.md rename to docs/content/doc/development.zh-cn.md index de2bfeed6f..bbdaec4d1d 100644 --- a/docs/content/doc/advanced.en-us.md +++ b/docs/content/doc/development.zh-cn.md @@ -1,13 +1,13 @@ --- date: "2016-12-01T16:00:00+02:00" -title: "Advanced" -slug: "advanced" -weight: 30 +title: "开发" +slug: "development" +weight: 40 toc: false draft: false menu: sidebar: - name: "Advanced" + name: "开发" weight: 40 - identifier: "advanced" + identifier: "development" --- diff --git a/docs/content/doc/advanced.zh-cn.md b/docs/content/doc/development.zh-tw.md similarity index 50% rename from docs/content/doc/advanced.zh-cn.md rename to docs/content/doc/development.zh-tw.md index 1f7ebf81e7..a0fbbf219f 100644 --- a/docs/content/doc/advanced.zh-cn.md +++ b/docs/content/doc/development.zh-tw.md @@ -1,13 +1,13 @@ --- date: "2016-12-01T16:00:00+02:00" -title: "进阶" -slug: "advanced" -weight: 30 +title: "開發" +slug: "development" +weight: 40 toc: false draft: false menu: sidebar: - name: "进阶" + name: "開發" weight: 40 - identifier: "advanced" + identifier: "development" --- diff --git a/docs/content/doc/developers/api-usage.en-us.md b/docs/content/doc/development/api-usage.en-us.md similarity index 99% rename from docs/content/doc/developers/api-usage.en-us.md rename to docs/content/doc/development/api-usage.en-us.md index a7b87f8f08..641012607b 100644 --- a/docs/content/doc/developers/api-usage.en-us.md +++ b/docs/content/doc/development/api-usage.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "API Usage" weight: 40 identifier: "api-usage" diff --git a/docs/content/doc/developers/api-usage.zh-cn.md b/docs/content/doc/development/api-usage.zh-cn.md similarity index 99% rename from docs/content/doc/developers/api-usage.zh-cn.md rename to docs/content/doc/development/api-usage.zh-cn.md index c998361115..b0821039ff 100644 --- a/docs/content/doc/developers/api-usage.zh-cn.md +++ b/docs/content/doc/development/api-usage.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "API 使用指南" weight: 40 identifier: "api-usage" diff --git a/docs/content/doc/developers/hacking-on-gitea.en-us.md b/docs/content/doc/development/hacking-on-gitea.en-us.md similarity index 98% rename from docs/content/doc/developers/hacking-on-gitea.en-us.md rename to docs/content/doc/development/hacking-on-gitea.en-us.md index 3283240c98..da38d238ac 100644 --- a/docs/content/doc/developers/hacking-on-gitea.en-us.md +++ b/docs/content/doc/development/hacking-on-gitea.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "Hacking on Gitea" weight: 10 identifier: "hacking-on-gitea" @@ -177,7 +177,7 @@ server as mentioned above. ### Working on JS and CSS -Frontend development should follow [Guidelines for Frontend Development]({{< relref "doc/developers/guidelines-frontend.en-us.md" >}}) +Frontend development should follow [Guidelines for Frontend Development]({{< relref "doc/contributing/guidelines-frontend.en-us.md" >}}) To build with frontend resources, either use the `watch-frontend` target mentioned above or just build once: @@ -264,8 +264,8 @@ OpenAPI 3 documentation. When creating new configuration options, it is not enough to add them to the `modules/setting` files. You should add information to `custom/conf/app.ini` and to the -configuration cheat sheet -found in `docs/content/doc/advanced/config-cheat-sheet.en-us.md` +configuration cheat sheet +found in `docs/content/doc/administer/config-cheat-sheet.en-us.md` ### Changing the logo diff --git a/docs/content/doc/developers/hacking-on-gitea.zh-cn.md b/docs/content/doc/development/hacking-on-gitea.zh-cn.md similarity index 98% rename from docs/content/doc/developers/hacking-on-gitea.zh-cn.md rename to docs/content/doc/development/hacking-on-gitea.zh-cn.md index 9c9141bf50..c63d0c4685 100644 --- a/docs/content/doc/developers/hacking-on-gitea.zh-cn.md +++ b/docs/content/doc/development/hacking-on-gitea.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "玩转 Gitea" weight: 10 identifier: "hacking-on-gitea" @@ -166,7 +166,7 @@ make lint-backend ### 处理 JS 和 CSS -前端开发应遵循 [Guidelines for Frontend Development]({{ < 相关参考 "doc/developers/guidelines-frontend.en-us.md" > }}) +前端开发应遵循 [Guidelines for Frontend Development]({{ < 相关参考 "doc/development/guidelines-frontend.en-us.md" > }}) 要使用前端资源构建，请使用上面提到的“watch-frontend”目标或只构建一次： @@ -247,7 +247,7 @@ make swagger-check ### 创建新的配置选项 创建新的配置选项时，将它们添加到 `modules/setting` 的对应文件。您应该将信息添加到 `custom/conf/app.ini` -并到 配置备忘单 +并到 配置备忘单 在 `docs/content/doc/advanced/config-cheat-sheet.en-us.md` 中找到 ### 更改Logo diff --git a/docs/content/doc/developers/integrations.en-us.md b/docs/content/doc/development/integrations.en-us.md similarity index 97% rename from docs/content/doc/developers/integrations.en-us.md rename to docs/content/doc/development/integrations.en-us.md index 15d5e7e59e..c6321e2d07 100644 --- a/docs/content/doc/developers/integrations.en-us.md +++ b/docs/content/doc/development/integrations.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "Integrations" weight: 65 identifier: "integrations" diff --git a/docs/content/doc/developers/integrations.zh-tw.md b/docs/content/doc/development/integrations.zh-tw.md similarity index 96% rename from docs/content/doc/developers/integrations.zh-tw.md rename to docs/content/doc/development/integrations.zh-tw.md index 6991ec4ae8..eb828592b4 100644 --- a/docs/content/doc/developers/integrations.zh-tw.md +++ b/docs/content/doc/development/integrations.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "整合" weight: 65 identifier: "integrations" diff --git a/docs/content/doc/developers/migrations.en-us.md b/docs/content/doc/development/migrations.en-us.md similarity index 98% rename from docs/content/doc/developers/migrations.en-us.md rename to docs/content/doc/development/migrations.en-us.md index 168af1f7fa..8647bdbc4b 100644 --- a/docs/content/doc/developers/migrations.en-us.md +++ b/docs/content/doc/development/migrations.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "Migrations Interfaces" weight: 55 identifier: "migrations-interfaces" diff --git a/docs/content/doc/developers/migrations.zh-tw.md b/docs/content/doc/development/migrations.zh-tw.md similarity index 98% rename from docs/content/doc/developers/migrations.zh-tw.md rename to docs/content/doc/development/migrations.zh-tw.md index 173c01a464..09af350d35 100644 --- a/docs/content/doc/developers/migrations.zh-tw.md +++ b/docs/content/doc/development/migrations.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "遷移介面" weight: 55 identifier: "migrations-interfaces" diff --git a/docs/content/doc/developers/oauth2-provider.en-us.md b/docs/content/doc/development/oauth2-provider.en-us.md similarity index 99% rename from docs/content/doc/developers/oauth2-provider.en-us.md rename to docs/content/doc/development/oauth2-provider.en-us.md index 1ef30a7f0e..7be7a42934 100644 --- a/docs/content/doc/developers/oauth2-provider.en-us.md +++ b/docs/content/doc/development/oauth2-provider.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "OAuth2 Provider" weight: 41 identifier: "oauth2-provider" diff --git a/docs/content/doc/developers/oauth2-provider.zh-tw.md b/docs/content/doc/development/oauth2-provider.zh-tw.md similarity index 99% rename from docs/content/doc/developers/oauth2-provider.zh-tw.md rename to docs/content/doc/development/oauth2-provider.zh-tw.md index 179c6342cd..b28e48d61e 100644 --- a/docs/content/doc/developers/oauth2-provider.zh-tw.md +++ b/docs/content/doc/development/oauth2-provider.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "developers" + parent: "development" name: "OAuth2 提供者" weight: 41 identifier: "oauth2-provider" diff --git a/docs/content/doc/features.en-us.md b/docs/content/doc/features.en-us.md deleted file mode 100644 index 9cc90b46a0..0000000000 --- a/docs/content/doc/features.en-us.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "Features" -slug: "features" -weight: 20 -toc: false -draft: false -menu: - sidebar: - name: "Features" - weight: 30 - identifier: "features" ---- diff --git a/docs/content/doc/features.zh-cn.md b/docs/content/doc/features.zh-cn.md deleted file mode 100644 index 68d2f71b11..0000000000 --- a/docs/content/doc/features.zh-cn.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "特性" -slug: "features" -weight: 20 -toc: false -draft: false -menu: - sidebar: - name: "特性" - weight: 30 - identifier: "features" ---- diff --git a/docs/content/doc/features.zh-tw.md b/docs/content/doc/features.zh-tw.md deleted file mode 100644 index 889e0df882..0000000000 --- a/docs/content/doc/features.zh-tw.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "功能" -slug: "features" -weight: 20 -toc: false -draft: false -menu: - sidebar: - name: "功能" - weight: 30 - identifier: "features" ---- diff --git a/docs/content/doc/help.en-us.md b/docs/content/doc/help.en-us.md index 635cb8931e..03c9a27818 100644 --- a/docs/content/doc/help.en-us.md +++ b/docs/content/doc/help.en-us.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "Help" - weight: 5 + weight: 100 identifier: "help" --- diff --git a/docs/content/doc/help.fr-fr.md b/docs/content/doc/help.fr-fr.md index ab0cedccfc..42e01009ce 100644 --- a/docs/content/doc/help.fr-fr.md +++ b/docs/content/doc/help.fr-fr.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "Aide" - weight: 5 + weight: 100 identifier: "help" --- diff --git a/docs/content/doc/help.zh-cn.md b/docs/content/doc/help.zh-cn.md index 9465cd5464..e8c0bd260b 100644 --- a/docs/content/doc/help.zh-cn.md +++ b/docs/content/doc/help.zh-cn.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "帮助" - weight: 5 + weight: 100 identifier: "help" --- diff --git a/docs/content/doc/help.zh-tw.md b/docs/content/doc/help.zh-tw.md index a9c3cea9e5..270a4ed8a7 100644 --- a/docs/content/doc/help.zh-tw.md +++ b/docs/content/doc/help.zh-tw.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "幫助" - weight: 5 + weight: 100 identifier: "help" --- diff --git a/docs/content/doc/help/faq.en-us.md b/docs/content/doc/help/faq.en-us.md index c8327de7fe..60e11d4459 100644 --- a/docs/content/doc/help/faq.en-us.md +++ b/docs/content/doc/help/faq.en-us.md @@ -43,7 +43,7 @@ On the other hand, 1.x.x downloads should never change. To migrate from Gogs to Gitea: -- [Gogs version 0.9.146 or less]({{< relref "doc/upgrade/from-gogs.en-us.md" >}}) +- [Gogs version 0.9.146 or less]({{< relref "doc/installation/upgrade-from-gogs.en-us.md" >}}) - [Gogs version 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) To migrate from GitHub to Gitea, you can use Gitea's built-in migration form. @@ -90,7 +90,7 @@ https://github.com/loganinak/MigrateGitlabToGogs There are a few places that could make this show incorrectly. -1. If using a reverse proxy, make sure you have followed the correction directions in the [reverse proxy guide]({{< relref "doc/usage/reverse-proxies.en-us.md" >}}) +1. If using a reverse proxy, make sure you have followed the correction directions in the [reverse proxy guide]({{< relref "doc/administration/reverse-proxies.en-us.md" >}}) 2. Make sure you have correctly set `ROOT_URL` in the `server` section of your `app.ini` If certain clone options aren't showing up (HTTP/S or SSH), the following options can be checked in your `app.ini` @@ -103,7 +103,7 @@ If certain clone options aren't showing up (HTTP/S or SSH), the following option This error occurs when the reverse proxy limits the file upload size. -See the [reverse proxy guide]({{< relref "doc/usage/reverse-proxies.en-us.md" >}}) for a solution with nginx. +See the [reverse proxy guide]({{< relref "doc/administration/reverse-proxies.en-us.md" >}}) for a solution with nginx. ## Custom Templates not loading or working incorrectly @@ -116,7 +116,7 @@ The correct path for the template(s) will be relative to the `CustomPath` If that doesn't exist, you can try `echo $GITEA_CUSTOM` 2. If you are still unable to find a path, the default can be [calculated above](#where-does-gitea-store-what-file) -3. Once you have figured out the correct custom path, you can refer to the [customizing Gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}) page to add your template to the correct location. +3. Once you have figured out the correct custom path, you can refer to the [customizing Gitea]({{< relref "doc/administration/customizing-gitea.en-us.md" >}}) page to add your template to the correct location. ## Active user vs login prohibited user @@ -126,7 +126,7 @@ A "login prohibited" user is a user that is not allowed to log in to Gitea anymo ## Setting up logging -- [Official Docs]({{< relref "doc/advanced/logging-documentation.en-us.md" >}}) +- [Official Docs]({{< relref "doc/administration/logging-documentation.en-us.md" >}}) ## What is Swagger? @@ -134,7 +134,7 @@ A "login prohibited" user is a user that is not allowed to log in to Gitea anymo All Gitea instances have the built-in API and there is no way to disable it completely. You can, however, disable showing its documentation by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini`. -For more information, refer to Gitea's [API docs]({{< relref "doc/developers/api-usage.en-us.md" >}}). +For more information, refer to Gitea's [API docs]({{< relref "doc/development/api-usage.en-us.md" >}}). You can see the latest API (for example) on . @@ -149,7 +149,7 @@ There are multiple things you can combine to prevent spammers. 1. By whitelisting or blocklisting certain email domains 2. By only whitelisting certain domains with OpenID (see below) 3. Setting `ENABLE_CAPTCHA` to `true` in your `app.ini` and properly configuring `RECAPTCHA_SECRET` and `RECAPTCHA_SITEKEY` -4. Settings `DISABLE_REGISTRATION` to `true` and creating new users via the [CLI]({{< relref "doc/usage/command-line.en-us.md" >}}), [API]({{< relref "doc/developers/api-usage.en-us.md" >}}), or Gitea's Admin UI +4. Settings `DISABLE_REGISTRATION` to `true` and creating new users via the [CLI]({{< relref "doc/administration/command-line.en-us.md" >}}), [API]({{< relref "doc/development/api-usage.en-us.md" >}}), or Gitea's Admin UI ### Only allow/block certain email domains @@ -175,7 +175,7 @@ At some point, a customer or third party needs access to a specific repo and onl ### Enable Fail2ban -Use [Fail2Ban]({{< relref "doc/usage/fail2ban-setup.en-us.md" >}}) to monitor and stop automated login attempts or other malicious behavior based on log patterns +Use [Fail2Ban]({{< relref "doc/administration/fail2ban-setup.en-us.md" >}}) to monitor and stop automated login attempts or other malicious behavior based on log patterns ## How to add/use custom themes @@ -328,24 +328,24 @@ You may want to set this value to `60m` or `120m`. ## How can I create users before starting Gitea -Gitea provides a sub-command `gitea migrate` to initialize the database, after which you can use the [admin CLI commands]({{< relref "doc/usage/command-line.en-us.md#admin" >}}) to add users like normal. +Gitea provides a sub-command `gitea migrate` to initialize the database, after which you can use the [admin CLI commands]({{< relref "doc/administration/command-line.en-us.md#admin" >}}) to add users like normal. ## How can I enable password reset -There is no setting for password resets. It is enabled when a [mail service]({{< relref "doc/usage/email-setup.en-us.md" >}}) is configured, and disabled otherwise. +There is no setting for password resets. It is enabled when a [mail service]({{< relref "doc/administration/email-setup.en-us.md" >}}) is configured, and disabled otherwise. ## How can a user's password be changed - As an **admin**, you can change any user's password (and optionally force them to change it on next login)... - By navigating to your `Site Administration -> User Accounts` page and editing a user. - - By using the [admin CLI commands]({{< relref "doc/usage/command-line.en-us.md#admin" >}}). + - By using the [admin CLI commands]({{< relref "doc/administration/command-line.en-us.md#admin" >}}). - Keep in mind most commands will also need a [global flag]({{< relref "doc/usage/command-line.en-us.md#global-options" >}}) to point the CLI at the correct configuration. + Keep in mind most commands will also need a [global flag]({{< relref "doc/administration/command-line.en-us.md#global-options" >}}) to point the CLI at the correct configuration. - As a **user** you can change it... - In your account `Settings -> Account` page (this method **requires** you to know your current password). - By using the `Forgot Password` link. - If the `Forgot Password/Account Recovery` page is disabled, please contact your administrator to configure a [mail service]({{< relref "doc/usage/email-setup.en-us.md" >}}). + If the `Forgot Password/Account Recovery` page is disabled, please contact your administrator to configure a [mail service]({{< relref "doc/administration/email-setup.en-us.md" >}}). ## Why is my markdown broken @@ -457,6 +457,6 @@ If you are using Cloudflare, turn off the auto-minify option in the dashboard. - You can also check `/admin/config` for the repository root path. - Ensure that the user/org exists that you want to adopt repositories for. - As an admin, go to `/admin/repos/unadopted` and search. - - Users can also be given similar permissions via config [`ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#repository" >}}). + - Users can also be given similar permissions via config [`ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`]({{< relref "doc/administration/config-cheat-sheet.en-us.md#repository" >}}). - If the above steps are done correctly, you should be able to select repositories to adopt. - - If no repositories are found, enable [debug logging]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#repository" >}}) to check for any specific errors. + - If no repositories are found, enable [debug logging]({{< relref "doc/administration/config-cheat-sheet.en-us.md#repository" >}}) to check for any specific errors. diff --git a/docs/content/doc/features/comparison.en-us.md b/docs/content/doc/installation/comparison.en-us.md similarity index 99% rename from docs/content/doc/features/comparison.en-us.md rename to docs/content/doc/installation/comparison.en-us.md index 5b68aed9b6..819af95be9 100644 --- a/docs/content/doc/features/comparison.en-us.md +++ b/docs/content/doc/installation/comparison.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "features" name: "Comparison" weight: 5 + parent: installation identifier: "comparison" --- diff --git a/docs/content/doc/features/comparison.zh-cn.md b/docs/content/doc/installation/comparison.zh-cn.md similarity index 99% rename from docs/content/doc/features/comparison.zh-cn.md rename to docs/content/doc/installation/comparison.zh-cn.md index 55014dab7b..b254cf7496 100644 --- a/docs/content/doc/features/comparison.zh-cn.md +++ b/docs/content/doc/installation/comparison.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "installation" name: "横向对比" weight: 5 identifier: "comparison" diff --git a/docs/content/doc/features/comparison.zh-tw.md b/docs/content/doc/installation/comparison.zh-tw.md similarity index 99% rename from docs/content/doc/features/comparison.zh-tw.md rename to docs/content/doc/installation/comparison.zh-tw.md index bde1779441..f918fbad75 100644 --- a/docs/content/doc/features/comparison.zh-tw.md +++ b/docs/content/doc/installation/comparison.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "installation" name: "比較" weight: 5 identifier: "comparison" diff --git a/docs/content/doc/installation/database-preparation.en-us.md b/docs/content/doc/installation/database-preparation.en-us.md index b8ad5d6859..e8ab02caa9 100644 --- a/docs/content/doc/installation/database-preparation.en-us.md +++ b/docs/content/doc/installation/database-preparation.en-us.md @@ -9,7 +9,7 @@ menu: sidebar: parent: "installation" name: "Database preparation" - weight: 20 + weight: 5 identifier: "database-prep" --- diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index 6f71b0b91e..fc17373ea5 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -64,7 +64,7 @@ despite warnings like `This key is not certified with a trusted signature!`. ## Recommended server configuration -**NOTE:** Many of the following directories can be configured using [Environment Variables]({{< relref "doc/advanced/environment-variables.en-us.md" >}}) as well! +**NOTE:** Many of the following directories can be configured using [Environment Variables]({{< relref "doc/administration/environment-variables.en-us.md" >}}) as well! Of note, configuring `GITEA_WORK_DIR` will tell Gitea where to base its working directory, as well as ease installation. ### Prepare environment @@ -113,7 +113,7 @@ If you don't want the web installer to be able to write to the config file, it i * Ensure that the `SECRET_KEY` and `INTERNAL_TOKEN` values are set. (You may want to use the `gitea generate secret` to generate these secret keys.) * Ensure that any other secret keys you need are set. -See the [command line documentation]({{< relref "doc/usage/command-line.en-us.md" >}}) for information on using `gitea generate secret`. +See the [command line documentation]({{< relref "doc/administration/command-line.en-us.md" >}}) for information on using `gitea generate secret`. ### Configure Gitea's working directory @@ -158,7 +158,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini You can update to a new version of Gitea by stopping Gitea, replacing the binary at `/usr/local/bin/gitea` and restarting the instance. The binary file name should not be changed during the update to avoid problems in existing repositories. -It is recommended that you make a [backup]({{< relref "doc/usage/backup-and-restore.en-us.md" >}}) before updating your installation. +It is recommended that you make a [backup]({{< relref "doc/administration/backup-and-restore.en-us.md" >}}) before updating your installation. If you have carried out the installation steps as described above, the binary should have the generic name `gitea`. Do not change this, i.e. to include the version number. diff --git a/docs/content/doc/installation/from-binary.zh-cn.md b/docs/content/doc/installation/from-binary.zh-cn.md index 5e28cf0f21..ad14c2d625 100644 --- a/docs/content/doc/installation/from-binary.zh-cn.md +++ b/docs/content/doc/installation/from-binary.zh-cn.md @@ -59,7 +59,7 @@ gpg --verify gitea-{{< version >}}-linux-amd64.asc gitea-{{< version >}}-linux-a ## 服务器设置 -**提示：** `GITEA_WORK_DIR` 表示 Gitea 工作的路径。以下路径可以通过 [环境变量]({{< relref "doc/advanced/environment-variables.zh-cn.md" >}}) 初始化。 +**提示：** `GITEA_WORK_DIR` 表示 Gitea 工作的路径。以下路径可以通过 [环境变量]({{< relref "doc/administration/environment-variables.zh-cn.md" >}}) 初始化。 ### 准备环境 @@ -141,7 +141,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini 您可以通过停止程序，替换 `/usr/local/bin/gitea` 并重启来更新到新版本。直接替换可执行程序时不要更改或使用新的文件名称，以避免数据出错。 -建议您在更新之前进行[备份]({{< relref "doc/usage/backup-and-restore.zh-cn.md" >}})。 +建议您在更新之前进行[备份]({{< relref "doc/administration/backup-and-restore.zh-cn.md" >}})。 ### 1. 使用 systemd 重新启动 Gitea（推荐） diff --git a/docs/content/doc/installation/from-source.en-us.md b/docs/content/doc/installation/from-source.en-us.md index d0db639b0a..6bb13d1056 100644 --- a/docs/content/doc/installation/from-source.en-us.md +++ b/docs/content/doc/installation/from-source.en-us.md @@ -33,7 +33,7 @@ executable path, you will have to manage this yourself. **Note 2**: Go version {{< min-go-version >}} or higher is required. However, it is recommended to obtain the same version as our continuous integration, see the advice given in -Hacking on +Hacking on Gitea **Table of Contents** @@ -87,7 +87,7 @@ To build from source, the following programs must be present on the system: - `go` {{< min-go-version >}} or higher, see [here](https://golang.org/dl/) - `node` {{< min-node-version >}} or higher with `npm`, see [here](https://nodejs.org/en/download/) -- `make`, see [here]({{< relref "doc/developers/hacking-on-gitea.en-us.md" >}}#installing-make) +- `make`, see [here]({{< relref "doc/development/hacking-on-gitea.en-us.md" >}}#installing-make) Various [make tasks](https://github.com/go-gitea/gitea/blob/main/Makefile) are provided to keep the build process as simple as possible. diff --git a/docs/content/doc/upgrade/from-gitea.en-us.md b/docs/content/doc/installation/upgrade-from-gitea.en-us.md similarity index 97% rename from docs/content/doc/upgrade/from-gitea.en-us.md rename to docs/content/doc/installation/upgrade-from-gitea.en-us.md index 4dc47b05a4..5f958876c3 100644 --- a/docs/content/doc/upgrade/from-gitea.en-us.md +++ b/docs/content/doc/installation/upgrade-from-gitea.en-us.md @@ -1,17 +1,15 @@ --- date: "2021-09-02T16:00:00+08:00" title: "Upgrade from an old Gitea" -aliases: - - /en-us/upgrade/ slug: "upgrade-from-gitea" weight: 10 toc: false draft: false menu: sidebar: - parent: "upgrade" - name: "From Gitea" - weight: 10 + parent: "installation" + name: "Upgrade From Old Gitea" + weight: 100 identifier: "upgrade-from-gitea" --- diff --git a/docs/content/doc/upgrade/from-gogs.en-us.md b/docs/content/doc/installation/upgrade-from-gogs.en-us.md similarity index 98% rename from docs/content/doc/upgrade/from-gogs.en-us.md rename to docs/content/doc/installation/upgrade-from-gogs.en-us.md index f0bfe96050..7ac83367cc 100644 --- a/docs/content/doc/upgrade/from-gogs.en-us.md +++ b/docs/content/doc/installation/upgrade-from-gogs.en-us.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "upgrade" - name: "From Gogs" - weight: 10 + parent: "installation" + name: "Upgrade From Gogs" + weight: 101 identifier: "upgrade-from-gogs" --- diff --git a/docs/content/doc/upgrade/from-gogs.fr-fr.md b/docs/content/doc/installation/upgrade-from-gogs.fr-fr.md similarity index 98% rename from docs/content/doc/upgrade/from-gogs.fr-fr.md rename to docs/content/doc/installation/upgrade-from-gogs.fr-fr.md index 98a8edc1a3..066002bcc1 100644 --- a/docs/content/doc/upgrade/from-gogs.fr-fr.md +++ b/docs/content/doc/installation/upgrade-from-gogs.fr-fr.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "upgrade" + parent: "installation" name: "Depuis Gogs" - weight: 10 + weight: 101 identifier: "upgrade-from-gogs" --- diff --git a/docs/content/doc/upgrade/from-gogs.zh-cn.md b/docs/content/doc/installation/upgrade-from-gogs.zh-cn.md similarity index 95% rename from docs/content/doc/upgrade/from-gogs.zh-cn.md rename to docs/content/doc/installation/upgrade-from-gogs.zh-cn.md index 7d391ae822..eac4f24f53 100644 --- a/docs/content/doc/upgrade/from-gogs.zh-cn.md +++ b/docs/content/doc/installation/upgrade-from-gogs.zh-cn.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "upgrade" + parent: "installation" name: "从 Gogs 升级" - weight: 10 + weight: 101 identifier: "upgrade-from-gogs" --- diff --git a/docs/content/doc/upgrade/from-gogs.zh-tw.md b/docs/content/doc/installation/upgrade-from-gogs.zh-tw.md similarity index 98% rename from docs/content/doc/upgrade/from-gogs.zh-tw.md rename to docs/content/doc/installation/upgrade-from-gogs.zh-tw.md index 793d74df88..3b98b5f8f0 100644 --- a/docs/content/doc/upgrade/from-gogs.zh-tw.md +++ b/docs/content/doc/installation/upgrade-from-gogs.zh-tw.md @@ -7,9 +7,9 @@ toc: false draft: false menu: sidebar: - parent: "upgrade" - name: "從 Gogs" - weight: 10 + parent: "installation" + name: "從 Gogs 升級" + weight: 101 identifier: "upgrade-from-gogs" --- diff --git a/docs/content/doc/installation/with-docker-rootless.en-us.md b/docs/content/doc/installation/with-docker-rootless.en-us.md index 7e1a0e6fe0..36ecf6277a 100644 --- a/docs/content/doc/installation/with-docker-rootless.en-us.md +++ b/docs/content/doc/installation/with-docker-rootless.en-us.md @@ -9,7 +9,7 @@ menu: sidebar: parent: "installation" name: "With Docker Rootless" - weight: 10 + weight: 48 identifier: "install-with-docker-rootless" --- diff --git a/docs/content/doc/installation/with-docker.en-us.md b/docs/content/doc/installation/with-docker.en-us.md index 90c6e7b5f3..396bc67bd3 100644 --- a/docs/content/doc/installation/with-docker.en-us.md +++ b/docs/content/doc/installation/with-docker.en-us.md @@ -9,7 +9,7 @@ menu: sidebar: parent: "installation" name: "With Docker" - weight: 10 + weight: 49 identifier: "install-with-docker" --- diff --git a/docs/content/doc/installation/with-docker.fr-fr.md b/docs/content/doc/installation/with-docker.fr-fr.md index 176abf7a12..4db26405b1 100644 --- a/docs/content/doc/installation/with-docker.fr-fr.md +++ b/docs/content/doc/installation/with-docker.fr-fr.md @@ -9,7 +9,7 @@ menu: sidebar: parent: "installation" name: "Docker" - weight: 10 + weight: 49 identifier: "install-with-docker" --- diff --git a/docs/content/doc/installation/with-docker.zh-cn.md b/docs/content/doc/installation/with-docker.zh-cn.md index cae28c70b8..e89fb762bb 100644 --- a/docs/content/doc/installation/with-docker.zh-cn.md +++ b/docs/content/doc/installation/with-docker.zh-cn.md @@ -9,7 +9,7 @@ menu: sidebar: parent: "installation" name: "使用 Docker 安装" - weight: 10 + weight: 49 identifier: "install-with-docker" --- diff --git a/docs/content/doc/installation/with-docker.zh-tw.md b/docs/content/doc/installation/with-docker.zh-tw.md index 0fd8626149..f432957d87 100644 --- a/docs/content/doc/installation/with-docker.zh-tw.md +++ b/docs/content/doc/installation/with-docker.zh-tw.md @@ -9,7 +9,7 @@ menu: sidebar: parent: "installation" name: "Docker 安裝" - weight: 10 + weight: 49 identifier: "install-with-docker" --- diff --git a/docs/content/doc/packages.en-us.md b/docs/content/doc/packages.en-us.md index e613b6b250..e4a87bdebf 100644 --- a/docs/content/doc/packages.en-us.md +++ b/docs/content/doc/packages.en-us.md @@ -1,12 +1,13 @@ --- -date: "2021-07-20T00:00:00+00:00" -title: "Package Registry" +date: "2016-12-27T16:00:00+02:00" +title: "Packages" slug: "packages" +weight: 35 toc: false draft: false menu: sidebar: - name: "Package Registry" - weight: 45 + name: "Usage - Packages" + weight: 30 identifier: "packages" --- diff --git a/docs/content/doc/packages/cargo.en-us.md b/docs/content/doc/packages/cargo.en-us.md index 1f90d939d1..62c8c41aae 100644 --- a/docs/content/doc/packages/cargo.en-us.md +++ b/docs/content/doc/packages/cargo.en-us.md @@ -1,7 +1,7 @@ --- date: "2022-11-20T00:00:00+00:00" title: "Cargo Packages Repository" -slug: "packages/cargo" +slug: "usage/packages/cargo" draft: false toc: false menu: @@ -73,7 +73,7 @@ token = "Bearer {token}" | Parameter | Description | | --------- | ----------- | -| `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) | +| `token` | Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) | ## Publish a package diff --git a/docs/content/doc/packages/chef.en-us.md b/docs/content/doc/packages/chef.en-us.md index ecc774d792..67322fdbf2 100644 --- a/docs/content/doc/packages/chef.en-us.md +++ b/docs/content/doc/packages/chef.en-us.md @@ -1,7 +1,7 @@ --- date: "2023-01-20T00:00:00+00:00" title: "Chef Packages Repository" -slug: "packages/chef" +slug: "usage/packages/chef" draft: false toc: false menu: diff --git a/docs/content/doc/packages/composer.en-us.md b/docs/content/doc/packages/composer.en-us.md index 47b03781f0..dba3f31364 100644 --- a/docs/content/doc/packages/composer.en-us.md +++ b/docs/content/doc/packages/composer.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "Composer Packages Repository" -slug: "packages/composer" +slug: "usage/packages/composer" draft: false toc: false menu: @@ -60,7 +60,7 @@ curl --user your_username:your_password_or_token \ https://gitea.example.com/api/packages/testuser/composer?version=1.0.3 ``` -If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. +If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. The server responds with the following HTTP Status codes. diff --git a/docs/content/doc/packages/conan.en-us.md b/docs/content/doc/packages/conan.en-us.md index fb104f34f4..c40bb583e6 100644 --- a/docs/content/doc/packages/conan.en-us.md +++ b/docs/content/doc/packages/conan.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "Conan Packages Repository" -slug: "packages/conan" +slug: "usage/packages/conan" draft: false toc: false menu: @@ -37,7 +37,7 @@ conan user --remote {remote} --password {password} {username} | -----------| ----------- | | `remote` | The remote name. | | `username` | Your Gitea username. | -| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. | +| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. | | `owner` | The owner of the package. | For example: diff --git a/docs/content/doc/packages/conda.en-us.md b/docs/content/doc/packages/conda.en-us.md index 8b82847590..5fca9997de 100644 --- a/docs/content/doc/packages/conda.en-us.md +++ b/docs/content/doc/packages/conda.en-us.md @@ -1,7 +1,7 @@ --- date: "2022-12-28T00:00:00+00:00" title: "Conda Packages Repository" -slug: "packages/conda" +slug: "usage/packages/conda" draft: false toc: false menu: diff --git a/docs/content/doc/packages/container.en-us.md b/docs/content/doc/packages/container.en-us.md index 77dbbafd02..732249529d 100644 --- a/docs/content/doc/packages/container.en-us.md +++ b/docs/content/doc/packages/container.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "Container Registry" -slug: "packages/container" +slug: "usage/packages/container" draft: false toc: false menu: @@ -34,7 +34,7 @@ To push an image or if the image is in a private registry, you have to authentic docker login gitea.example.com ``` -If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. +If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. ## Image naming convention diff --git a/docs/content/doc/packages/generic.en-us.md b/docs/content/doc/packages/generic.en-us.md index dd0f5653ff..ce6661a87c 100644 --- a/docs/content/doc/packages/generic.en-us.md +++ b/docs/content/doc/packages/generic.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "Generic Packages Repository" -slug: "packages/generic" +slug: "usage/packages/generic" draft: false toc: false menu: @@ -22,7 +22,7 @@ Publish generic files, like release binaries or other output, for your user or o ## Authenticate to the package registry -To authenticate to the Package Registry, you need to provide [custom HTTP headers or use HTTP Basic authentication]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). +To authenticate to the Package Registry, you need to provide [custom HTTP headers or use HTTP Basic authentication]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). ## Publish a package @@ -48,7 +48,7 @@ curl --user your_username:your_password_or_token \ https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin ``` -If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. +If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. The server reponds with the following HTTP Status codes. diff --git a/docs/content/doc/packages/helm.en-us.md b/docs/content/doc/packages/helm.en-us.md index 89b929f9bc..0135223766 100644 --- a/docs/content/doc/packages/helm.en-us.md +++ b/docs/content/doc/packages/helm.en-us.md @@ -1,7 +1,7 @@ --- date: "2022-04-14T00:00:00+00:00" title: "Helm Chart Registry" -slug: "packages/helm" +slug: "usage/packages/helm" draft: false toc: false menu: @@ -42,7 +42,7 @@ helm cm-push ./{chart_file}.tgz {repo} | Parameter | Description | | ------------ | ----------- | | `username` | Your Gitea username. | -| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. | +| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. | | `repo` | The name for the repository. | | `chart_file` | The Helm Chart archive. | | `owner` | The owner of the package. | diff --git a/docs/content/doc/packages/maven.en-us.md b/docs/content/doc/packages/maven.en-us.md index 2ec5ca2ab7..4e5090c7ee 100644 --- a/docs/content/doc/packages/maven.en-us.md +++ b/docs/content/doc/packages/maven.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "Maven Packages Repository" -slug: "packages/maven" +slug: "usage/packages/maven" draft: false toc: false menu: @@ -70,7 +70,7 @@ Afterwards add the following sections to your project `pom.xml` file: | Parameter | Description | | -------------- | ----------- | -| `access_token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). | +| `access_token` | Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). | | `owner` | The owner of the package. | ### Gradle variant diff --git a/docs/content/doc/packages/npm.en-us.md b/docs/content/doc/packages/npm.en-us.md index decb3f743c..f6ca9fb93f 100644 --- a/docs/content/doc/packages/npm.en-us.md +++ b/docs/content/doc/packages/npm.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "npm Packages Repository" -slug: "packages/npm" +slug: "usage/packages/npm" draft: false toc: false menu: @@ -41,7 +41,7 @@ npm config set -- '//gitea.example.com/api/packages/{owner}/npm/:_authToken' "{t | ------------ | ----------- | | `scope` | The scope of the packages. | | `owner` | The owner of the package. | -| `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). | +| `token` | Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). | For example: diff --git a/docs/content/doc/packages/nuget.en-us.md b/docs/content/doc/packages/nuget.en-us.md index 670abca7fd..c40461cf8c 100644 --- a/docs/content/doc/packages/nuget.en-us.md +++ b/docs/content/doc/packages/nuget.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "NuGet Packages Repository" -slug: "packages/nuget" +slug: "usage/packages/nuget" draft: false toc: false menu: @@ -38,7 +38,7 @@ dotnet nuget add source --name {source_name} --username {username} --password {p | ------------- | ----------- | | `source_name` | The desired source name. | | `username` | Your Gitea username. | -| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. | +| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. | | `owner` | The owner of the package. | For example: @@ -47,7 +47,7 @@ For example: dotnet nuget add source --name gitea --username testuser --password password123 https://gitea.example.com/api/packages/testuser/nuget/index.json ``` -You can add the source without credentials and use the [`--api-key`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-push) parameter when publishing packages. In this case you need to provide a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). +You can add the source without credentials and use the [`--api-key`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-push) parameter when publishing packages. In this case you need to provide a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). ## Publish a package diff --git a/docs/content/doc/packages/overview.en-us.md b/docs/content/doc/packages/overview.en-us.md index 08da8ced48..436514bfa7 100644 --- a/docs/content/doc/packages/overview.en-us.md +++ b/docs/content/doc/packages/overview.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "Package Registry" -slug: "packages/overview" +slug: "usage/packages/overview" draft: false toc: false menu: diff --git a/docs/content/doc/packages/pub.en-us.md b/docs/content/doc/packages/pub.en-us.md index 4d37662208..ef7be1be59 100644 --- a/docs/content/doc/packages/pub.en-us.md +++ b/docs/content/doc/packages/pub.en-us.md @@ -1,7 +1,7 @@ --- date: "2022-07-31T00:00:00+00:00" title: "Pub Packages Repository" -slug: "packages/pub" +slug: "usage/packages/pub" draft: false toc: false menu: @@ -38,7 +38,7 @@ dart pub token add https://gitea.example.com/api/packages/{owner}/pub | ------------ | ----------- | | `owner` | The owner of the package. | -You need to provide your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). +You need to provide your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). ## Publish a package diff --git a/docs/content/doc/packages/pypi.en-us.md b/docs/content/doc/packages/pypi.en-us.md index ec2475aea3..f99dfb5acc 100644 --- a/docs/content/doc/packages/pypi.en-us.md +++ b/docs/content/doc/packages/pypi.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "PyPI Packages Repository" -slug: "packages/pypi" +slug: "usage/packages/pypi" draft: false toc: false menu: @@ -42,7 +42,7 @@ password = {password} | ------------ | ----------- | | `owner` | The owner of the package. | | `username` | Your Gitea username. | -| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. | +| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. | ## Publish a package diff --git a/docs/content/doc/packages/rubygems.en-us.md b/docs/content/doc/packages/rubygems.en-us.md index d4ae30bbce..a7aa36aef4 100644 --- a/docs/content/doc/packages/rubygems.en-us.md +++ b/docs/content/doc/packages/rubygems.en-us.md @@ -1,7 +1,7 @@ --- date: "2021-07-20T00:00:00+00:00" title: "RubyGems Packages Repository" -slug: "packages/rubygems" +slug: "usage/packages/rubygems" draft: false toc: false menu: @@ -36,7 +36,7 @@ https://gitea.example.com/api/packages/{owner}/rubygems: Bearer {token} | Parameter | Description | | ------------- | ----------- | | `owner` | The owner of the package. | -| `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). | +| `token` | Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). | For example: diff --git a/docs/content/doc/packages/storage.en-us.md b/docs/content/doc/packages/storage.en-us.md index 8b05b8a45f..000752b774 100644 --- a/docs/content/doc/packages/storage.en-us.md +++ b/docs/content/doc/packages/storage.en-us.md @@ -1,7 +1,7 @@ --- date: "2022-11-01T00:00:00+00:00" title: "Storage" -slug: "packages/storage" +slug: "usage/packages/storage" draft: false toc: false menu: @@ -31,7 +31,7 @@ Whenever a package gets deleted only the references to the underlaying blobs are The blobs get not removed at this moment, so they still require space on the filesystem. When a new package gets uploaded the existing blobs may get referenced again. -These unreferenced blobs get deleted by a [clean up job]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#cron---cleanup-expired-packages-croncleanup_packages" >}}). +These unreferenced blobs get deleted by a [clean up job]({{< relref "doc/administration/config-cheat-sheet.en-us.md#cron---cleanup-expired-packages-croncleanup_packages" >}}). The config setting `OLDER_THAN` configures how long unreferenced blobs are kept before they get deleted. ## Cleanup Rules @@ -71,7 +71,7 @@ The patterns are case-insensitive which matches the behaviour of the package reg ### How the cleanup rules work -The cleanup rules are part of the [clean up job]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#cron---cleanup-expired-packages-croncleanup_packages" >}}) and run periodically. +The cleanup rules are part of the [clean up job]({{< relref "doc/administration/config-cheat-sheet.en-us.md#cron---cleanup-expired-packages-croncleanup_packages" >}}) and run periodically. The cleanup rule: diff --git a/docs/content/doc/packages/swift.en-us.md b/docs/content/doc/packages/swift.en-us.md index 61a4c9a55d..c7c7ae4bd5 100644 --- a/docs/content/doc/packages/swift.en-us.md +++ b/docs/content/doc/packages/swift.en-us.md @@ -1,7 +1,7 @@ --- date: "2023-01-10T00:00:00+00:00" title: "Swift Packages Repository" -slug: "packages/swift" +slug: "usage/packages/swift" draft: false toc: false menu: @@ -36,7 +36,7 @@ swift package-registry set https://gitea.example.com/api/packages/{owner}/swift | ------------ | ----------- | | `owner` | The owner of the package. | | `username` | Your Gitea username. | -| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. | +| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. | The login is optional and only needed if the package registry is private. @@ -61,7 +61,7 @@ curl -X PUT --user {username}:{password} \ | Placeholder | Description | | ----------- | ----------- | | `username` | Your Gitea username. | -| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. | +| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. | | `owner` | The owner of the package. | | `scope` | The package scope. | | `name` | The package name. | diff --git a/docs/content/doc/packages/vagrant.en-us.md b/docs/content/doc/packages/vagrant.en-us.md index 1e6d7a7721..4cd066feca 100644 --- a/docs/content/doc/packages/vagrant.en-us.md +++ b/docs/content/doc/packages/vagrant.en-us.md @@ -1,7 +1,7 @@ --- date: "2022-08-23T00:00:00+00:00" title: "Vagrant Packages Repository" -slug: "packages/vagrant" +slug: "usage/packages/vagrant" draft: false toc: false menu: @@ -69,7 +69,7 @@ vagrant box add "https://gitea.example.com/api/packages/testuser/vagrant/test_sy ``` This will install the latest version of the package. To add a specific version, use the `--box-version` parameter. -If the registry is private you can pass your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) in the `VAGRANT_CLOUD_TOKEN` environment variable. +If the registry is private you can pass your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) in the `VAGRANT_CLOUD_TOKEN` environment variable. ## Supported commands diff --git a/docs/content/doc/upgrade.en-us.md b/docs/content/doc/upgrade.en-us.md deleted file mode 100644 index 9623ff9f1e..0000000000 --- a/docs/content/doc/upgrade.en-us.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "Upgrade" -slug: "upgrade" -weight: 10 -toc: false -draft: false -menu: - sidebar: - name: "Upgrade" - weight: 20 - identifier: "upgrade" ---- diff --git a/docs/content/doc/upgrade.fr-fr.md b/docs/content/doc/upgrade.fr-fr.md deleted file mode 100644 index ca08daf9c0..0000000000 --- a/docs/content/doc/upgrade.fr-fr.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2017-08-23T09:00:00+02:00" -title: "Mise à jour" -slug: "upgrade" -weight: 10 -toc: false -draft: false -menu: - sidebar: - name: "Mise à jour" - weight: 20 - identifier: "upgrade" ---- diff --git a/docs/content/doc/upgrade.zh-cn.md b/docs/content/doc/upgrade.zh-cn.md deleted file mode 100644 index d12e150b9c..0000000000 --- a/docs/content/doc/upgrade.zh-cn.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "升级" -slug: "upgrade" -weight: 10 -toc: false -draft: false -menu: - sidebar: - name: "升级" - weight: 20 - identifier: "upgrade" ---- diff --git a/docs/content/doc/upgrade.zh-tw.md b/docs/content/doc/upgrade.zh-tw.md deleted file mode 100644 index b57fccbdd5..0000000000 --- a/docs/content/doc/upgrade.zh-tw.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: "2016-12-01T16:00:00+02:00" -title: "升級" -slug: "upgrade" -weight: 10 -toc: false -draft: false -menu: - sidebar: - name: "升級" - weight: 20 - identifier: "upgrade" ---- diff --git a/docs/content/doc/usage.en-us.md b/docs/content/doc/usage.en-us.md index 6be9769d64..47a4fdc1d7 100644 --- a/docs/content/doc/usage.en-us.md +++ b/docs/content/doc/usage.en-us.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "Usage" - weight: 35 + weight: 30 identifier: "usage" --- diff --git a/docs/content/doc/usage.zh-cn.md b/docs/content/doc/usage.zh-cn.md index c533df6624..026bef86e9 100644 --- a/docs/content/doc/usage.zh-cn.md +++ b/docs/content/doc/usage.zh-cn.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "使用指南" - weight: 35 + weight: 30 identifier: "usage" --- diff --git a/docs/content/doc/usage.zh-tw.md b/docs/content/doc/usage.zh-tw.md index b74bfe0175..a95e973991 100644 --- a/docs/content/doc/usage.zh-tw.md +++ b/docs/content/doc/usage.zh-tw.md @@ -8,6 +8,6 @@ draft: false menu: sidebar: name: "使用" - weight: 35 + weight: 30 identifier: "usage" --- diff --git a/docs/content/doc/features/authentication.en-us.md b/docs/content/doc/usage/authentication.en-us.md similarity index 99% rename from docs/content/doc/features/authentication.en-us.md rename to docs/content/doc/usage/authentication.en-us.md index c27a09b00b..5478ee94f6 100644 --- a/docs/content/doc/features/authentication.en-us.md +++ b/docs/content/doc/usage/authentication.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "usage" name: "Authentication" weight: 10 identifier: "authentication" diff --git a/docs/content/doc/features/authentication.zh-cn.md b/docs/content/doc/usage/authentication.zh-cn.md similarity index 98% rename from docs/content/doc/features/authentication.zh-cn.md rename to docs/content/doc/usage/authentication.zh-cn.md index aeb099f760..403c3f43ce 100644 --- a/docs/content/doc/features/authentication.zh-cn.md +++ b/docs/content/doc/usage/authentication.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "usage" name: "认证" weight: 10 identifier: "authentication" diff --git a/docs/content/doc/features/authentication.zh-tw.md b/docs/content/doc/usage/authentication.zh-tw.md similarity index 90% rename from docs/content/doc/features/authentication.zh-tw.md rename to docs/content/doc/usage/authentication.zh-tw.md index da257409a2..958c498fc6 100644 --- a/docs/content/doc/features/authentication.zh-tw.md +++ b/docs/content/doc/usage/authentication.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "usage" name: "認證" weight: 10 identifier: "authentication" diff --git a/docs/content/doc/advanced/clone-filter.en-us.md b/docs/content/doc/usage/clone-filter.en-us.md similarity index 98% rename from docs/content/doc/advanced/clone-filter.en-us.md rename to docs/content/doc/usage/clone-filter.en-us.md index 58675d2e94..7d4ba2d9a8 100644 --- a/docs/content/doc/advanced/clone-filter.en-us.md +++ b/docs/content/doc/usage/clone-filter.en-us.md @@ -7,7 +7,7 @@ draft: false toc: false menu: sidebar: - parent: "advanced" + parent: "usage" name: "Clone filters" weight: 25 identifier: "clone-filters" diff --git a/docs/content/doc/usage/linked-references.en-us.md b/docs/content/doc/usage/linked-references.en-us.md index df28137928..721c2cf13e 100644 --- a/docs/content/doc/usage/linked-references.en-us.md +++ b/docs/content/doc/usage/linked-references.en-us.md @@ -96,7 +96,7 @@ Sometimes a commit or pull request may fix or bring back a problem documented in a particular issue. Gitea supports closing and reopening the referenced issues by preceding the reference with a particular _keyword_. Common keywords include "closes", "fixes", "reopens", etc. This list can be -[customized]({{< ref "/doc/advanced/config-cheat-sheet.en-us.md" >}}) by the +[customized]({{< ref "doc/administration/config-cheat-sheet.en-us.md" >}}) by the site administrator. Example: diff --git a/docs/content/doc/advanced/protected-tags.en-us.md b/docs/content/doc/usage/protected-tags.en-us.md similarity index 99% rename from docs/content/doc/advanced/protected-tags.en-us.md rename to docs/content/doc/usage/protected-tags.en-us.md index 8ed2afc418..f7404d32cb 100644 --- a/docs/content/doc/advanced/protected-tags.en-us.md +++ b/docs/content/doc/usage/protected-tags.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "usage" name: "Protected tags" weight: 45 identifier: "protected-tags" diff --git a/docs/content/doc/usage/push-to-create.en-us.md b/docs/content/doc/usage/push-to-create.en-us.md index 7ed3f56368..27b26b16a9 100644 --- a/docs/content/doc/usage/push-to-create.en-us.md +++ b/docs/content/doc/usage/push-to-create.en-us.md @@ -19,7 +19,7 @@ Push to create is a feature that allows you to push to a repository that does no ## Enabling Push To Create -In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#repository-repository" >}}). +In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet]({{< relref "doc/administration/config-cheat-sheet.en-us.md#repository-repository" >}}). ## Using Push To Create diff --git a/docs/content/doc/advanced/repo-mirror.en-us.md b/docs/content/doc/usage/repo-mirror.en-us.md similarity index 99% rename from docs/content/doc/advanced/repo-mirror.en-us.md rename to docs/content/doc/usage/repo-mirror.en-us.md index e95dfa0d63..9a52282bb3 100644 --- a/docs/content/doc/advanced/repo-mirror.en-us.md +++ b/docs/content/doc/usage/repo-mirror.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "advanced" + parent: "usage" name: "Repository Mirror" weight: 45 identifier: "repo-mirror" diff --git a/docs/content/doc/secrets/overview.en-us.md b/docs/content/doc/usage/secrets.en-us.md similarity index 91% rename from docs/content/doc/secrets/overview.en-us.md rename to docs/content/doc/usage/secrets.en-us.md index 1b63d179d7..341ccbae12 100644 --- a/docs/content/doc/secrets/overview.en-us.md +++ b/docs/content/doc/usage/secrets.en-us.md @@ -1,15 +1,15 @@ --- date: "2022-12-19T21:26:00+08:00" title: "Secrets" -slug: "secrets/overview" +slug: "usage/secrets" draft: false toc: false menu: sidebar: - parent: "secrets" - name: "Overview" + parent: "usage" + name: "Secrets" weight: 1 - identifier: "secrets-overview" + identifier: "usage-secrets" --- # Secrets diff --git a/docs/content/doc/features/webhooks.en-us.md b/docs/content/doc/usage/webhooks.en-us.md similarity index 99% rename from docs/content/doc/features/webhooks.en-us.md rename to docs/content/doc/usage/webhooks.en-us.md index ecbe13c3ad..2cf60cc9cd 100644 --- a/docs/content/doc/features/webhooks.en-us.md +++ b/docs/content/doc/usage/webhooks.en-us.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "usage" name: "Webhooks" weight: 30 identifier: "webhooks" diff --git a/docs/content/doc/features/webhooks.zh-cn.md b/docs/content/doc/usage/webhooks.zh-cn.md similarity index 96% rename from docs/content/doc/features/webhooks.zh-cn.md rename to docs/content/doc/usage/webhooks.zh-cn.md index 76139460c0..00ebd7aa9d 100644 --- a/docs/content/doc/features/webhooks.zh-cn.md +++ b/docs/content/doc/usage/webhooks.zh-cn.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "usage" name: "Webhooks" weight: 30 identifier: "webhooks" diff --git a/docs/content/doc/features/webhooks.zh-tw.md b/docs/content/doc/usage/webhooks.zh-tw.md similarity index 99% rename from docs/content/doc/features/webhooks.zh-tw.md rename to docs/content/doc/usage/webhooks.zh-tw.md index 20fec3d62d..9e918739a4 100644 --- a/docs/content/doc/features/webhooks.zh-tw.md +++ b/docs/content/doc/usage/webhooks.zh-tw.md @@ -7,7 +7,7 @@ toc: false draft: false menu: sidebar: - parent: "features" + parent: "usage" name: "Webhook" weight: 30 identifier: "webhooks"