1
1
mirror of https://github.com/go-gitea/gitea synced 2024-07-07 10:35:48 +00:00
gitea/docs/content/doc/usage/labels.en-us.md
John Olheiser bb25f85ce8
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 11:33:41 +08:00

1.9 KiB

date title slug weight toc draft aliases menu
2023-03-04T19:00:00+00:00 Labels labels 13 false false
/en-us/labels
sidebar
parent name weight identifier
usage Labels 13 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.

Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see Scoped Labels below).

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. Its contained labels will all be created as well while creating the repository.

Scoped Labels

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.

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.

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.