diff options
Diffstat (limited to 'doc/user/markdown.md')
| -rw-r--r-- | doc/user/markdown.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 372442bb53f..d5ca098c8c5 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -697,6 +697,9 @@ GitLab Flavored Markdown recognizes the following: | Snippet | `$123` | `namespace/project$123` | `project$123` | | [Epic](group/epics/index.md) | `&123` | `group1/subgroup&123` | | | [Iteration](group/iterations/index.md) | `*iteration:"iteration title"` | | | +| [Iteration cadence](group/iterations/index.md) by ID<sup>1</sup> | `[cadence:123]` | | | +| [Iteration cadence](group/iterations/index.md) by title (one word)<sup>1</sup> | `[cadence:plan]` | | | +| [Iteration cadence](group/iterations/index.md) by title (multiple words)<sup>1</sup> | `[cadence:"plan a"]` | | | | [Vulnerability](application_security/vulnerabilities/index.md) | `[vulnerability:123]` | `[vulnerability:namespace/project/123]` | `[vulnerability:project/123]` | | Feature flag | `[feature_flag:123]` | `[feature_flag:namespace/project/123]` | `[feature_flag:project/123]` | | Label by ID | `~123` | `namespace/project~123` | `project~123` | @@ -713,6 +716,15 @@ GitLab Flavored Markdown recognizes the following: | [Alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` | | [Contact](crm/index.md#contacts) | `[contact:test@example.com]` | | | +<ol> + <li> + <small> + <a href="https://gitlab.com/gitlab-org/gitlab/-/issues/384885">Introduced</a> in GitLab 16.9. Iteration cadence references are always rendered following the format <code>[cadence:<ID>]</code>. + For example, the text reference <code>[cadence:"plan"]</code> renders as <code>[cadence:1]</code> if the referenced iterations cadence's ID is <code>1</code>. + </small> + </li> +</ol> + For example, referencing an issue by using `#123` formats the output as a link to issue number 123 with text `#123`. Likewise, a link to issue number 123 is recognized and formatted with text `#123`. If you don't want `#123` to link to an issue, |