Update documentation for the new YAML label file format (go-gitea#23020)

update documentation to include an overview of the yaml label template that is part of PR go-gitea#22976 Signed-off-by: Jon Roadley-Battin <[email protected]> --------- Co-authored-by: Yarden Shoham <[email protected]> Co-authored-by: Lauris BH <[email protected]> Co-authored-by: John Olheiser <[email protected]> Co-authored-by: delvh <[email protected]>
GiteaBot · Mar 6, 2023 · caaee6f · caaee6f
1 parent 8ab50be
commit caaee6f
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/advanced/customizing-gitea.en-us.md
@@ -282,9 +282,22 @@ To add custom .gitignore, add a file with existing [.gitignore rules](https://gi
 
 ### Labels
 
-To add a custom label set, add a file that follows the [label format](https://github.com/go-gitea/gitea/blob/main/options/label/Default) to `$GITEA_CUSTOM/options/label`
+Starting with Gitea 1.19, you can add a file that follows the [YAML label format](https://github.com/go-gitea/gitea/blob/main/options/label/Advanced.yaml) to `$GITEA_CUSTOM/options/label`:
+
+```yaml
+labels:
+  - name: "foo/bar"  # name of the label that will appear in the dropdown
+    exclusive: true # whether to use the exclusive namespace for scoped labels. scoped delimiter is /
+    color: aabbcc # hex colour coding
+    description: Some label # long description of label intent
+ ```
+
+The [legacy file format](https://github.com/go-gitea/gitea/blob/main/options/label/Default) can still be used following the format below, however we strongly recommend using the newer YAML format instead.
+
 `#hex-color label name ; label description`
 
+For more information, see the [labels documentation]({{< relref "doc/usage/labels.en-us.md" >}}).
+
 ### Licenses
 
 To add a custom license, add a file with the license text to `$GITEA_CUSTOM/options/license`