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 <[email protected]>
This commit is contained in:
Lunny XiaoandJohn Olheiser authored and GitHub committed 2023-03-23 23:18:24 +08:00
1 parent 36b0284fd1
commit bee3c9dfa9
120 files changed
+251 -342

No files matched your search

+14
View File
@@ -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"
---
@@ -1,13 +1,13 @@
--- ---
date: "2017-08-23T09:00:00+02:00" date: "2017-08-23T09:00:00+02:00"
title: "Avancé" title: "Avancé"
slug: "advanced" slug: "administration"
weight: 30 weight: 30
toc: false toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
name: "Avancé" name: "Avancé"
weight: 40 weight: 20
identifier: "advanced" identifier: "administration"
--- ---
+13
View File
@@ -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"
---
+13
View File
@@ -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"
---
@@ -7,10 +7,10 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Adding Legal Pages" name: "Adding Legal Pages"
identifier: "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. 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.
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "Backup and Restore" name: "Backup and Restore"
weight: 11 weight: 11
identifier: "backup-and-restore" identifier: "backup-and-restore"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "备份与恢复" name: "备份与恢复"
weight: 11 weight: 11
identifier: "backup-and-restore" identifier: "backup-and-restore"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "備份與還原" name: "備份與還原"
weight: 11 weight: 11
identifier: "backup-and-restore" identifier: "backup-and-restore"
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Embedded data extraction tool" name: "Embedded data extraction tool"
weight: 40 weight: 20
identifier: "cmd-embedded" identifier: "cmd-embedded"
--- ---
@@ -21,7 +21,7 @@ menu:
Gitea's executable contains all the resources required to run: templates, images, style-sheets 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 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 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. 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. 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 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 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. The `--overwrite` flag allows any existing files in the destination directory to be overwritten.
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "Command Line" name: "Command Line"
weight: 10 weight: 1
identifier: "command-line" identifier: "command-line"
--- ---
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Config Cheat Sheet" name: "Config Cheat Sheet"
weight: 20 weight: 30
identifier: "config-cheat-sheet" 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. - `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`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address). - `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address).
- `PASSWD`: **\<empty\>**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password. - `PASSWD`: **\<empty\>**: 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. - `ENABLE_HELO`: **true**: Enable HELO operation.
- `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname. - `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname.
- `FROM`: **\<empty\>**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \<email@example.com\> format. - `FROM`: **\<empty\>**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \<email@example.com\> format.
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "配置说明" name: "配置说明"
weight: 20 weight: 30
identifier: "config-cheat-sheet" identifier: "config-cheat-sheet"
--- ---
@@ -7,10 +7,10 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Customizing Gitea" name: "Customizing Gitea"
identifier: "customizing-gitea" identifier: "customizing-gitea"
weight: 9 weight: 100
--- ---
# Customizing Gitea # 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/), 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. 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 Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
shouldn't be touched without fully understanding these components. shouldn't be touched without fully understanding these components.
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "自定义 Gitea 配置" name: "自定义 Gitea 配置"
weight: 9 weight: 100
identifier: "customizing-gitea" identifier: "customizing-gitea"
--- ---
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "Email setup" name: "Email setup"
weight: 12 weight: 12
identifier: "email-setup" 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. 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: Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Environment variables" name: "Environment variables"
weight: 20 weight: 10
identifier: "environment-variables" identifier: "environment-variables"
--- ---
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "环境变量清单" name: "环境变量清单"
weight: 20 weight: 10
identifier: "environment-variables" identifier: "environment-variables"
--- ---
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "External renderers" name: "External renderers"
weight: 40 weight: 60
identifier: "external-renderers" identifier: "external-renderers"
--- ---
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "Fail2ban setup" name: "Fail2ban setup"
weight: 16 weight: 16
identifier: "fail2ban-setup" identifier: "fail2ban-setup"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "设置 Fail2ban" name: "设置 Fail2ban"
weight: 16 weight: 16
identifier: "fail2ban-setup" identifier: "fail2ban-setup"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "Git LFS setup" name: "Git LFS setup"
weight: 12 weight: 12
identifier: "git-lfs-setup" identifier: "git-lfs-setup"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "HTTPS setup" name: "HTTPS setup"
weight: 12 weight: 12
identifier: "https-setup" identifier: "https-setup"
@@ -24,7 +24,7 @@ menu:
Before you enable HTTPS, make sure that you have valid SSL/TLS certificates. 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. 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: To use Gitea's built-in HTTPS support, you must change your `app.ini` file:
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Logging Configuration" name: "Logging Configuration"
weight: 55 weight: 40
identifier: "logging-configuration" identifier: "logging-configuration"
--- ---
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Mail templates" name: "Mail templates"
weight: 45 weight: 45
identifier: "mail-templates" identifier: "mail-templates"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Repository indexer" name: "Repository indexer"
weight: 45 weight: 45
identifier: "repo-indexer" identifier: "repo-indexer"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "Reverse Proxies" name: "Reverse Proxies"
weight: 16 weight: 16
identifier: "reverse-proxies" identifier: "reverse-proxies"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "administration"
name: "反向代理" name: "反向代理"
weight: 16 weight: 16
identifier: "reverse-proxies" identifier: "reverse-proxies"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "Search Engines Indexation" name: "Search Engines Indexation"
weight: 60 weight: 60
identifier: "search-engines-indexation" 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 ## Block search engines indexation using robots.txt
To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations, 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). Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).
@@ -7,9 +7,9 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "advanced" parent: "administration"
name: "GPG Commit Signatures" name: "GPG Commit Signatures"
weight: 20 weight: 50
identifier: "signing" identifier: "signing"
--- ---
-13
View File
@@ -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"
---
@@ -1,13 +1,13 @@
--- ---
date: "2021-01-22T00:00:00+02:00" date: "2021-01-22T00:00:00+02:00"
title: "Translation" title: "Contributing"
slug: "translation" slug: "contributing"
weight: 35 weight: 35
toc: false toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
name: "Translation" name: "Contributing"
weight: 50 weight: 50
identifier: "translation" identifier: "contributing"
--- ---
@@ -1,7 +1,7 @@
--- ---
date: "2021-01-22T00:00:00+02:00" date: "2021-01-22T00:00:00+02:00"
title: "Übersetzung" title: "Übersetzung"
slug: "translation" slug: "contributing"
weight: 35 weight: 35
toc: false toc: false
draft: false draft: false
@@ -9,5 +9,5 @@ menu:
sidebar: sidebar:
name: "Übersetzung" name: "Übersetzung"
weight: 50 weight: 50
identifier: "translation" identifier: "contributing"
--- ---
@@ -1,13 +1,13 @@
--- ---
date: "2021-01-22T00:00:00+02:00" date: "2021-01-22T00:00:00+02:00"
title: "翻譯" title: "貢獻"
slug: "translation" slug: "contributing"
weight: 35 weight: 35
toc: false toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
name: "翻譯" name: "貢獻"
weight: 50 weight: 50
identifier: "translation" identifier: "contributing"
--- ---
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "developers" parent: "contributing"
name: "Guidelines for Backend" name: "Guidelines for Backend"
weight: 20 weight: 20
identifier: "guidelines-backend" identifier: "guidelines-backend"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "developers" parent: "contributing"
name: "Guidelines for Frontend" name: "Guidelines for Frontend"
weight: 20 weight: 20
identifier: "guidelines-frontend" identifier: "guidelines-frontend"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "developers" parent: "contributing"
name: "Guidelines for Refactoring" name: "Guidelines for Refactoring"
weight: 20 weight: 20
identifier: "guidelines-refactoring" identifier: "guidelines-refactoring"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "features" parent: "contributing"
name: "Localization" name: "Localization"
weight: 20 weight: 20
identifier: "localization" identifier: "localization"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "features" parent: "contributing"
name: "本地化" name: "本地化"
weight: 20 weight: 20
identifier: "localization" identifier: "localization"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "features" parent: "contributing"
name: "在地化" name: "在地化"
weight: 20 weight: 20
identifier: "localization" identifier: "localization"
@@ -6,7 +6,7 @@ toc: true
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "translation" parent: "contributing"
name: "Übersetzungsrichtlinien" name: "Übersetzungsrichtlinien"
weight: 70 weight: 70
identifier: "translation-guidelines" identifier: "translation-guidelines"
@@ -6,7 +6,7 @@ toc: true
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "translation" parent: "contributing"
name: "Translation Guidelines" name: "Translation Guidelines"
weight: 70 weight: 70
identifier: "translation-guidelines" identifier: "translation-guidelines"
-13
View File
@@ -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"
---
-13
View File
@@ -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"
---
-13
View File
@@ -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"
---
+13
View File
@@ -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"
---
@@ -1,13 +1,13 @@
--- ---
date: "2016-12-01T16:00:00+02:00" date: "2016-12-01T16:00:00+02:00"
title: "Advanced" title: "开发"
slug: "advanced" slug: "development"
weight: 30 weight: 40
toc: false toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
name: "Advanced" name: "开发"
weight: 40 weight: 40
identifier: "advanced" identifier: "development"
--- ---
@@ -1,13 +1,13 @@
--- ---
date: "2016-12-01T16:00:00+02:00" date: "2016-12-01T16:00:00+02:00"
title: "进阶" title: "開發"
slug: "advanced" slug: "development"
weight: 30 weight: 40
toc: false toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
name: "进阶" name: "開發"
weight: 40 weight: 40
identifier: "advanced" identifier: "development"
--- ---
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "developers" parent: "development"
name: "API Usage" name: "API Usage"
weight: 40 weight: 40
identifier: "api-usage" identifier: "api-usage"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "developers" parent: "development"
name: "API 使用指南" name: "API 使用指南"
weight: 40 weight: 40
identifier: "api-usage" identifier: "api-usage"
@@ -7,7 +7,7 @@ toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "developers" parent: "development"
name: "Hacking on Gitea" name: "Hacking on Gitea"
weight: 10 weight: 10
identifier: "hacking-on-gitea" identifier: "hacking-on-gitea"
@@ -177,7 +177,7 @@ server as mentioned above.
### Working on JS and CSS ### 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: 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 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` `modules/setting` files. You should add information to `custom/conf/app.ini`
and to the and to the
<a href='{{< relref "doc/advanced/config-cheat-sheet.en-us.md" >}}'>configuration cheat sheet</a> <a href='{{< relref "doc/administration/config-cheat-sheet.en-us.md" >}}'>configuration cheat sheet</a>
found in `docs/content/doc/advanced/config-cheat-sheet.en-us.md` found in `docs/content/doc/administer/config-cheat-sheet.en-us.md`
### Changing the logo ### Changing the logo
Loaded 50 of 120 files, more files were not shown because too many files have changed in this diff. Show more