summaryrefslogtreecommitdiff
path: root/doc/user/markdown.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/markdown.md')
-rw-r--r--doc/user/markdown.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md
index 8b65da4ab94..4bdf72673a1 100644
--- a/doc/user/markdown.md
+++ b/doc/user/markdown.md
@@ -425,6 +425,7 @@ GFM recognizes the following:
| merge request | `!123` | `namespace/project!123` | `project!123` |
| snippet | `$123` | `namespace/project$123` | `project$123` |
| epic **(ULTIMATE)** | `&123` | `group1/subgroup&123` | |
+| vulnerability **(ULTIMATE)** *(1)* | `[vulnerability:123]` | `[vulnerability:namespace/project/123]` | `[vulnerability:project/123]` |
| label by ID | `~123` | `namespace/project~123` | `project~123` |
| one-word label by name | `~bug` | `namespace/project~bug` | `project~bug` |
| multi-word label by name | `~"feature request"` | `namespace/project~"feature request"` | `project~"feature request"` |
@@ -438,6 +439,26 @@ GFM recognizes the following:
| repository file line references | `[README](doc/README#L13)` | | |
| [alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` |
+1. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/281035) in GitLab 13.6.
+
+ The Vulnerability special references feature is under development but ready for production use.
+ It is deployed behind a feature flag that is **disabled by default**.
+ [GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md)
+ can opt to enable it for your instance.
+ It's disabled on GitLab.com.
+
+ To disable it:
+
+ ```ruby
+ Feature.disable(:vulnerability_special_references)
+ ```
+
+ To enable it:
+
+ ```ruby
+ Feature.enable(:vulnerability_special_references)
+ ```
+
For example, referencing an issue by using `#123` will format the output as a link
to issue number 123 with text `#123`. Likewise, a link to issue number 123 will be
recognized and formatted with text `#123`.
@@ -532,7 +553,7 @@ If this snippet was placed on a page at `<your_wiki>/documentation/main`,
it would link to `<your_wiki>/documentation/related`:
```markdown
-[Link to Related Page](./related)
+[Link to Related Page](related)
```
If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
@@ -546,7 +567,7 @@ If this snippet was placed on a page at `<your_wiki>/documentation/main`,
it would link to `<your_wiki>/documentation/related.md`:
```markdown
-[Link to Related Page](./related.md)
+[Link to Related Page](related.md)
```
If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,