tdsds.com/gitea
tdsds.com/gitea
1
1
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-11-14 06:04:25 +00:00
Code Releases Activity
9da0dc16ad
gitea/docs/content/usage/labels.en-us.md

43 lines
1.9 KiB
Markdown
Raw Normal View History

Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
---
date: "2023-03-04T19:00:00+00:00"
Adjust some documentations titles (#23941) As title.
2023-04-06 09:06:32 +00:00
title: "Labels"
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
slug: "labels"
Docusaurus-ify (#26051) This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-07-26 04:53:13 +00:00
sidebar_position: 13
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
toc: false
draft: false
Refactor docs (#23752) This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 03:33:41 +00:00
aliases:
- /en-us/labels
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
menu:
sidebar:
parent: "usage"
name: "Labels"
Docusaurus-ify (#26051) This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-07-26 04:53:13 +00:00
sidebar_position: 13
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
identifier: "labels"
---
# Labels
You can use labels to classify issues and pull requests and to improve your overview over them.
## Creating Labels
For repositories, labels can be created by going to `Issues` and clicking on `Labels`.
For organizations, you can define organization-wide labels that are shared with all organization repositories, including both already-existing repositories as well as newly created ones. Organization-wide labels can be created in the organization `Settings`.
Scoped label display and documentation tweaks (#23430) * Fix scoped label left and right part breaking across lines. * Remove slanted divider in scoped label display, make it straight. After using this for a while, this feels more visually noisy than helpful. * Reduce contrast between scope and item to reduce probability of unreadable text on background. * Change documentation to remove mention of non-exclusive scoped labels. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-03-13 00:46:13 +00:00
Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see `Scoped Labels` below).
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
Fix link to customizing-gitea (#25056) The link to customizing-gitea in the label documentation is broken. This PR should adjust the relative path to fix the link
2023-06-03 02:27:40 +00:00
When you create a repository, you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are [configured globally on your instance](../administration/customizing-gitea/#labels). Its contained labels will all be created as well while creating the repository.
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
## Scoped Labels
Scoped label display and documentation tweaks (#23430) * Fix scoped label left and right part breaking across lines. * Remove slanted divider in scoped label display, make it straight. After using this for a while, this feels more visually noisy than helpful. * Reduce contrast between scope and item to reduce probability of unreadable text on background. * Change documentation to remove mention of non-exclusive scoped labels. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-03-13 00:46:13 +00:00
Scoped labels are used to ensure at most a single label with the same scope is assigned to an issue or pull request. For example, if labels `kind/bug` and `kind/enhancement` have the Exclusive option set, an issue can only be classified as a bug or an enhancement.
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
Scoped label display and documentation tweaks (#23430) * Fix scoped label left and right part breaking across lines. * Remove slanted divider in scoped label display, make it straight. After using this for a while, this feels more visually noisy than helpful. * Reduce contrast between scope and item to reduce probability of unreadable text on background. * Change documentation to remove mention of non-exclusive scoped labels. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-03-13 00:46:13 +00:00
A scoped label must contain `/` in its name (not at either end of the name). The scope of a label is determined based on the **last** `/`, so for example the scope of label `scope/subscope/item` is `scope/subscope`.
Add basic documentation for labels, including scoped labels (#23304) Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
2023-03-05 12:35:12 +00:00
## Filtering by Label
Issue and pull request lists can be filtered by label. Selecting multiple labels shows issues and pull requests that have all selected labels assigned.
By holding alt to click the label, issues and pull requests with the chosen label are excluded from the list.
Copy Permalink