- ![]()
+ ![]()
middleware(Background job: JSON generation)
end
diff --git a/doc/subscriptions/choosing_subscription.md b/doc/subscriptions/choosing_subscription.md
index a332d189248..63c2b9a587f 100644
--- a/doc/subscriptions/choosing_subscription.md
+++ b/doc/subscriptions/choosing_subscription.md
@@ -42,7 +42,10 @@ The following chart should help you determine your subscription model. Select
the list item to go to the respective help page.
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
+ accTitle: My subscription
+ accDescr: Determine your subscription model and see its help page
A(Is your user account on GitLab.com?)
A --> B(Yes)
diff --git a/doc/tutorials/agile_sprint/index.md b/doc/tutorials/agile_sprint/index.md
index da4ae9fef0d..b283e108300 100644
--- a/doc/tutorials/agile_sprint/index.md
+++ b/doc/tutorials/agile_sprint/index.md
@@ -50,7 +50,11 @@ disable the automated scheduling to
Similar to membership, iterations cascade down your group, subgroup, and project hierarchy. If your team has multiple groups and projects, create the iteration cadence in the top-most shared group:
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
+ accTitle: Iteration cadence
+ accDescr: Identify the group you should create an iteration cadence in
+
Group --> SubgroupA --> Project1
Group --> SubgroupB --> Project2
Group --> IterationCadence
@@ -88,7 +92,7 @@ the "Open" list into iteration lists to schedule them for upcoming iterations.
To visualize the workflow for issues in the current iteration, create another issue board called
"Current Iteration." When you're creating the board:
-1. Select **Edit board**.
+1. Select **Configure board** (**{settings}**).
1. Next to **Iteration**, select **Edit**.
1. From the dropdown list, select **Current iteration**.
1. Select **Save changes**.
diff --git a/doc/tutorials/make_first_git_commit/index.md b/doc/tutorials/make_first_git_commit/index.md
index e80cd6770d0..c95cabfe7f2 100644
--- a/doc/tutorials/make_first_git_commit/index.md
+++ b/doc/tutorials/make_first_git_commit/index.md
@@ -35,7 +35,11 @@ Each time you push a change, Git records it as a unique *commit*. These commits
the history of when and how a file changed, and who changed it.
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
graph LR
+ accTitle: Repository commit history
+ accDescr: Flowchart showing linear changes to a repository history
+
subgraph Repository commit history
direction LR
A(Author: Alex
Date: 3 Jan at 1PM
Commit message: Added sales figures
Commit ID: 123abc12) ---> B @@ -53,7 +57,11 @@ of a repository are in a default branch. To make changes, you: 1. When you're ready, *merge* your branch into the default branch. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart LR + accTitle: Use branches in Git + accDescr: The flow of creating, then using, a branch in Git + subgraph Default branch A[Commit] --> B[Commit] --> C[Commit] --> D[Commit] end diff --git a/doc/tutorials/scrum_events/index.md b/doc/tutorials/scrum_events/index.md index ab4fcb28421..a953987adca 100644 --- a/doc/tutorials/scrum_events/index.md +++ b/doc/tutorials/scrum_events/index.md @@ -49,6 +49,7 @@ standardize labels, boards, and iterations across multiple projects: flowchart TD accTitle: GitLab inheritance model diagram accDescr: Shows how groups, projects, issues, labels, milestones, iterations, tasks, and epics relate to one another in GitLab + Group -->|Contains| Project Group -->|Contains| Epics Group -->|Contains| Labels @@ -224,7 +225,11 @@ GitLab is extensible to support different flavors of backlog management. For this tutorial, we will structure our deliverables in the following way: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart TD + accTitle: Deliverables structure + accDescr: Flowchart of features (epics) to job stories (issues) to implementation steps (tasks) + Epic["Feature (Epic)"] --> Issue["Job Story (Issue)"] Issue --> Task["Implementation Step (Task)"] ``` @@ -258,10 +263,14 @@ Here's an example of breaking a feature into vertically sliced job stories based journey: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart TD -Epic["Epic: When using the application, I need to create an
account, so that I can use the application features"] --> Issue1["Issue: When creating my account, I need to specify my email address,
so that I can receive future updates from the application"] - Epic --> Issue2["Issue: When creating my account, I need to
specify a password, so that my account remains secure"] - Epic --> Issue3["Issue: When creating my account and entering the required info, I need to
finalize creating my account, so that I can log in"] + accTitle: Slicing a feature + accDescr: Use the end user's journey to identify slices of work to be completed in iterations + +Epic["Epic: When using the application,
I need to create an account,
so I can use the application features"] --> Issue1["Issue: When creating my account,
I need to specify my email address,
so I can receive future updates from the application"] + Epic --> Issue2["Issue: When creating my account,
I need to specify a password,
so my account remains secure"] + Epic --> Issue3["Issue: When creating my account
and entering the required info,
I need to finalize creating my account,
so I can log in"] ``` You've taken the feature of an unmodified account sign-up for an application and broke it down into @@ -275,12 +284,16 @@ After you have broken down a feature into stories, you can further break down th implementation steps: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart TD - Issue1["Issue: When creating my account, I need to specify my email address,
so that I can receive future updates from the application"] - Issue1 --> Task2["Task: Backend - Validate email formatting"] - Issue1 --> Task3["Task: Backend - API endpoint to accept POST request from client"] - Issue1 --> Task4["Task: Frontend - Display email input"] - Issue1 --> Task5["Task: Frontend - Display error message when validation fails"] + accTitle: Break the story down further + accDescr: Split apart a story into smaller steps + + Issue1["Issue: When creating my account,
I need to specify my email address,
so I can receive future updates from the application"] + Issue1 --> Task2["Task: Backend
Validate email formatting"] + Issue1 --> Task3["Task: Backend
API endpoint to accept
POST request from client"] + Issue1 --> Task4["Task: Frontend
Display email input"] + Issue1 --> Task5["Task: Frontend
Display error message when validation fails"] ``` ### Set up a release planning board diff --git a/doc/user/ai_experiments.md b/doc/user/ai_experiments.md index fd34f79315f..2ad2ad189f7 100644 --- a/doc/user/ai_experiments.md +++ b/doc/user/ai_experiments.md @@ -141,8 +141,7 @@ To use this feature: - Belong to at least one group with the [experiment and beta features setting](ai_features_enable.md#turn-on-beta-and-experimental-features) enabled. - Have sufficient permissions to view the CI/CD job. -When the feature is available, the "Root cause analysis" button will appears on -a failed CI/CD job. Selecting this button generates an analysis regarding the +When the feature is available, the "Troubleshoot" button displays on failed CI/CD jobs. Selecting this option generates an analysis regarding the reason for the failure. ## Summarize an issue with Issue description generation diff --git a/doc/user/group/epics/epic_boards.md b/doc/user/group/epics/epic_boards.md index 2505d1f336c..3cf0857833a 100644 --- a/doc/user/group/epics/epic_boards.md +++ b/doc/user/group/epics/epic_boards.md @@ -212,7 +212,7 @@ Prerequisites: To edit the scope of an epic board: -1. In the upper-right corner, select **Edit board**. +1. In the upper-right corner, select **Configure board** (**{settings}**). 1. Optional: - Edit the board's title. - Show or hide the Open and Closed columns. diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md index 4f6f960f59c..0eb12973dfe 100644 --- a/doc/user/group/epics/index.md +++ b/doc/user/group/epics/index.md @@ -41,7 +41,10 @@ The possible relationships between epics and issues are: - An epic is the parent of one or more [child epics](manage_epics.md#multi-level-child-epics). Ultimate only. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TD +accTitle: Epics and issues +accDescr: How issues and child epics relate to parent epics Parent_epic --> Issue1 Parent_epic --> Child_epic Child_epic --> Issue2 diff --git a/doc/user/group/planning_hierarchy/index.md b/doc/user/group/planning_hierarchy/index.md index 332b4daa3af..e7ac62a0823 100644 --- a/doc/user/group/planning_hierarchy/index.md +++ b/doc/user/group/planning_hierarchy/index.md @@ -28,7 +28,10 @@ portfolio management, see With epics, you can achieve the following hierarchy: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TD +accTitle: Hierarchies with epics +accDescr: Use epics to link projects, issues, and groups Group_epic --> Project1_Issue1 Group_epic --> Project1_Issue2 Group_epic --> Project2_Issue1 @@ -48,6 +51,7 @@ Image below was generated with the following Mermaid code. Attached as an image because a rendered diagram doesn't look clear on the docs page. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% classDiagram direction TD class Epic diff --git a/doc/user/group/saml_sso/group_sync.md b/doc/user/group/saml_sso/group_sync.md index 9328d682090..93d0d73f83f 100644 --- a/doc/user/group/saml_sso/group_sync.md +++ b/doc/user/group/saml_sso/group_sync.md @@ -142,7 +142,7 @@ group overage claim attribute in the SAML response. Then group memberships must The [Graph API endpoint](https://learn.microsoft.com/en-us/graph/api/user-list-transitivememberof?view=graph-rest-1.0&tabs=http#http-request) supports only a [user object ID](https://learn.microsoft.com/en-us/partner-center/find-ids-and-domain-names#find-the-user-object-id) or [userPrincipalName](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/plan-connect-userprincipalname#what-is-userprincipalname) -as the [configured](../../../user/group/saml_sso/index.md#azure) Unique User Identifier (Name identifier) attribute. +as the [configured](../../../user/group/saml_sso/index.md#azure) Unique User Identifier (Name identifier) attribute. When the integration processes Group Sync, only Group Links configured with group unique identifiers (like `12345678-9abc-def0-1234-56789abcde`) are supported. @@ -249,6 +249,7 @@ For example, in the following diagram: not yet signed in. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TB subgraph SAML users SAMLUserA[Sidney Jones] @@ -274,6 +275,7 @@ graph TB ``` ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TB subgraph GitLab users GitLabUserA[Sidney Jones] @@ -283,9 +285,9 @@ graph TB end subgraph GitLab groups - GitLabGroupA["Group A (SAML configured)"] --> GitLabGroupB["Group B (SAML Group Link not configured)"] - GitLabGroupA --> GitLabGroupC["Group C (SAML Group Link configured)"] - GitLabGroupA --> GitLabGroupD["Group D (SAML Group Link configured)"] + GitLabGroupA["Group A
(SAML configured)"] --> GitLabGroupB["Group B
(SAML Group Link not configured)"] + GitLabGroupA --> GitLabGroupC["Group C
(SAML Group Link configured)"] + GitLabGroupA --> GitLabGroupD["Group D
(SAML Group Link configured)"] end GitLabGroupB --> |Member|GitLabUserA @@ -308,9 +310,9 @@ graph TB subgraph GitLab groups after Alex Garcia signs in GitLabGroupA[Group A] - GitLabGroupA["Group A (SAML configured)"] --> GitLabGroupB["Group B (SAML Group Link not configured)"] - GitLabGroupA --> GitLabGroupC["Group C (SAML Group Link configured)"] - GitLabGroupA --> GitLabGroupD["Group D (SAML Group Link configured)"] + GitLabGroupA["Group A
(SAML configured)"] --> GitLabGroupB["Group B
(SAML Group Link not configured)"] + GitLabGroupA --> GitLabGroupC["Group C
(SAML Group Link configured)"] + GitLabGroupA --> GitLabGroupD["Group D
(SAML Group Link configured)"] end GitLabGroupB --> |Member|GitLabUserA diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 682a01a2ee7..25846eaeb1a 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -116,248 +116,133 @@ If there is no otherwise meaningful value for a cell, consider entering **N/A** Describe the image or video in the `[alt text]`. Make the description accurate, succinct, and unique. Don't use `image of` or `video of` in the description. For more information, see [WebAim Alternative Text](https://webaim.org/techniques/alttext/). -## Colors +## Line breaks -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#colors). +[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#line-breaks). -Markdown does not support changing text color. - -You can write a color code in the formats: `HEX`, `RGB`, or `HSL`. - -- `HEX`: `` `#RGB[A]` `` or `` `#RRGGBB[AA]` `` -- `RGB`: `` `RGB[A](R, G, B[, A])` `` -- `HSL`: `` `HSL[A](H, S, L[, A])` `` - -Named colors are not supported. - -In the GitLab application (but not the GitLab documentation) color codes in backticks -display a color chip next to the color code. For example: +A line break is inserted (a new paragraph starts) if the previous text is +ended with two newlines, like when you press Enter twice in a row. If you only +use one newline (press Enter once), the next sentence remains part of the +same paragraph. Use this approach if you want to keep long lines from wrapping, and keep +them editable: ```markdown -- `#F00` -- `#F00A` -- `#FF0000` -- `#FF0000AA` -- `RGB(0,255,0)` -- `RGB(0%,100%,0%)` -- `RGBA(0,255,0,0.3)` -- `HSL(540,70%,50%)` -- `HSLA(540,70%,50%,0.3)` +Here's a line for us to start with. + +This longer line is separated from the one above by two newlines, so it is a *separate paragraph*. + +This line is also a separate paragraph, but... +These lines are only separated by single newlines, +so they *do not break* and just follow the previous lines +in the *same paragraph*. ``` -- `#F00` -- `#F00A` -- `#FF0000` -- `#FF0000AA` -- `RGB(0,255,0)` -- `RGB(0%,100%,0%)` -- `RGBA(0,255,0,0.3)` -- `HSL(540,70%,50%)` -- `HSLA(540,70%,50%,0.3)` +Here's a line for us to start with. -## Diagrams and flowcharts +This longer line is separated from the one above by two newlines, so it is a *separate paragraph*. -You can generate diagrams from text by using: +This line is also a separate paragraph, but... +These lines are only separated by single newlines, +so they *do not break* and just follow the previous lines +in the *same paragraph*. -- [Mermaid](https://mermaidjs.github.io/) -- [PlantUML](https://plantuml.com) -- [Kroki](https://kroki.io) to create a wide variety of diagrams. +### Newlines -In wikis, you can also add and edit diagrams created with the [diagrams.net editor](#diagramsnet-editor). +GitLab Flavored Markdown adheres to the Markdown specification for handling +[paragraphs and line breaks](https://spec.commonmark.org/current/). -### Mermaid +A paragraph is one or more consecutive lines of text, separated by one or +more blank lines (two newlines at the end of the first paragraph), as [explained above](#line-breaks). -> - Support for Entity Relationship diagrams and mindmaps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384386) in GitLab 16.0. - -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#mermaid). - -Visit the [official page](https://mermaidjs.github.io/) for more details. The -[Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/) helps you -learn Mermaid and debug issues in your Mermaid code. Use it to identify and resolve -issues in your diagrams. - -To generate a diagram or flowchart, write your text inside the `mermaid` block: - -````markdown -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` -```` - -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` - -You can also include subgraphs: - -````markdown -```mermaid -graph TB - - SubGraph1 --> SubGraph1Flow - subgraph "SubGraph 1 Flow" - SubGraph1Flow(SubNode 1) - SubGraph1Flow -- Choice1 --> DoChoice1 - SubGraph1Flow -- Choice2 --> DoChoice2 - end - - subgraph "Main Graph" - Node1[Node 1] --> Node2[Node 2] - Node2 --> SubGraph1[Jump to SubGraph1] - SubGraph1 --> FinalThing[Final Thing] -end -``` -```` - -```mermaid -graph TB - - SubGraph1 --> SubGraph1Flow - subgraph "SubGraph 1 Flow" - SubGraph1Flow(SubNode 1) - SubGraph1Flow -- Choice1 --> DoChoice1 - SubGraph1Flow -- Choice2 --> DoChoice2 - end - - subgraph "Main Graph" - Node1[Node 1] --> Node2[Node 2] - Node2 --> SubGraph1[Jump to SubGraph1] - SubGraph1 --> FinalThing[Final Thing] -end -``` - -### PlantUML - -PlantUML integration is enabled on GitLab.com. To make PlantUML available in self-managed -installation of GitLab, a GitLab administrator [must enable it](../administration/integration/plantuml.md). - -### Kroki - -To make Kroki available in GitLab, a GitLab administrator must enable it. -For more information, see the [Kroki integration](../administration/integration/kroki.md) page. - -## Emoji - -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emoji). - -Sometimes you want to
around a bit and add some 
to your 
. Well we have a gift for you:
-
-
You can use emoji anywhere GitLab Flavored Markdown is supported. 
-
-You can use it to point out a 
or warn about 
patches. If someone improves your really 
code, send them some 
. People 
you for that.
-
-If you're new to this, don't be 
. You can join the emoji 
. Just look up one of the supported codes.
-
-Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of all supported emoji codes. 
-
-The above paragraphs in raw Markdown:
+Need more control over line breaks or soft returns? Add a single line break
+by ending a line with a backslash, or two or more spaces. Two newlines in a row create a new
+paragraph, with a blank line in between:
```markdown
-Sometimes you want to :monkey: around a bit and add some :star2: to your
-:speech_balloon:. Well we have a gift for you:
+First paragraph.
+Another line in the same paragraph.
+A third line in the same paragraph, but this time ending with two spaces.
+A new line directly under the first paragraph.
-:zap: You can use emoji anywhere GitLab Flavored Markdown is supported. :v:
-
-You can use it to point out a :bug: or warn about :speak_no_evil: patches.
-And if someone improves your really :snail: code, send them some :birthday:.
-People :heart: you for that.
-
-If you're new to this, don't be :fearful:. You can join the emoji :family:.
-Just look up one of the supported codes.
-
-Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)
-for a list of all supported emoji codes. :thumbsup:
+Second paragraph.
+Another line, this time ending with a backslash.\
+A new line due to the previous backslash.
```
-### Emoji and your operating system
+## Emphasis
-The previous emoji example uses hard-coded images. Rendered emoji
-in GitLab might look different depending on the OS and browser used.
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emphasis).
-Most emoji are natively supported on macOS, Windows, iOS, Android, and fall back on image-based
-emoji where there is no support.
+You can emphasize text in multiple ways. Use italics, bold, strikethrough,
+or combine these emphasis styles together.
+
+Examples:
+
+```markdown
+Emphasis, or italics, with *asterisks* or _underscores_.
+
+Strong emphasis, or bold, with double **asterisks** or __underscores__.
+
+Combined emphasis with **asterisks and _underscores_**.
+
+Strikethrough with double tildes. ~~Scratch this.~~
+```
+
+
+
+Emphasis, or italics, with *asterisks* or _underscores_.
+
+Strong emphasis, or bold, with double **asterisks** or __underscores__.
+
+Combined emphasis with **asterisks and _underscores_**.
+
+Strikethrough with double tildes. ~~Scratch this.~~
+
+
+
+### Multiple underscores in words and mid-word emphasis
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#multiple-underscores-in-words).
+
+Avoid italicizing a portion of a word, especially when you're
+dealing with code and names that often appear with multiple underscores.
+
+GitLab Flavored Markdown ignores multiple underlines in words,
+to allow better rendering of Markdown documents discussing code:
+
+```markdown
+perform_complicated_task
+
+do_this_and_do_that_and_another_thing
+
+but_emphasis is_desired _here_
+```
-On Linux, you can download [Noto Color Emoji](https://github.com/googlefonts/noto-emoji)
-to get full native emoji support. Ubuntu 22.04 (like many modern Linux distributions) has
-this font installed by default.
+perform_complicated_task
+
+do_this_and_do_that_and_another_thing
+
+but_emphasis is_desired _here_
-To learn more about adding custom emoji, see [Custom emoji](emoji_reactions.md#custom-emoji).
-
-## Front matter
-
-Front matter is metadata included at the beginning of a Markdown document, preceding
-the content. This data can be used by static site generators like [Jekyll](https://jekyllrb.com/docs/front-matter/),
-[Hugo](https://gohugo.io/content-management/front-matter/), and many other applications.
-
-When you view a Markdown file rendered by GitLab, front matter is displayed as-is,
-in a box at the top of the document. The HTML content displays after the front matter. To view an example,
-you can toggle between the source and rendered version of a
-[GitLab documentation file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/index.md).
-
-In GitLab, front matter is used only in Markdown files and wiki pages, not the other
-places where Markdown formatting is supported. It must be at the very top of the document
-and must be between delimiters.
-
-The following delimiters are supported:
-
-- YAML (`---`):
-
- ```yaml
- ---
- title: About Front Matter
- example:
- language: yaml
- ---
- ```
-
-- TOML (`+++`):
-
- ```toml
- +++
- title = "About Front Matter"
- [example]
- language = "toml"
- +++
- ```
-
-- JSON (`;;;`):
-
- ```json
- ;;;
- {
- "title": "About Front Matter"
- "example": {
- "language": "json"
- }
- }
- ;;;
- ```
-
-Other languages are supported by adding a specifier to any of the existing
-delimiters. For example:
-
-```php
----php
-$title = "About Front Matter";
-$example = array(
- 'language' => "php",
-);
---
+
+If you wish to emphasize only a part of a word, it can still be done with asterisks:
+
+```markdown
+perform*complicated*task
+
+do*this*and*do*that*and*another thing
```
-## Inline diff
+perform*complicated*task
+
+do*this*and*do*that*and*another thing
+
+### Inline diff
[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#inline-diff).
@@ -396,64 +281,426 @@ each backtick with a backslash
+-
+-
+
+
+
+## Multimedia
+
+Embed images, videos, and audio.
+You can add multimedia using Markdown syntax to link files, set dimensions, and display them inline.
+Formatting options let you customize titles, specify width and height, and control how media appears
+in the rendered output.
+
+### Images
+
+Embed images using inline or reference links.
+To see title text, hover over the image.
+
+
+
+
+
+
+
+Inline-style:
+
+
+
+/documentation/related`,
-it links to `/documentation/file.md`:
-
-```markdown
-[Link to File](file.md)
-```
-
-### Wiki - hierarchical link
-
-A hierarchical link can be constructed relative to the current wiki page by using `./`,
-`../`, and so on.
-
-If this example is on a page at `/documentation/main`,
-it links to `/documentation/related`:
-
-```markdown
-[Link to Related Page](related)
-```
-
-If this example is on a page at `/documentation/related/content`,
-it links to `/documentation/main`:
-
-```markdown
-[Link to Related Page](../main)
-```
-
-If this example is on a page at `/documentation/main`,
-it links to `/documentation/related.md`:
-
-```markdown
-[Link to Related Page](related.md)
-```
-
-If this example is on a page at `/documentation/related/content`,
-it links to `/documentation/main.md`:
-
-```markdown
-[Link to Related Page](../main.md)
-```
-
-### Wiki - root link
-
-A root link starts with a `/` and is relative to the wiki root.
-
-This example links to `/documentation`:
-
-```markdown
-[Link to Related Page](/documentation)
-```
-
-This example links to `/miscellaneous.md`:
-
-```markdown
-[Link to Related Page](/miscellaneous.md)
-```
-
-### diagrams.net editor
-
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322174) in GitLab 15.10.
-
-In wikis, you can use the [diagrams.net](https://www.diagrams.net/) editor to create diagrams. You
-can also edit diagrams created with the diagrams.net editor. The diagram editor is available in both
-the plain text editor and the rich text editor.
-
-For more information, see [Diagrams.net](../administration/integration/diagrams_net.md).
-
-#### Plain text editor
-
-To create a diagram in the plain text editor:
-
-1. On the wiki page you want to edit, select **Edit**.
-1. In the text box, make sure you're using the plain text editor
- (the button on the bottom left says **Switch to rich text editing**).
-1. In the editor's toolbar, select **Insert or edit diagram** (**{diagram}**).
-1. Create the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
-1. Select **Save & exit**.
-
-A Markdown image reference to the diagram is inserted in the wiki content.
-
-To edit a diagram in the plain text editor:
-
-1. On the wiki page you want to edit, select **Edit**.
-1. In the text box, make sure you're using the plain text editor
- (the button on the bottom left says **Switch to rich text editing**).
-1. Position your cursor in the Markdown image reference that contains the diagram.
-1. Select **Insert or edit diagram** (**{diagram}**).
-1. Edit the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
-1. Select **Save & exit**.
-
-A Markdown image reference to the diagram is inserted in the wiki content,
-replacing the previous diagram.
-
-#### Rich text editor
-
-To create a diagram in the rich text editor:
-
-1. On the wiki page you want to edit, select **Edit**.
-1. In the text box, make sure you're using the rich text editor
- (the button on the bottom left says **Switch to plain text editing**).
-1. In the editor's toolbar, select **More options** (**{plus}**).
-1. In the dropdown list, select **Create or edit diagram**.
-1. Create the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
-1. Select **Save & exit**.
-
-The diagram as visualized in the diagrams.net editor is inserted in the wiki content.
-
-To edit a diagram in the rich text editor:
-
-1. On the wiki page you want to edit, select **Edit**.
-1. In the text box, make sure you're using the rich text editor
- (the button on the bottom left says **Switch to plain text editing**).
-1. Select the diagram that you want to edit.
-1. In the floating toolbar, select **Edit diagram** (**{diagram}**).
-1. Edit the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
-1. Select **Save & exit**.
-
-The selected diagram is replaced with an updated version.
-
-## GitLab-specific references
-
-> - Autocomplete for wiki pages [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/442229) in GitLab 16.11.
-
-GitLab Flavored Markdown renders GitLab-specific references. For example, you can reference
-an issue, a commit, a team member, or even an entire project team. GitLab Flavored Markdown turns
-that reference into a link so you can navigate between them. All references to projects should use the
-**project slug** rather than the project name.
-
-Additionally, GitLab Flavored Markdown recognizes certain cross-project references and also has a shorthand
-version to reference other projects from the same namespace.
-
-GitLab Flavored Markdown recognizes the following:
-
-| References | Input | Cross-project reference | Shortcut inside the same namespace |
-|--------------------------------------------------------------------------------------|-------------------------------------------------------|-----------------------------------------|------------------------------------|
-| Specific user | `@user_name` | | |
-| Specific group | `@group_name` | | |
-| Entire team | [`@all`](discussions/index.md#mentioning-all-members) | | |
-| Project | `namespace/project>` | | |
-| Issue | ``#123`` | `namespace/project#123` | `project#123` |
-| Merge request | `!123` | `namespace/project!123` | `project!123` |
-| 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 ID1 | `[cadence:123]` | | |
-| [Iteration cadence](group/iterations/index.md) by title (one word)1 | `[cadence:plan]` | | |
-| [Iteration cadence](group/iterations/index.md) by title (multiple words)1 | `[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` |
-| Label by name (one word) | `~bug` | `namespace/project~bug` | `project~bug` |
-| Label by name (multiple words) | `~"feature request"` | `namespace/project~"feature request"` | `project~"feature request"` |
-| Label by name (scoped) | `~"priority::high"` | `namespace/project~"priority::high"` | `project~"priority::high"` |
-| Project milestone by ID 2 | `%123` | `namespace/project%123` | `project%123` |
-| Milestone by name (one word) 2 | `%v1.23` | `namespace/project%v1.23` | `project%v1.23` |
-| Milestone by name (multiple words) 2 | `%"release candidate"` | `namespace/project%"release candidate"` | `project%"release candidate"` |
-| Commit (specific) | `9ba12248` | `namespace/project@9ba12248` | `project@9ba12248` |
-| Commit range comparison | `9ba12248...b19a04f5` | `namespace/project@9ba12248...b19a04f5` | `project@9ba12248...b19a04f5` |
-| Repository file reference | `[README](doc/README.md)` | | |
-| Repository file reference (specific line) | `[README](doc/README.md#L13)` | | |
-| [Alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` |
-| [Contact](crm/index.md#contacts) | `[contact:test@example.com]` | | |
-| [Wiki page](project/wiki/index.md) (if the page slug is the same as the title) | `[[Home]]` | | |
-| [Wiki page](project/wiki/index.md) (if the page slug is different from the title) | `[[How to use GitLab\|how-to-use-gitlab]]` | | |
-
-**Footnotes:**
-
-1. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384885) in GitLab 16.9.
- Iteration cadence references are always rendered following the format `[cadence:]`.
- For example, the text reference `[cadence:"plan"]` renders as `[cadence:1]` if the referenced
- iterations cadence's ID is `1`.
-1. For milestones, prepend a `/` before `namespace/project` to specify the exact milestone,
- removing any possible ambiguity.
-
-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,
-add a leading backslash `\#123`.
-
-In addition to this, links to some objects are also recognized and formatted.
-For example:
-
-- Comments on issues: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234#note_101075757"`, rendered as `#1234 (comment 101075757)`
-- The issues designs tab: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234/designs"`, rendered as `#1234 (designs)`.
-- Links to individual designs: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234/designs/layout.png"`, rendered as `#1234[layout.png]`.
-
-### Show the issue, merge request, or epic title in the reference
-
-> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
-
-To include the title in the rendered link of an issue, work item, merge request, or epic:
-
-- Add a plus (`+`) at the end of the reference.
-
-For example, a reference like `#123+` is rendered as `The issue title (#123)`.
-
-URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+` are also expanded.
-
-### Show the issue, work item or merge request summary in the reference
-
-> - Support for issues and merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386937) in GitLab 15.10.
-> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
-
-To include an extended summary in the rendered link of an issue, work item, or merge request:
-
-- Add a `+s` at the end of the reference.
-
-Summary includes information about **assignees**, **milestone** and **health status** of referenced item.
-
-For example, a reference like `#123+s` is rendered as
-`The issue title (#123) • First Assignee, Second Assignee+ • v15.10 • Needs attention`.
-
-URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+s` are also expanded.
-
-To update the rendered references if the assignee, milestone, or health status changed:
-
-- Edit the comment or description and save it.
-
-Issue [420807](https://gitlab.com/gitlab-org/gitlab/-/issues/420807) tracks improving how these
-references refresh.
-
-### Embedding Observability dashboards
-
-You can embed GitLab Observability UI dashboards descriptions and comments, for example in epics, issues, and MRs.
-
-To embed an Observability dashboard URL:
-
-1. In GitLab Observability UI, copy the URL in the address bar.
-1. Paste your link in a comment or description. GitLab Flavored Markdown recognizes the URL and displays the source.
-
## Blockquotes
[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#blockquotes).
@@ -963,766 +911,151 @@ s = "No highlighting is shown for this line."
But let's throw in a tag.
```
-## Emphasis
+## Diagrams and flowcharts
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emphasis).
+You can generate diagrams from text by using:
-You can emphasize text in multiple ways. Use italics, bold, strikethrough,
-or combine these emphasis styles together.
+- [Mermaid](https://mermaidjs.github.io/)
+- [PlantUML](https://plantuml.com)
+- [Kroki](https://kroki.io) to create a wide variety of diagrams.
-Examples:
+In wikis, you can also add and edit diagrams created with the [diagrams.net editor](#diagramsnet-editor).
-```markdown
-Emphasis, or italics, with *asterisks* or _underscores_.
+### Mermaid
-Strong emphasis, or bold, with double **asterisks** or __underscores__.
+> - Support for Entity Relationship diagrams and mind maps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384386) in GitLab 16.0.
-Combined emphasis with **asterisks and _underscores_**.
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#mermaid).
-Strikethrough with double tildes. ~~Scratch this.~~
+Visit the [official page](https://mermaidjs.github.io/) for more details. The
+[Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/) helps you
+learn Mermaid and debug issues in your Mermaid code. Use it to identify and resolve
+issues in your diagrams.
+
+To generate a diagram or flowchart, write your text inside the `mermaid` block:
+
+````markdown
+```mermaid
+graph TD;
+ A-->B;
+ A-->C;
+ B-->D;
+ C-->D;
```
-
-
-
-Emphasis, or italics, with *asterisks* or _underscores_.
-
-Strong emphasis, or bold, with double **asterisks** or __underscores__.
-
-Combined emphasis with **asterisks and _underscores_**.
-
-Strikethrough with double tildes. ~~Scratch this.~~
-
-
-
-### Multiple underscores in words and mid-word emphasis
-
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#multiple-underscores-in-words).
-
-Avoid italicizing a portion of a word, especially when you're
-dealing with code and names that often appear with multiple underscores.
-
-GitLab Flavored Markdown ignores multiple underlines in words,
-to allow better rendering of Markdown documents discussing code:
-
-```markdown
-perform_complicated_task
-
-do_this_and_do_that_and_another_thing
-
-but_emphasis is_desired _here_
-```
-
-
-
-perform_complicated_task
-
-do_this_and_do_that_and_another_thing
-
-but_emphasis is_desired _here_
-
-
-
----
-
-If you wish to emphasize only a part of a word, it can still be done with asterisks:
-
-```markdown
-perform*complicated*task
-
-do*this*and*do*that*and*another thing
-```
-
-perform*complicated*task
-
-do*this*and*do*that*and*another thing
-
-## Footnotes
-
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#footnotes).
-
-Footnotes add a link to a note rendered at the end of a Markdown file.
-
-To make a footnote, you need both a reference tag and a separate line (anywhere in the file) with
-the note content.
-
-Regardless of the tag names, the relative order of the reference tags determines the rendered
-numbering.
-
-Regardless where you put the note, it's always shown at the bottom of the file.
-
-
-
-
{{ $options.i18n.infoBannerTitle }}
diff --git a/app/assets/javascripts/issues/show/components/header_actions.vue b/app/assets/javascripts/issues/show/components/header_actions.vue index 7aa14264314..7c4b4838a3d 100644 --- a/app/assets/javascripts/issues/show/components/header_actions.vue +++ b/app/assets/javascripts/issues/show/components/header_actions.vue @@ -416,7 +416,7 @@ export default { :title="editTooltip" :aria-label="$options.i18n.editTitleAndDescription" :aria-keyshortcuts="editShortcutKey" - class="js-issuable-edit gl-display-none! gl-md-display-block!" + class="js-issuable-edit !gl-hidden gl-md-display-block!" data-testid="edit-button" @click="edit" > @@ -428,7 +428,7 @@ export default { id="new-actions-header-dropdown" ref="issuableActionsDropdownDesktop" v-gl-tooltip="showDropdownTooltip" - class="gl-display-none gl-md-display-inline-flex!" + class="gl-hidden gl-md-display-inline-flex!" icon="ellipsis_v" category="tertiary" placement="left" diff --git a/app/assets/javascripts/issues/show/components/incidents/incident_tabs.vue b/app/assets/javascripts/issues/show/components/incidents/incident_tabs.vue index c84fba23837..734940aeeab 100644 --- a/app/assets/javascripts/issues/show/components/incidents/incident_tabs.vue +++ b/app/assets/javascripts/issues/show/components/incidents/incident_tabs.vue @@ -130,7 +130,7 @@ export default { lineSeparator.classList.toggle('gl-border-b-0', !isSummaryTab); itemsToHide.forEach(function hide(item) { - item.classList.toggle('gl-display-none', !isSummaryTab); + item.classList.toggle('gl-hidden', !isSummaryTab); }); editButton?.classList.toggle('gl-md-display-block!', isSummaryTab); diff --git a/app/assets/javascripts/issues/show/components/sticky_header.vue b/app/assets/javascripts/issues/show/components/sticky_header.vue index 793e2719781..3c3d846bdb3 100644 --- a/app/assets/javascripts/issues/show/components/sticky_header.vue +++ b/app/assets/javascripts/issues/show/components/sticky_header.vue @@ -87,7 +87,7 @@ export default { >Date: 3 Jan at 1PM
Commit message: Added sales figures
Commit ID: 123abc12) ---> B @@ -53,7 +57,11 @@ of a repository are in a default branch. To make changes, you: 1. When you're ready, *merge* your branch into the default branch. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart LR + accTitle: Use branches in Git + accDescr: The flow of creating, then using, a branch in Git + subgraph Default branch A[Commit] --> B[Commit] --> C[Commit] --> D[Commit] end diff --git a/doc/tutorials/scrum_events/index.md b/doc/tutorials/scrum_events/index.md index ab4fcb28421..a953987adca 100644 --- a/doc/tutorials/scrum_events/index.md +++ b/doc/tutorials/scrum_events/index.md @@ -49,6 +49,7 @@ standardize labels, boards, and iterations across multiple projects: flowchart TD accTitle: GitLab inheritance model diagram accDescr: Shows how groups, projects, issues, labels, milestones, iterations, tasks, and epics relate to one another in GitLab + Group -->|Contains| Project Group -->|Contains| Epics Group -->|Contains| Labels @@ -224,7 +225,11 @@ GitLab is extensible to support different flavors of backlog management. For this tutorial, we will structure our deliverables in the following way: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart TD + accTitle: Deliverables structure + accDescr: Flowchart of features (epics) to job stories (issues) to implementation steps (tasks) + Epic["Feature (Epic)"] --> Issue["Job Story (Issue)"] Issue --> Task["Implementation Step (Task)"] ``` @@ -258,10 +263,14 @@ Here's an example of breaking a feature into vertically sliced job stories based journey: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart TD -Epic["Epic: When using the application, I need to create an
account, so that I can use the application features"] --> Issue1["Issue: When creating my account, I need to specify my email address,
so that I can receive future updates from the application"] - Epic --> Issue2["Issue: When creating my account, I need to
specify a password, so that my account remains secure"] - Epic --> Issue3["Issue: When creating my account and entering the required info, I need to
finalize creating my account, so that I can log in"] + accTitle: Slicing a feature + accDescr: Use the end user's journey to identify slices of work to be completed in iterations + +Epic["Epic: When using the application,
I need to create an account,
so I can use the application features"] --> Issue1["Issue: When creating my account,
I need to specify my email address,
so I can receive future updates from the application"] + Epic --> Issue2["Issue: When creating my account,
I need to specify a password,
so my account remains secure"] + Epic --> Issue3["Issue: When creating my account
and entering the required info,
I need to finalize creating my account,
so I can log in"] ``` You've taken the feature of an unmodified account sign-up for an application and broke it down into @@ -275,12 +284,16 @@ After you have broken down a feature into stories, you can further break down th implementation steps: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% flowchart TD - Issue1["Issue: When creating my account, I need to specify my email address,
so that I can receive future updates from the application"] - Issue1 --> Task2["Task: Backend - Validate email formatting"] - Issue1 --> Task3["Task: Backend - API endpoint to accept POST request from client"] - Issue1 --> Task4["Task: Frontend - Display email input"] - Issue1 --> Task5["Task: Frontend - Display error message when validation fails"] + accTitle: Break the story down further + accDescr: Split apart a story into smaller steps + + Issue1["Issue: When creating my account,
I need to specify my email address,
so I can receive future updates from the application"] + Issue1 --> Task2["Task: Backend
Validate email formatting"] + Issue1 --> Task3["Task: Backend
API endpoint to accept
POST request from client"] + Issue1 --> Task4["Task: Frontend
Display email input"] + Issue1 --> Task5["Task: Frontend
Display error message when validation fails"] ``` ### Set up a release planning board diff --git a/doc/user/ai_experiments.md b/doc/user/ai_experiments.md index fd34f79315f..2ad2ad189f7 100644 --- a/doc/user/ai_experiments.md +++ b/doc/user/ai_experiments.md @@ -141,8 +141,7 @@ To use this feature: - Belong to at least one group with the [experiment and beta features setting](ai_features_enable.md#turn-on-beta-and-experimental-features) enabled. - Have sufficient permissions to view the CI/CD job. -When the feature is available, the "Root cause analysis" button will appears on -a failed CI/CD job. Selecting this button generates an analysis regarding the +When the feature is available, the "Troubleshoot" button displays on failed CI/CD jobs. Selecting this option generates an analysis regarding the reason for the failure. ## Summarize an issue with Issue description generation diff --git a/doc/user/group/epics/epic_boards.md b/doc/user/group/epics/epic_boards.md index 2505d1f336c..3cf0857833a 100644 --- a/doc/user/group/epics/epic_boards.md +++ b/doc/user/group/epics/epic_boards.md @@ -212,7 +212,7 @@ Prerequisites: To edit the scope of an epic board: -1. In the upper-right corner, select **Edit board**. +1. In the upper-right corner, select **Configure board** (**{settings}**). 1. Optional: - Edit the board's title. - Show or hide the Open and Closed columns. diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md index 4f6f960f59c..0eb12973dfe 100644 --- a/doc/user/group/epics/index.md +++ b/doc/user/group/epics/index.md @@ -41,7 +41,10 @@ The possible relationships between epics and issues are: - An epic is the parent of one or more [child epics](manage_epics.md#multi-level-child-epics). Ultimate only. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TD +accTitle: Epics and issues +accDescr: How issues and child epics relate to parent epics Parent_epic --> Issue1 Parent_epic --> Child_epic Child_epic --> Issue2 diff --git a/doc/user/group/planning_hierarchy/index.md b/doc/user/group/planning_hierarchy/index.md index 332b4daa3af..e7ac62a0823 100644 --- a/doc/user/group/planning_hierarchy/index.md +++ b/doc/user/group/planning_hierarchy/index.md @@ -28,7 +28,10 @@ portfolio management, see With epics, you can achieve the following hierarchy: ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TD +accTitle: Hierarchies with epics +accDescr: Use epics to link projects, issues, and groups Group_epic --> Project1_Issue1 Group_epic --> Project1_Issue2 Group_epic --> Project2_Issue1 @@ -48,6 +51,7 @@ Image below was generated with the following Mermaid code. Attached as an image because a rendered diagram doesn't look clear on the docs page. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% classDiagram direction TD class Epic diff --git a/doc/user/group/saml_sso/group_sync.md b/doc/user/group/saml_sso/group_sync.md index 9328d682090..93d0d73f83f 100644 --- a/doc/user/group/saml_sso/group_sync.md +++ b/doc/user/group/saml_sso/group_sync.md @@ -142,7 +142,7 @@ group overage claim attribute in the SAML response. Then group memberships must The [Graph API endpoint](https://learn.microsoft.com/en-us/graph/api/user-list-transitivememberof?view=graph-rest-1.0&tabs=http#http-request) supports only a [user object ID](https://learn.microsoft.com/en-us/partner-center/find-ids-and-domain-names#find-the-user-object-id) or [userPrincipalName](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/plan-connect-userprincipalname#what-is-userprincipalname) -as the [configured](../../../user/group/saml_sso/index.md#azure) Unique User Identifier (Name identifier) attribute. +as the [configured](../../../user/group/saml_sso/index.md#azure) Unique User Identifier (Name identifier) attribute. When the integration processes Group Sync, only Group Links configured with group unique identifiers (like `12345678-9abc-def0-1234-56789abcde`) are supported. @@ -249,6 +249,7 @@ For example, in the following diagram: not yet signed in. ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TB subgraph SAML users SAMLUserA[Sidney Jones] @@ -274,6 +275,7 @@ graph TB ``` ```mermaid +%%{init: { "fontFamily": "GitLab Sans" }}%% graph TB subgraph GitLab users GitLabUserA[Sidney Jones] @@ -283,9 +285,9 @@ graph TB end subgraph GitLab groups - GitLabGroupA["Group A (SAML configured)"] --> GitLabGroupB["Group B (SAML Group Link not configured)"] - GitLabGroupA --> GitLabGroupC["Group C (SAML Group Link configured)"] - GitLabGroupA --> GitLabGroupD["Group D (SAML Group Link configured)"] + GitLabGroupA["Group A
(SAML configured)"] --> GitLabGroupB["Group B
(SAML Group Link not configured)"] + GitLabGroupA --> GitLabGroupC["Group C
(SAML Group Link configured)"] + GitLabGroupA --> GitLabGroupD["Group D
(SAML Group Link configured)"] end GitLabGroupB --> |Member|GitLabUserA @@ -308,9 +310,9 @@ graph TB subgraph GitLab groups after Alex Garcia signs in GitLabGroupA[Group A] - GitLabGroupA["Group A (SAML configured)"] --> GitLabGroupB["Group B (SAML Group Link not configured)"] - GitLabGroupA --> GitLabGroupC["Group C (SAML Group Link configured)"] - GitLabGroupA --> GitLabGroupD["Group D (SAML Group Link configured)"] + GitLabGroupA["Group A
(SAML configured)"] --> GitLabGroupB["Group B
(SAML Group Link not configured)"] + GitLabGroupA --> GitLabGroupC["Group C
(SAML Group Link configured)"] + GitLabGroupA --> GitLabGroupD["Group D
(SAML Group Link configured)"] end GitLabGroupB --> |Member|GitLabUserA diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 682a01a2ee7..25846eaeb1a 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -116,248 +116,133 @@ If there is no otherwise meaningful value for a cell, consider entering **N/A** Describe the image or video in the `[alt text]`. Make the description accurate, succinct, and unique. Don't use `image of` or `video of` in the description. For more information, see [WebAim Alternative Text](https://webaim.org/techniques/alttext/). -## Colors +## Line breaks -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#colors). +[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#line-breaks). -Markdown does not support changing text color. - -You can write a color code in the formats: `HEX`, `RGB`, or `HSL`. - -- `HEX`: `` `#RGB[A]` `` or `` `#RRGGBB[AA]` `` -- `RGB`: `` `RGB[A](R, G, B[, A])` `` -- `HSL`: `` `HSL[A](H, S, L[, A])` `` - -Named colors are not supported. - -In the GitLab application (but not the GitLab documentation) color codes in backticks -display a color chip next to the color code. For example: +A line break is inserted (a new paragraph starts) if the previous text is +ended with two newlines, like when you press Enter twice in a row. If you only +use one newline (press Enter once), the next sentence remains part of the +same paragraph. Use this approach if you want to keep long lines from wrapping, and keep +them editable: ```markdown -- `#F00` -- `#F00A` -- `#FF0000` -- `#FF0000AA` -- `RGB(0,255,0)` -- `RGB(0%,100%,0%)` -- `RGBA(0,255,0,0.3)` -- `HSL(540,70%,50%)` -- `HSLA(540,70%,50%,0.3)` +Here's a line for us to start with. + +This longer line is separated from the one above by two newlines, so it is a *separate paragraph*. + +This line is also a separate paragraph, but... +These lines are only separated by single newlines, +so they *do not break* and just follow the previous lines +in the *same paragraph*. ``` -- `#F00` -- `#F00A` -- `#FF0000` -- `#FF0000AA` -- `RGB(0,255,0)` -- `RGB(0%,100%,0%)` -- `RGBA(0,255,0,0.3)` -- `HSL(540,70%,50%)` -- `HSLA(540,70%,50%,0.3)` +Here's a line for us to start with. -## Diagrams and flowcharts +This longer line is separated from the one above by two newlines, so it is a *separate paragraph*. -You can generate diagrams from text by using: +This line is also a separate paragraph, but... +These lines are only separated by single newlines, +so they *do not break* and just follow the previous lines +in the *same paragraph*. -- [Mermaid](https://mermaidjs.github.io/) -- [PlantUML](https://plantuml.com) -- [Kroki](https://kroki.io) to create a wide variety of diagrams. +### Newlines -In wikis, you can also add and edit diagrams created with the [diagrams.net editor](#diagramsnet-editor). +GitLab Flavored Markdown adheres to the Markdown specification for handling +[paragraphs and line breaks](https://spec.commonmark.org/current/). -### Mermaid +A paragraph is one or more consecutive lines of text, separated by one or +more blank lines (two newlines at the end of the first paragraph), as [explained above](#line-breaks). -> - Support for Entity Relationship diagrams and mindmaps [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384386) in GitLab 16.0. - -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#mermaid). - -Visit the [official page](https://mermaidjs.github.io/) for more details. The -[Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/) helps you -learn Mermaid and debug issues in your Mermaid code. Use it to identify and resolve -issues in your diagrams. - -To generate a diagram or flowchart, write your text inside the `mermaid` block: - -````markdown -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` -```` - -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` - -You can also include subgraphs: - -````markdown -```mermaid -graph TB - - SubGraph1 --> SubGraph1Flow - subgraph "SubGraph 1 Flow" - SubGraph1Flow(SubNode 1) - SubGraph1Flow -- Choice1 --> DoChoice1 - SubGraph1Flow -- Choice2 --> DoChoice2 - end - - subgraph "Main Graph" - Node1[Node 1] --> Node2[Node 2] - Node2 --> SubGraph1[Jump to SubGraph1] - SubGraph1 --> FinalThing[Final Thing] -end -``` -```` - -```mermaid -graph TB - - SubGraph1 --> SubGraph1Flow - subgraph "SubGraph 1 Flow" - SubGraph1Flow(SubNode 1) - SubGraph1Flow -- Choice1 --> DoChoice1 - SubGraph1Flow -- Choice2 --> DoChoice2 - end - - subgraph "Main Graph" - Node1[Node 1] --> Node2[Node 2] - Node2 --> SubGraph1[Jump to SubGraph1] - SubGraph1 --> FinalThing[Final Thing] -end -``` - -### PlantUML - -PlantUML integration is enabled on GitLab.com. To make PlantUML available in self-managed -installation of GitLab, a GitLab administrator [must enable it](../administration/integration/plantuml.md). - -### Kroki - -To make Kroki available in GitLab, a GitLab administrator must enable it. -For more information, see the [Kroki integration](../administration/integration/kroki.md) page. - -## Emoji - -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emoji). - -Sometimes you want to
around a bit and add some to your . Well we have a gift for you:
-
-You can use emoji anywhere GitLab Flavored Markdown is supported.
-
-You can use it to point out a or warn about patches. If someone improves your really code, send them some . People you for that.
-
-If you're new to this, don't be . You can join the emoji . Just look up one of the supported codes.
-
-Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of all supported emoji codes.
-
-The above paragraphs in raw Markdown:
+Need more control over line breaks or soft returns? Add a single line break
+by ending a line with a backslash, or two or more spaces. Two newlines in a row create a new
+paragraph, with a blank line in between:
```markdown
-Sometimes you want to :monkey: around a bit and add some :star2: to your
-:speech_balloon:. Well we have a gift for you:
+First paragraph.
+Another line in the same paragraph.
+A third line in the same paragraph, but this time ending with two spaces.\:
-## Math
+## Headings
-> - LaTeX-compatible fencing [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21757) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `markdown_dollar_math`. Disabled by default. Enabled on GitLab.com.
-> - LaTeX-compatible fencing [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/371180) in GitLab 15.8. Feature flag `markdown_dollar_math` removed.
+Create headings from 1 to 6 by using `#`.
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#math).
-
-Math written in LaTeX syntax is rendered with [KaTeX](https://github.com/KaTeX/KaTeX).
-_KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._
-This syntax also works in AsciiDoc wikis and files using `:stem: latexmath`. For details, see
-the [Asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support).
-
-To prevent malicious activity, GitLab renders only the first 50 inline math instances.
-The number of math blocks is also limited based on render time. If the limit is exceeded,
-GitLab renders the excess math instances as text. Wiki and repository files do not have
-these limits.
-
-Math written between dollar signs with backticks (``$`...`$``) or single dollar signs (`$...$`)
-is rendered inline with the text.
-
-Math written between double dollar signs (`$$...$$`) or in a [code block](#code-spans-and-blocks) with
-the language declared as `math` is rendered on a separate line:
-
-````markdown
-This math is inline: $`a^2+b^2=c^2`$.
-
-This math is on a separate line using a ```` ```math ```` block:
-
-```math
-a^2+b^2=c^2
+```markdown
+# H1
+## H2
+### H3
+#### H4
+##### H5
+###### H6
```
-This math is on a separate line using inline `$$`: $$a^2+b^2=c^2$$
+Alternatively, for H1 and H2, use an underline style:
-This math is on a separate line using a `$$...$$` block:
+```markdown
+Alt-H1
+======
-$$
-a^2+b^2=c^2
-$$
-````
-
-This math is inline: $`a^2+b^2=c^2`$.
-
-This math is on a separate line using a ```` ```math ```` block:
-
-```math
-a^2+b^2=c^2
+Alt-H2
+------
```
-This math is on a separate line using inline `$$`: $$a^2+b^2=c^2$$
+### Heading IDs and links
-This math is on a separate line using a `$$...$$` block:
+> - Heading link generation [changed](https://gitlab.com/gitlab-org/gitlab/-/issues/440733) in GitLab 17.0.
-$$
-a^2+b^2=c^2
-$$
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#heading-ids-and-links).
-## Task lists
+All Markdown-rendered headings automatically
+get IDs that can be linked to, except in comments.
+
+On hover, a link to those IDs becomes visible to make it easier to copy the link to
+the heading to use it somewhere else.
+
+The IDs are generated from the content of the heading according to the following rules:
+
+1. All text is converted to lowercase.
+1. All non-word text (such as punctuation or HTML) is removed.
+1. All spaces are converted to hyphens.
+1. Two or more hyphens in a row are converted to one.
+1. If a heading with the same ID has already been generated, a unique
+ incrementing number is appended, starting at 1.
+
+Example:
+
+```markdown
+# This heading has spaces in it
+## This heading has a :thumbsup: in it
+# This heading has Unicode in it: 한글
+## This heading has spaces in it
+### This heading has spaces in it
+## This heading has 3.5 in it (and parentheses)
+## This heading has multiple spaces and --- hyphens
+```
+
+Would generate the following link IDs:
+
+1. `this-heading-has-spaces-in-it`
+1. `this-heading-has-a-thumbsup-in-it`
+1. `this-heading-has-unicode-in-it-한글`
+1. `this-heading-has-spaces-in-it-1`
+1. `this-heading-has-spaces-in-it-2`
+1. `this-heading-has-35-in-it-and-parentheses`
+1. `this-heading-has--multiple-spaces-and-----hyphens`
+
+## Links
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#links).
+
+You can create links two ways: inline-style and reference-style. For example:
+
+
+
+- This line shows an [inline-style link](https://www.google.com)
+- This line shows a [link to a repository file in the same directory](permissions.md)
+- This line shows a [relative link to a file one directory higher](../index.md)
+- This line shows a [link that also has title text](https://www.google.com "This link takes you to Google!")
+
+Using heading ID anchors:
+
+- This line links to [a section on a different Markdown page, using a "#" and the heading ID](permissions.md#project-features-permissions)
+- This line links to [a different section on the same page, using a "#" and the heading ID](#heading-ids-and-links)
+
+Using references:
+
+- This line shows a [reference-style link, see below][Arbitrary case-insensitive reference text]
+- You can [use numbers for reference-style link definitions, see below][1]
+- Or leave it empty and use the [link text itself][], see below.
+
+Some text to show that the reference links can follow later.
+
+[arbitrary case-insensitive reference text]: https://www.mozilla.org/en-US/
+[1]: https://slashdot.org
+[link text itself]: https://about.gitlab.com/
+
+
+
+
+
+
+![alt text1][logo]
+
+[logo]: img/markdown_logo.png "Title Text"
+
+A footnote reference tag looks like this: [^1]
-
-This reference tag is a mix of letters and numbers. [^footnote-42]
-
-[^1]: This text is inside a footnote.
-
-[^footnote-42]: This text is another footnote.
-
-
-
-
-
-
-![alt text1][logo]
-
-[logo]: img/markdown_logo.png "Title Text"
-
--
-
- Definition list -
- Is something people use sometimes. - -
- Markdown in HTML -
- Does *not* work **very** well. HTML tags do work, in most cases. -
-
-
- Definition list -
- Is something people use sometimes. - -
- Markdown in HTML -
- Does *not* work **very** well. HTML tags do work, in most cases. -
-
-
- Markdown in HTML -
- Does *not* work **very** well. HTML tags work, in most cases. - -
- Markdown in HTML with proper spacing -
- - - Does *not* work **very** well. HTML tags work, in most cases. - - -
-
-
- Markdown in HTML -
- Does *not* work **very** well. HTML tags work, in most cases. - -
- Markdown in HTML with proper spacing -
- - - Does not work very well. HTML tags work, in most cases. - - -
`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details)
-and [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary)
-tags. For example, collapse a long log file so it takes up less screen space.
-
-```html
-
`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary)
-tags. For example, collapse a long log file so it takes up less screen space.
-
-```html
-
-Click to expand
-
-These details remain hidden until expanded.
-
-PASTE LOGS HERE
-
-
-```
-
-
-Click to expand
-
-These details remain hidden until expanded.
-
-PASTE LOGS HERE
-
-
-
----
-
-Markdown inside these tags is also supported.
-
-Remember to leave a blank line before and after any Markdown sections, as shown in the example:
-
-````html
-
-
-
-Click to _expand._
-
-
-
-These details _remain_ **hidden** until expanded.
-
-```
-PASTE LOGS HERE
-```
-
-
````
-
-
-
-Click to expand.
-
-These details remain hidden until expanded.
-
-PASTE LOGS HERE
-
-
-
-## Line breaks
-
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#line-breaks).
-
-A line break is inserted (a new paragraph starts) if the previous text is
-ended with two newlines, like when you press Enter twice in a row. If you only
-use one newline (press Enter once), the next sentence remains part of the
-same paragraph. Use this approach if you want to keep long lines from wrapping, and keep
-them editable:
-
-```markdown
-Here's a line for us to start with.
-
-This longer line is separated from the one above by two newlines, so it is a *separate paragraph*.
-
-This line is also a separate paragraph, but...
-These lines are only separated by single newlines,
-so they *do not break* and just follow the previous lines
-in the *same paragraph*.
+```mermaid
+graph TD;
+ A-->B;
+ A-->C;
+ B-->D;
+ C-->D;
```
-Here's a line for us to start with.
+You can also include subgraphs:
-This longer line is separated from the one above by two newlines, so it is a *separate paragraph*.
+````markdown
+```mermaid
+graph TB
-This line is also a separate paragraph, but...
-These lines are only separated by single newlines,
-so they *do not break* and just follow the previous lines
-in the *same paragraph*.
+ SubGraph1 --> SubGraph1Flow
+ subgraph "SubGraph 1 Flow"
+ SubGraph1Flow(SubNode 1)
+ SubGraph1Flow -- Choice1 --> DoChoice1
+ SubGraph1Flow -- Choice2 --> DoChoice2
+ end
-### Newlines
+ subgraph "Main Graph"
+ Node1[Node 1] --> Node2[Node 2]
+ Node2 --> SubGraph1[Jump to SubGraph1]
+ SubGraph1 --> FinalThing[Final Thing]
+end
+```
+````
-GitLab Flavored Markdown adheres to the Markdown specification for handling
-[paragraphs and line breaks](https://spec.commonmark.org/current/).
+```mermaid
+graph TB
-A paragraph is one or more consecutive lines of text, separated by one or
-more blank lines (two newlines at the end of the first paragraph), as [explained above](#line-breaks).
+ SubGraph1 --> SubGraph1Flow
+ subgraph "SubGraph 1 Flow"
+ SubGraph1Flow(SubNode 1)
+ SubGraph1Flow -- Choice1 --> DoChoice1
+ SubGraph1Flow -- Choice2 --> DoChoice2
+ end
-Need more control over line breaks or soft returns? Add a single line break
-by ending a line with a backslash, or two or more spaces. Two newlines in a row create a new
-paragraph, with a blank line in between:
-
-```markdown
-First paragraph.
-Another line in the same paragraph.
-A third line in the same paragraph, but this time ending with two spaces.
-A new line directly under the first paragraph.
-
-Second paragraph.
-Another line, this time ending with a backslash.\
-A new line due to the previous backslash.
+ subgraph "Main Graph"
+ Node1[Node 1] --> Node2[Node 2]
+ Node2 --> SubGraph1[Jump to SubGraph1]
+ SubGraph1 --> FinalThing[Final Thing]
+end
```
-## Links
+### PlantUML
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#links).
+PlantUML integration is enabled on GitLab.com. To make PlantUML available in self-managed
+installation of GitLab, a GitLab administrator [must enable it](../administration/integration/plantuml.md).
-You can create links two ways: inline-style and reference-style. For example:
+### Kroki
-
+To make Kroki available in GitLab, a GitLab administrator must enable it.
+For more information, see the [Kroki integration](../administration/integration/kroki.md) page.
-- This line shows an [inline-style link](https://www.google.com)
-- This line shows a [link to a repository file in the same directory](permissions.md)
-- This line shows a [relative link to a file one directory higher](../index.md)
-- This line shows a [link that also has title text](https://www.google.com "This link takes you to Google!")
+## Math
-Using heading ID anchors:
+> - LaTeX-compatible fencing [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21757) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `markdown_dollar_math`. Disabled by default. Enabled on GitLab.com.
+> - LaTeX-compatible fencing [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/371180) in GitLab 15.8. Feature flag `markdown_dollar_math` removed.
-- This line links to [a section on a different Markdown page, using a "#" and the heading ID](permissions.md#project-features-permissions)
-- This line links to [a different section on the same page, using a "#" and the heading ID](#heading-ids-and-links)
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#math).
-Using references:
+Math written in LaTeX syntax is rendered with [KaTeX](https://github.com/KaTeX/KaTeX).
+_KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._
+This syntax also works in AsciiDoc wikis and files using `:stem: latexmath`. For details, see
+the [Asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support).
-- This line shows a [reference-style link, see below][Arbitrary case-insensitive reference text]
-- You can [use numbers for reference-style link definitions, see below][1]
-- Or leave it empty and use the [link text itself][], see below.
+To prevent malicious activity, GitLab renders only the first 50 inline math instances.
+The number of math blocks is also limited based on render time. If the limit is exceeded,
+GitLab renders the excess math instances as text. Wiki and repository files do not have
+these limits.
-Some text to show that the reference links can follow later.
+Math written between dollar signs with backticks (``$`...`$``) or single dollar signs (`$...$`)
+is rendered inline with the text.
-[arbitrary case-insensitive reference text]: https://www.mozilla.org/en-US/
-[1]: https://slashdot.org
-[link text itself]: https://about.gitlab.com/
-
+Math written between double dollar signs (`$$...$$`) or in a [code block](#code-spans-and-blocks) with
+the language declared as `math` is rendered on a separate line:
-- This line shows an [inline-style link](https://www.google.com)
-- This line shows a [link to a repository file in the same directory](permissions.md)
-- This line shows a [relative link to a file one directory higher](../index.md)
-- This line shows a [link that also has title text](https://www.google.com "This link takes you to Google!")
+````markdown
+This math is inline: $`a^2+b^2=c^2`$.
-Using heading ID anchors:
+This math is on a separate line using a ```` ```math ```` block:
-- This line links to [a section on a different Markdown page, using a "#" and the heading ID](permissions.md#project-members-permissions)
-- This line links to [a different section on the same page, using a "#" and the heading ID](#heading-ids-and-links)
-
-Using references:
-
-
-
-- This line is a [reference-style link, see below](https://www.mozilla.org/en-US/)
-- You can [use numbers for reference-style link definitions, see below](https://slashdot.org)
-- Or leave it empty and use the [link text itself](https://about.gitlab.com/), see below.
-
-Some text to show that the reference links can follow later.
-
-NOTE:
-Relative links do not allow the referencing of project files in a wiki
-page, or a wiki page in a project file. The reason: a wiki is always
-in a separate Git repository in GitLab. For example, `[I'm a reference-style link](style)`
-points the link to `wikis/style` only when the link is inside of a wiki Markdown file.
-
-### URL auto-linking
-
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#url-auto-linking).
-
-Almost any URL you put into your text is auto-linked:
-
-```markdown
-- https://www.google.com
-- https://www.google.com
-- ftp://ftp.us.debian.org/debian/
-- smb://foo/bar/baz
-- irc://irc.freenode.net/
-- http://localhost:3000
+```math
+a^2+b^2=c^2
```
-
+This math is on a separate line using inline `$$`: $$a^2+b^2=c^2$$
--
--
--
+This math is on a separate line using a `$$...$$` block:
-
+$$
+a^2+b^2=c^2
+$$
+````
-## Lists
+This math is inline: $`a^2+b^2=c^2`$.
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#lists).
+This math is on a separate line using a ```` ```math ```` block:
-You can create ordered and unordered lists.
-
-For an ordered list, add the number you want the list
-to start with, like `1.`, followed by a space, at the start of each line for ordered lists.
-After the first number, it does not matter what number you use. Ordered lists are
-numbered automatically by vertical order, so repeating `1.` for all items in the
-same list is common. If you start with a number other than `1.`, it uses that as the first
-number, and counts up from there.
-
-Examples:
-
-```markdown
-1. First ordered list item
-2. Another item
- - Unordered sub-list.
-1. Actual numbers don't matter, just that it's a number
- 1. Ordered sub-list
- 1. Next ordered sub-list item
-4. And another item.
+```math
+a^2+b^2=c^2
```
-
+This math is on a separate line using inline `$$`: $$a^2+b^2=c^2$$
-1. First ordered list item
-1. Another item
- - Unordered sub-list.
-1. Actual numbers don't matter, just that it's a number
- 1. Ordered sub-list
- 1. Next ordered sub-list item
-1. And another item.
+This math is on a separate line using a `$$...$$` block:
-For an unordered list, add a `-`, `*` or `+`, followed by a space, at the start of
-each line for unordered lists, but you should not use a mix of them.
-
-```markdown
-Unordered lists can:
-
-- use
-- minuses
-
-They can also:
-
-* use
-* asterisks
-
-They can even:
-
-+ use
-+ pluses
-```
-
-
-
-Unordered lists can:
-
-- use
-- minuses
-
-They can also:
-
-- use
-- asterisks
-
-They can even:
-
-- use
-- pluses
-
----
-
-If a list item contains multiple paragraphs, each subsequent paragraph should be indented
-to the same level as the start of the list item text.
-
-Example:
-
-```markdown
-1. First ordered list item
-
- Second paragraph of first item.
-
-1. Another item
-```
-
-1. First ordered list item
-
- Second paragraph of first item.
-
-1. Another item
-
----
-
-If the first item's paragraph isn't indented with the proper number of spaces,
-the paragraph appears outside the list, instead of properly indented under the list item.
-For example:
-
-```markdown
-1. First ordered list item
-
- Paragraph of first item.
-
-1. Another item
-```
-
-1. First ordered list item
-
- Paragraph of first item.
-
-1. Another item
-
----
-
-Ordered lists that are the first sub-item of an unordered list item must have a preceding blank line if they don't start with `1.`.
-
-**Good**
-
-```markdown
-- Unordered list item
-
- 5. First ordered list item
-```
-
-**Bad**
-
-```markdown
-- Unordered list item
- 5. First ordered list item
-```
-
----
-
-CommonMark ignores blank lines between ordered and unordered list items, and considers them part of a single list. These are rendered as a
-_[loose](https://spec.commonmark.org/0.30/#loose)_ list. Each list item is enclosed in a paragraph tag and, therefore, has paragraph spacing and margins.
-This makes the list look like there is extra spacing between each item.
-
-For example:
-
-```markdown
-- First list item
-- Second list item
-
-- A different list
-```
-
-CommonMark ignores the blank line and renders this as one list with paragraph spacing.
-
-## Superscripts / Subscripts
-
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#superscripts-subscripts).
-
-For superscripts and subscripts, use the standard HTML syntax:
-
-```html
-The formula for water is H2O
-while the equation for the theory of relativity is E = mc2.
-```
-
-
-
-The formula for water is H2O
-while the equation for the theory of relativity is E = mc2.
-
-
-
-GitLab Flavored Markdown doesn't support the Redcarpet superscript syntax ( `x^2` ).
-
-## Keyboard HTML tag
-
-[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#keyboard-html-tag).
-
-The `` element is used to identify text that represents user keyboard input. Text surrounded by `` tags is typically displayed in the browser's default monospace font.
-
-```html
-Press Enter to go to the next page.
-```
-
-Press Enter to go to the next page.
+$$
+a^2+b^2=c^2
+$$
## Tables
@@ -2013,6 +1346,680 @@ If JSON is invalid, an error occurs.
```
````
+## Table of contents
+
+A table of contents is an unordered list that links to subheadings in the document.
+You can add a table of contents to issues, merge requests, and epics, but you can't add one
+to notes or comments.
+
+Add one of these tags on their own line to the **description** field of any of the supported
+content types:
+
+
+
+```markdown
+[[_TOC_]]
+or
+[TOC]
+```
+
+- Markdown files.
+- Wiki pages.
+- Issues.
+- Merge requests.
+- Epics.
+
+NOTE:
+A table of contents renders also when you use the TOC code in single square brackets, regardless of
+being on its own line or not.
+This behavior is unintended.
+For more information, see [issue 359077](https://gitlab.com/gitlab-org/gitlab/-/issues/359077).
+
+```markdown
+This sentence introduces my wiki page.
+
+[[_TOC_]]
+
+## My first heading
+
+First section content.
+
+## My second heading
+
+Second section content.
+```
+
+
+
+## Colors
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#colors).
+
+Markdown does not support changing text color.
+
+You can write a color code in the formats: `HEX`, `RGB`, or `HSL`.
+
+- `HEX`: `` `#RGB[A]` `` or `` `#RRGGBB[AA]` ``
+- `RGB`: `` `RGB[A](R, G, B[, A])` ``
+- `HSL`: `` `HSL[A](H, S, L[, A])` ``
+
+Named colors are not supported.
+
+In the GitLab application (but not the GitLab documentation) color codes in backticks
+display a color chip next to the color code. For example:
+
+```markdown
+- `#F00`
+- `#F00A`
+- `#FF0000`
+- `#FF0000AA`
+- `RGB(0,255,0)`
+- `RGB(0%,100%,0%)`
+- `RGBA(0,255,0,0.3)`
+- `HSL(540,70%,50%)`
+- `HSLA(540,70%,50%,0.3)`
+```
+
+- `#F00`
+- `#F00A`
+- `#FF0000`
+- `#FF0000AA`
+- `RGB(0,255,0)`
+- `RGB(0%,100%,0%)`
+- `RGBA(0,255,0,0.3)`
+- `HSL(540,70%,50%)`
+- `HSLA(540,70%,50%,0.3)`
+
+## Emoji
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#emoji).
+
+Sometimes you want to around a bit and add some to your . Well we have a gift for you:
+
+You can use emoji anywhere GitLab Flavored Markdown is supported.
+
+You can use it to point out a or warn about patches. If someone improves your really code, send them some . People you for that.
+
+If you're new to this, don't be . You can join the emoji . Just look up one of the supported codes.
+
+Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of all supported emoji codes.
+
+The above paragraphs in raw Markdown:
+
+```markdown
+Sometimes you want to :monkey: around a bit and add some :star2: to your
+:speech_balloon:. Well we have a gift for you:
+
+:zap: You can use emoji anywhere GitLab Flavored Markdown is supported. :v:
+
+You can use it to point out a :bug: or warn about :speak_no_evil: patches.
+And if someone improves your really :snail: code, send them some :birthday:.
+People :heart: you for that.
+
+If you're new to this, don't be :fearful:. You can join the emoji :family:.
+Just look up one of the supported codes.
+
+Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)
+for a list of all supported emoji codes. :thumbsup:
+```
+
+### Emoji and your operating system
+
+The previous emoji example uses hard-coded images. Rendered emoji
+in GitLab might look different depending on the OS and browser used.
+
+Most emoji are natively supported on macOS, Windows, iOS, Android, and fall back on image-based
+emoji where there is no support.
+
+
+
+On Linux, you can download [Noto Color Emoji](https://github.com/googlefonts/noto-emoji)
+to get full native emoji support. Ubuntu 22.04 (like many modern Linux distributions) has
+this font installed by default.
+
+
+
+To learn more about adding custom emoji, see [Custom emoji](emoji_reactions.md#custom-emoji).
+
+## Front matter
+
+Front matter is metadata included at the beginning of a Markdown document, preceding
+the content. This data can be used by static site generators like [Jekyll](https://jekyllrb.com/docs/front-matter/),
+[Hugo](https://gohugo.io/content-management/front-matter/), and many other applications.
+
+When you view a Markdown file rendered by GitLab, front matter is displayed as-is,
+in a box at the top of the document. The HTML content displays after the front matter. To view an example,
+you can toggle between the source and rendered version of a
+[GitLab documentation file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/index.md).
+
+In GitLab, front matter is used only in Markdown files and wiki pages, not the other
+places where Markdown formatting is supported. It must be at the very top of the document
+and must be between delimiters.
+
+The following delimiters are supported:
+
+- YAML (`---`):
+
+ ```yaml
+ ---
+ title: About Front Matter
+ example:
+ language: yaml
+ ---
+ ```
+
+- TOML (`+++`):
+
+ ```toml
+ +++
+ title = "About Front Matter"
+ [example]
+ language = "toml"
+ +++
+ ```
+
+- JSON (`;;;`):
+
+ ```json
+ ;;;
+ {
+ "title": "About Front Matter"
+ "example": {
+ "language": "json"
+ }
+ }
+ ;;;
+ ```
+
+Other languages are supported by adding a specifier to any of the existing
+delimiters. For example:
+
+```php
+---php
+$title = "About Front Matter";
+$example = array(
+ 'language' => "php",
+);
+---
+```
+
+## Footnotes
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#footnotes).
+
+Footnotes add a link to a note rendered at the end of a Markdown file.
+
+To make a footnote, you need both a reference tag and a separate line (anywhere in the file) with
+the note content.
+
+Regardless of the tag names, the relative order of the reference tags determines the rendered
+numbering.
+
+Regardless where you put the note, it's always shown at the bottom of the file.
+
+
+
+A footnote reference tag looks like this: [^1]
+
+This reference tag is a mix of letters and numbers. [^footnote-42]
+
+[^1]: This text is inside a footnote.
+
+[^footnote-42]: This text is another footnote.
+
+
+A footnote reference tag looks like this:[^1]
+
+This reference tag is a mix of letters and numbers.[^footnote-42]
+
+
+
+ [^1]: This text is inside a footnote.
+
+ [^footnote-42]: This text is another footnote.
+
+## Horizontal rule
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#horizontal-rule).
+
+Create a horizontal rule by using three or more hyphens, asterisks, or underscores:
+
+```markdown
+---
+
+***
+
+___
+```
+
+---
+
+---
+
+---
+
+## Inline HTML
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#inline-html).
+
+You can also use raw HTML in your Markdown, and it usually works pretty well.
+
+See the documentation for `HTML::Pipeline`'s [SanitizationFilter](https://github.com/jch/html-pipeline/blob/v2.12.3/lib/html/pipeline/sanitization_filter.rb#L42)
+class for the list of allowed HTML tags and attributes. In addition to the default
+`SanitizationFilter` allowlist, GitLab allows `span`, `abbr`, `details` and `summary` elements.
+`rel="license"` is allowed on links to support the [Rel-License microformat](https://microformats.org/wiki/rel-license) and license attribution.
+
+```html
+
+ - Definition list
+ - Is something people use sometimes.
+
+ - Markdown in HTML
+ - Does *not* work **very** well. HTML tags do work, in most cases.
+
+```
+
+
+ - Definition list
+ - Is something people use sometimes.
+
+ - Markdown in HTML
+ - Does *not* work **very** well. HTML tags do work, in most cases.
+
+
+---
+
+It's still possible to use Markdown inside HTML tags, but only if the lines containing Markdown
+are separated into their own lines:
+
+```html
+
+ - Markdown in HTML
+ - Does *not* work **very** well. HTML tags work, in most cases.
+
+ - Markdown in HTML with proper spacing
+ -
+
+ Does *not* work **very** well. HTML tags work, in most cases.
+
+
+
+```
+
+
+
+
+ - Markdown in HTML
+ - Does *not* work **very** well. HTML tags work, in most cases.
+
+ - Markdown in HTML with proper spacing
+ -
+
+ Does not work very well. HTML tags work, in most cases.
+
+
+
+
+### Collapsible section
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#details-and-summary).
+
+Content can be collapsed using HTML's [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details)
+and [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary)
+tags. For example, collapse a long log file so it takes up less screen space.
+
+```html
+
+Click to expand
+
+These details remain hidden until expanded.
+
+PASTE LOGS HERE
+
+
+```
+
+
+Click to expand
+
+These details remain hidden until expanded.
+
+PASTE LOGS HERE
+
+
+
+---
+
+Markdown inside these tags is also supported.
+
+Remember to leave a blank line before and after any Markdown sections, as shown in the example:
+
+````html
+
+
+
+Click to _expand._
+
+
+
+These details _remain_ **hidden** until expanded.
+
+```
+PASTE LOGS HERE
+```
+
+
+````
+
+
+
+
+Click to expand.
+
+These details remain hidden until expanded.
+
+PASTE LOGS HERE
+
+
+
+### Keyboard HTML tag
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#keyboard-html-tag).
+
+The `` element is used to identify text that represents user keyboard input. Text surrounded by `` tags is typically displayed in the browser's default monospace font.
+
+```html
+Press Enter to go to the next page.
+```
+
+Press Enter to go to the next page.
+
+### Superscripts / Subscripts
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#superscripts-subscripts).
+
+For superscripts and subscripts, use the standard HTML syntax:
+
+```html
+The formula for water is H2O
+while the equation for the theory of relativity is E = mc2.
+```
+
+
+
+The formula for water is H2O
+while the equation for the theory of relativity is E = mc2.
+
+
+
+GitLab Flavored Markdown doesn't support the Redcarpet superscript syntax ( `x^2` ).
+
+## Wiki-specific Markdown
+
+The following topics show how links inside wikis behave.
+
+When linking to wiki pages, you should use the **page slug** rather than the page name.
+
+### Wiki - direct page link
+
+A direct page link includes the slug for a page that points to that page,
+at the base level of the wiki.
+
+This example links to a `documentation` page at the root of your wiki:
+
+```markdown
+[Link to Documentation](documentation)
+```
+
+### Wiki - direct file link
+
+A direct file link points to a file extension for a file, relative to the current page.
+
+If the following example is on a page at `/documentation/related`,
+it links to `/documentation/file.md`:
+
+```markdown
+[Link to File](file.md)
+```
+
+### Wiki - hierarchical link
+
+A hierarchical link can be constructed relative to the current wiki page by using `./`,
+`../`, and so on.
+
+If this example is on a page at `/documentation/main`,
+it links to `/documentation/related`:
+
+```markdown
+[Link to Related Page](related)
+```
+
+If this example is on a page at `/documentation/related/content`,
+it links to `/documentation/main`:
+
+```markdown
+[Link to Related Page](../main)
+```
+
+If this example is on a page at `/documentation/main`,
+it links to `/documentation/related.md`:
+
+```markdown
+[Link to Related Page](related.md)
+```
+
+If this example is on a page at `/documentation/related/content`,
+it links to `/documentation/main.md`:
+
+```markdown
+[Link to Related Page](../main.md)
+```
+
+### Wiki - root link
+
+A root link starts with a `/` and is relative to the wiki root.
+
+This example links to `/documentation`:
+
+```markdown
+[Link to Related Page](/documentation)
+```
+
+This example links to `/miscellaneous.md`:
+
+```markdown
+[Link to Related Page](/miscellaneous.md)
+```
+
+### diagrams.net editor
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322174) in GitLab 15.10.
+
+In wikis, you can use the [diagrams.net](https://www.diagrams.net/) editor to create diagrams. You
+can also edit diagrams created with the diagrams.net editor. The diagram editor is available in both
+the plain text editor and the rich text editor.
+
+For more information, see [Diagrams.net](../administration/integration/diagrams_net.md).
+
+#### Plain text editor
+
+To create a diagram in the plain text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the plain text editor
+ (the button on the bottom left says **Switch to rich text editing**).
+1. In the editor's toolbar, select **Insert or edit diagram** (**{diagram}**).
+1. Create the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+A Markdown image reference to the diagram is inserted in the wiki content.
+
+To edit a diagram in the plain text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the plain text editor
+ (the button on the bottom left says **Switch to rich text editing**).
+1. Position your cursor in the Markdown image reference that contains the diagram.
+1. Select **Insert or edit diagram** (**{diagram}**).
+1. Edit the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+A Markdown image reference to the diagram is inserted in the wiki content,
+replacing the previous diagram.
+
+#### Rich text editor
+
+To create a diagram in the rich text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the rich text editor
+ (the button on the bottom left says **Switch to plain text editing**).
+1. In the editor's toolbar, select **More options** (**{plus}**).
+1. In the dropdown list, select **Create or edit diagram**.
+1. Create the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+The diagram as visualized in the diagrams.net editor is inserted in the wiki content.
+
+To edit a diagram in the rich text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the rich text editor
+ (the button on the bottom left says **Switch to plain text editing**).
+1. Select the diagram that you want to edit.
+1. In the floating toolbar, select **Edit diagram** (**{diagram}**).
+1. Edit the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+The selected diagram is replaced with an updated version.
+
+## GitLab-specific references
+
+> - Autocomplete for wiki pages [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/442229) in GitLab 16.11.
+
+GitLab Flavored Markdown renders GitLab-specific references. For example, you can reference
+an issue, a commit, a team member, or even an entire project team. GitLab Flavored Markdown turns
+that reference into a link so you can navigate between them. All references to projects should use the
+**project slug** rather than the project name.
+
+Additionally, GitLab Flavored Markdown recognizes certain cross-project references and also has a shorthand
+version to reference other projects from the same namespace.
+
+GitLab Flavored Markdown recognizes the following:
+
+| References | Input | Cross-project reference | Shortcut inside the same namespace |
+|--------------------------------------------------------------------------------------|-------------------------------------------------------|-----------------------------------------|------------------------------------|
+| Specific user | `@user_name` | | |
+| Specific group | `@group_name` | | |
+| Entire team | [`@all`](discussions/index.md#mentioning-all-members) | | |
+| Project | `namespace/project>` | | |
+| Issue | ``#123`` | `namespace/project#123` | `project#123` |
+| Merge request | `!123` | `namespace/project!123` | `project!123` |
+| 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 ID1 | `[cadence:123]` | | |
+| [Iteration cadence](group/iterations/index.md) by title (one word)1 | `[cadence:plan]` | | |
+| [Iteration cadence](group/iterations/index.md) by title (multiple words)1 | `[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` |
+| Label by name (one word) | `~bug` | `namespace/project~bug` | `project~bug` |
+| Label by name (multiple words) | `~"feature request"` | `namespace/project~"feature request"` | `project~"feature request"` |
+| Label by name (scoped) | `~"priority::high"` | `namespace/project~"priority::high"` | `project~"priority::high"` |
+| Project milestone by ID 2 | `%123` | `namespace/project%123` | `project%123` |
+| Milestone by name (one word) 2 | `%v1.23` | `namespace/project%v1.23` | `project%v1.23` |
+| Milestone by name (multiple words) 2 | `%"release candidate"` | `namespace/project%"release candidate"` | `project%"release candidate"` |
+| Commit (specific) | `9ba12248` | `namespace/project@9ba12248` | `project@9ba12248` |
+| Commit range comparison | `9ba12248...b19a04f5` | `namespace/project@9ba12248...b19a04f5` | `project@9ba12248...b19a04f5` |
+| Repository file reference | `[README](doc/README.md)` | | |
+| Repository file reference (specific line) | `[README](doc/README.md#L13)` | | |
+| [Alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` |
+| [Contact](crm/index.md#contacts) | `[contact:test@example.com]` | | |
+| [Wiki page](project/wiki/index.md) (if the page slug is the same as the title) | `[[Home]]` | | |
+| [Wiki page](project/wiki/index.md) (if the page slug is different from the title) | `[[How to use GitLab\|how-to-use-gitlab]]` | | |
+
+**Footnotes:**
+
+1. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384885) in GitLab 16.9.
+ Iteration cadence references are always rendered following the format `[cadence:]`.
+ For example, the text reference `[cadence:"plan"]` renders as `[cadence:1]` if the referenced
+ iterations cadence's ID is `1`.
+1. For milestones, prepend a `/` before `namespace/project` to specify the exact milestone,
+ removing any possible ambiguity.
+
+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,
+add a leading backslash `\#123`.
+
+In addition to this, links to some objects are also recognized and formatted.
+For example:
+
+- Comments on issues: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234#note_101075757"`, rendered as `#1234 (comment 101075757)`
+- The issues designs tab: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234/designs"`, rendered as `#1234 (designs)`.
+- Links to individual designs: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234/designs/layout.png"`, rendered as `#1234[layout.png]`.
+
+### Show the issue, merge request, or epic title in the reference
+
+> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
+
+To include the title in the rendered link of an issue, work item, merge request, or epic:
+
+- Add a plus (`+`) at the end of the reference.
+
+For example, a reference like `#123+` is rendered as `The issue title (#123)`.
+
+URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+` are also expanded.
+
+### Show the issue, work item or merge request summary in the reference
+
+> - Support for issues and merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386937) in GitLab 15.10.
+> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
+
+To include an extended summary in the rendered link of an issue, work item, or merge request:
+
+- Add a `+s` at the end of the reference.
+
+Summary includes information about **assignees**, **milestone** and **health status** of referenced item.
+
+For example, a reference like `#123+s` is rendered as
+`The issue title (#123) • First Assignee, Second Assignee+ • v15.10 • Needs attention`.
+
+URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+s` are also expanded.
+
+To update the rendered references if the assignee, milestone, or health status changed:
+
+- Edit the comment or description and save it.
+
+Issue [420807](https://gitlab.com/gitlab-org/gitlab/-/issues/420807) tracks improving how these
+references refresh.
+
+### Embedding Observability dashboards
+
+You can embed GitLab Observability UI dashboards descriptions and comments, for example in epics, issues, and MRs.
+
+To embed an Observability dashboard URL:
+
+1. In GitLab Observability UI, copy the URL in the address bar.
+1. Paste your link in a comment or description. GitLab Flavored Markdown recognizes the URL and displays the source.
+
## References
- The [GitLab Flavored Markdown (GLFM) Specification Guide](../development/gitlab_flavored_markdown/index.md) is a developer-facing document that describes in detail the various goals, tools, implementations, and terms related to the GLFM specification.
diff --git a/doc/user/project/img/issue_board_creation_v13_6.png b/doc/user/project/img/issue_board_creation_v13_6.png
deleted file mode 100644
index e36b53418fd..00000000000
Binary files a/doc/user/project/img/issue_board_creation_v13_6.png and /dev/null differ
diff --git a/doc/user/project/img/issue_board_creation_v17_1.png b/doc/user/project/img/issue_board_creation_v17_1.png
new file mode 100644
index 00000000000..79f67c91217
Binary files /dev/null and b/doc/user/project/img/issue_board_creation_v17_1.png differ
diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md
index 5fbf7991ade..a96a9c22818 100644
--- a/doc/user/project/issue_board.md
+++ b/doc/user/project/issue_board.md
@@ -277,15 +277,15 @@ An issue board can be associated with a [milestone](milestones/index.md),
which automatically filter the board issues accordingly.
This allows you to create unique boards according to your team's need.
-
+
-You can define the scope of your board when creating it or by selecting the **Edit board** button.
+You can define the scope of your board when creating it or by selecting the **Configure board** (**{settings}**) button.
After a milestone, iteration, assignee, or weight is assigned to an issue board, you can no longer
filter through these in the search bar. To do that, you need to remove the desired scope
(for example, milestone, assignee, or weight) from the issue board.
If you don't have editing permission in a board, you're still able to see the configuration by
-selecting **View scope**.
+selecting **Board configuration** (**{settings}**).
Watch a [video presentation](https://youtu.be/m5UTNCSqaDk) of
diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md
index 2f5fce72138..d197052d4c4 100644
--- a/doc/user/project/members/index.md
+++ b/doc/user/project/members/index.md
@@ -35,7 +35,11 @@ Indirect membership can be inherited, shared, or inherited shared.
| [Inherited shared](../../group/manage.md#share-a-group-with-another-group) | The user is a member of a parent of a group or project invited to the current group or project. |
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart RL
+ accTitle: Membership types
+ accDescr: Describes membership types and their inheritance
+
subgraph Group A
A(Direct member)
B{{Shared member}}
@@ -397,7 +401,10 @@ In the following example, `User` is a:
- Indirect inherited member of `subsubgroup-2` and `subsubgroup-3`.
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
+ accTitle: Diagram of group inheritance
+ accDescr: User inheritance, both direct and indirect through subgroups
classDef user stroke:green,color:green;
root --> subgroup --> subsubgroup
diff --git a/doc/user/project/time_tracking.md b/doc/user/project/time_tracking.md
index 88e21c119e3..f4aeb2fca3b 100644
--- a/doc/user/project/time_tracking.md
+++ b/doc/user/project/time_tracking.md
@@ -10,17 +10,21 @@ DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
-You can estimate and track the time you spend on [issues](issues/index.md)
-and [merge requests](merge_requests/index.md).
+> - Time tracking for tasks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438577) in GitLab 17.0.
-Then you can [view a report](#view-a-time-tracking-report) that shows totals over time.
+You can estimate and track the time you spend on an item, such as:
+
+- [Issue](issues/index.md)
+- [Task](../tasks.md)
+- [Merge request](merge_requests/index.md)
+
+Then you can [view a report](#view-an-items-time-tracking-report) that shows totals over time.
Use time tracking for these tasks:
-- Record the time spent working on an issue or a merge request.
-- Add or update an estimate of the total time to complete an issue or a merge
- request.
-- View a breakdown of time spent working on an issue or a merge request.
+- Record the time spent working on an item.
+- Add or update an estimate of the total time to complete an item.
+- View a breakdown of time spent working on an item.
You don't have to indicate an estimate to enter the time spent, and vice versa.
@@ -28,13 +32,13 @@ To enter and remove time tracking data, you must use [quick actions](quick_actio
Type all quick actions on their own lines.
If you use any quick action more than once in a single comment, only its last occurrence is applied.
-You can see the data about time tracking on the right sidebar in issues and merge requests:
+You can see the data about time tracking on the right sidebar:
## Estimates
-The estimate is designed to show the total time needed to complete an issue or merge request.
+The estimate is designed to show the total time needed to complete an item.
You can see the estimated time remaining when you hover over the time tracking information in the right sidebar.
@@ -45,6 +49,7 @@ You can see the estimated time remaining when you hover over the time tracking i
Prerequisites:
- In issues, you must have at least the Reporter role for the project.
+- In tasks, you must have at least the Reporter role for the project.
- In merge requests, you must have at least the Developer role for the project.
To enter an estimate, use the `/estimate` [quick action](quick_actions.md), followed by the time.
@@ -53,7 +58,7 @@ For example, if you need to enter an estimate of 1 month, 2 weeks, 3 days, 4 hou
type `/estimate 1mo 2w 3d 4h 5m`.
Check the [time units you can use](#available-time-units).
-An issue or a merge request can have only one estimate.
+An item can have only one estimate.
Every time you enter a new time estimate, it overwrites the previous value.
### Remove an estimate
@@ -61,6 +66,7 @@ Every time you enter a new time estimate, it overwrites the previous value.
Prerequisites:
- In issues, you must have at least the Reporter role for the project.
+- In tasks, you must have at least the Reporter role for the project.
- In merge requests, you must have at least the Developer role for the project.
To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_actions.md).
@@ -70,9 +76,9 @@ To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_
As you work, you can log the time you've spent.
Every new time spent entry is added to the current total time spent for the
-issue or the merge request.
+issue, task, or the merge request.
-The total amount of time spent on an issue or merge request cannot exceed a year.
+The total amount of time spent on an issue, task, or merge request cannot exceed a year.
### Add time spent
@@ -96,7 +102,7 @@ To add a time entry using the user interface:
1. Select **Save**.
-The **Spent** total in the sidebar is updated and you can view all entries in a [time tracking report](#view-a-time-tracking-report).
+The **Spent** total in the sidebar is updated and you can view all entries in a [time tracking report](#view-an-items-time-tracking-report).
#### Using a quick action
@@ -106,7 +112,7 @@ For example, if you need
to log 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes, type `/spend 1mo 2w 3d 4h 5m`.
Check the [time units you can use](#available-time-units).
-To add a [time tracking report](#view-a-time-tracking-report) entry with a note, create a comment
+To add a [time tracking report](#view-an-items-time-tracking-report) entry with a note, create a comment
with a description and the quick action.
It then shows in the time tracking report **Summary/Notes** column. For example:
@@ -156,20 +162,25 @@ Prerequisites:
To delete all the time spent at once, use the `/remove_time_spent` [quick action](quick_actions.md).
-## View a time tracking report
+## View an item's time tracking report
-### For an issue or merge request
+To view a time tracking report of time spent on an item:
-To view a time tracking report of time spent on an issue or merge request:
+- For an issue or merge request:
-1. Go to an issue or a merge request.
-1. In the right sidebar, select **Time tracking report**.
+ 1. Go to an issue or a merge request.
+ 1. In the right sidebar, select **Time tracking report**.
+
+- For a task:
+
+ 1. Go to a task.
+ 1. In the right sidebar, select the time next to **Spent**.
The breakdown of spent time displayed is limited to a maximum of 100 entries.
-### Global time tracking report
+## Global time tracking report
DETAILS:
**Status**: Experiment
@@ -182,7 +193,7 @@ On self-managed GitLab, by default this feature is not available. To make it ava
On GitLab.com, this feature is available. On GitLab Dedicated, this feature is not available.
This feature is not ready for production use.
-View a report of time spent in issues and merge requests across all of GitLab.
+View a report of time spent in issues, tasks, and merge requests across all of GitLab.
This feature is an [experiment](../../policy/experiment-beta-support.md).
If you find a bug, let us know in the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/435222).
diff --git a/doc/user/tasks.md b/doc/user/tasks.md
index b7d7cd94da1..6331f69b9ac 100644
--- a/doc/user/tasks.md
+++ b/doc/user/tasks.md
@@ -348,6 +348,12 @@ To add a task to an iteration:
1. Next to **Iteration**, select **Add to iteration**.
1. From the dropdown list, select the iteration to be associated with the task.
+## Set time tracking
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438577) in GitLab 17.0.
+
+To set time tracking, refer to the [time tracking page](project/time_tracking.md)
+
## View task system notes
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378949) in GitLab 15.7 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default.
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index e2f2c004ba7..f730ffb236e 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -8831,9 +8831,6 @@ msgstr ""
msgid "Boards|Create new issue"
msgstr ""
-msgid "Boards|Edit board"
-msgstr ""
-
msgid "Boards|Edit list settings"
msgstr ""
@@ -8867,16 +8864,16 @@ msgstr ""
msgid "Boards|View all blocking %{issuableType}s"
msgstr ""
-msgid "Boards|View scope"
-msgstr ""
-
msgid "Boards|You can add a new list to the board here"
msgstr ""
msgid "Board|Are you sure you want to delete this board?"
msgstr ""
-msgid "Board|Board scope"
+msgid "Board|Board configuration"
+msgstr ""
+
+msgid "Board|Configure board"
msgstr ""
msgid "Board|Create board"
@@ -8888,9 +8885,6 @@ msgstr ""
msgid "Board|Delete board"
msgstr ""
-msgid "Board|Edit board"
-msgstr ""
-
msgid "Board|Enter board name"
msgstr ""
@@ -29507,15 +29501,15 @@ msgstr ""
msgid "Jobs|Raw text search is not currently supported for the jobs filtered search feature. Please use the available search tokens."
msgstr ""
-msgid "Jobs|Root cause analysis"
-msgstr ""
-
msgid "Jobs|Stage"
msgstr ""
msgid "Jobs|There was a problem fetching the failed jobs."
msgstr ""
+msgid "Jobs|Troubleshoot"
+msgstr ""
+
msgid "Jobs|Use jobs to automate your tasks"
msgstr ""
diff --git a/package.json b/package.json
index b91eedadbac..de2061dfb12 100644
--- a/package.json
+++ b/package.json
@@ -63,7 +63,7 @@
"@gitlab/favicon-overlay": "2.0.0",
"@gitlab/fonts": "^1.3.0",
"@gitlab/svgs": "3.99.0",
- "@gitlab/ui": "80.10.0",
+ "@gitlab/ui": "80.11.0",
"@gitlab/web-ide": "^0.0.1-dev-20240508140740",
"@mattiasbuelens/web-streams-adapter": "^0.1.0",
"@rails/actioncable": "7.0.8-1",
diff --git a/spec/frontend/boards/components/board_form_spec.js b/spec/frontend/boards/components/board_form_spec.js
index 058ae3f9aa9..fa0dd8b7e29 100644
--- a/spec/frontend/boards/components/board_form_spec.js
+++ b/spec/frontend/boards/components/board_form_spec.js
@@ -117,7 +117,7 @@ describe('BoardForm', () => {
});
it('displays board scope title', () => {
- expect(findModal().attributes('title')).toBe('Board scope');
+ expect(findModal().attributes('title')).toBe('Board configuration');
});
it('does not display a form', () => {
@@ -246,7 +246,7 @@ describe('BoardForm', () => {
});
it('shows a correct title about creating a board', () => {
- expect(findModal().attributes('title')).toBe('Edit board');
+ expect(findModal().attributes('title')).toBe('Configure board');
});
it('passes correct primary action text and variant', () => {
diff --git a/spec/frontend/boards/components/config_toggle_spec.js b/spec/frontend/boards/components/config_toggle_spec.js
index 648d61036a1..9084fadbaec 100644
--- a/spec/frontend/boards/components/config_toggle_spec.js
+++ b/spec/frontend/boards/components/config_toggle_spec.js
@@ -17,14 +17,14 @@ describe('ConfigToggle', () => {
const findButton = () => wrapper.findComponent(GlButton);
- it('renders a button with label `View scope` when `canAdminList` is `false`', () => {
+ it('renders a button with label `Board configuration` when `canAdminList` is `false`', () => {
wrapper = createComponent({ canAdminList: false });
- expect(findButton().attributes('title')).toBe('View scope');
+ expect(findButton().attributes('title')).toBe('Board configuration');
});
- it('renders a button with label `Edit board` when `canAdminList` is `true`', () => {
+ it('renders a button with label `Configure board` when `canAdminList` is `true`', () => {
wrapper = createComponent();
- expect(findButton().element.title).toBe('Edit board');
+ expect(findButton().element.title).toBe('Configure board');
});
it('emits `showBoardModal` when button is clicked', () => {
diff --git a/spec/frontend/issues/create_merge_request_dropdown_spec.js b/spec/frontend/issues/create_merge_request_dropdown_spec.js
index 0404118f010..56dad4b0a7c 100644
--- a/spec/frontend/issues/create_merge_request_dropdown_spec.js
+++ b/spec/frontend/issues/create_merge_request_dropdown_spec.js
@@ -93,7 +93,7 @@ describe('CreateMergeRequestDropdown', () => {
`('toggle loading spinner when loading is $loading', ({ loading, hasClass }) => {
dropdown.setLoading(loading);
- expect(document.querySelector('.js-spinner').classList.contains('gl-display-none')).toEqual(
+ expect(document.querySelector('.js-spinner').classList.contains('gl-hidden')).toEqual(
hasClass,
);
});
diff --git a/spec/support/helpers/database/duplicate_indexes.yml b/spec/support/helpers/database/duplicate_indexes.yml
index a010f048453..26631b407bb 100644
--- a/spec/support/helpers/database/duplicate_indexes.yml
+++ b/spec/support/helpers/database/duplicate_indexes.yml
@@ -107,6 +107,9 @@ requirements_management_test_reports:
sbom_component_versions:
index_sbom_component_versions_on_component_id_and_version:
- index_sbom_component_versions_on_component_id
+sbom_occurrences:
+ index_unarchived_occurrences_on_version_id_and_traversal_ids:
+ - index_sbom_occurrences_on_component_version_id
search_namespace_index_assignments:
index_search_namespace_index_assignments_uniqueness_index_type:
- index_search_namespace_index_assignments_on_namespace_id
diff --git a/spec/support/matchers/exceed_query_limit.rb b/spec/support/matchers/exceed_query_limit.rb
index cc912d8de66..71cdac317e7 100644
--- a/spec/support/matchers/exceed_query_limit.rb
+++ b/spec/support/matchers/exceed_query_limit.rb
@@ -194,7 +194,7 @@ module ExceedQueryLimitHelpers
#{sections.join("\n\n")}
MSG
else
- @recorder.log_message
+ query_log(@recorder).join("\n\n")
end
end
@@ -348,7 +348,12 @@ RSpec::Matchers.define :exceed_all_query_limit do |expected|
include ExceedQueryLimitHelpers
match do |block|
- verify_count(&block)
+ if block.is_a?(ActiveRecord::QueryRecorder)
+ @recorder = block
+ verify_count
+ else
+ verify_count(&block)
+ end
end
failure_message_when_negated do |actual|
diff --git a/yarn.lock b/yarn.lock
index 3fd32010349..d86024213ae 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1331,10 +1331,10 @@
resolved "https://registry.yarnpkg.com/@gitlab/svgs/-/svgs-3.99.0.tgz#85d2752787c3a87d40d5468a797e67c1e736a9fc"
integrity sha512-N1y2W8ti0Pw7N8UYUdcl7DQuIZfOcL0R85EzJlSgXLt+I0NdmX4s3CCqBV1g62ZDxLgfDqBfiLKLCcYz8JkJ8w==
-"@gitlab/ui@80.10.0":
- version "80.10.0"
- resolved "https://registry.yarnpkg.com/@gitlab/ui/-/ui-80.10.0.tgz#3c748d3127197e1d576aee7546497286e169bdf9"
- integrity sha512-SL/obWt6uMVEW1qYSBNaI8U1sekInuckDQbdRH5eo6sjICdlOljm0rTvYaH8hux188sIFhuLD7Ovl84UhF6PFg==
+"@gitlab/ui@80.11.0":
+ version "80.11.0"
+ resolved "https://registry.yarnpkg.com/@gitlab/ui/-/ui-80.11.0.tgz#8bdaba3f31d5737d47f007488d95444fc0a42dad"
+ integrity sha512-NaVVNAYYFtnU90Wdhs1iJDVwOeRq5j6iG7QCxl4pEKvjdoVxU504rUUlp2YUmVzHBuDoZlaWIfvPi4p0hVO/9w==
dependencies:
"@floating-ui/dom" "1.4.3"
bootstrap-vue "2.23.1"
Click to expand
- -These details remain hidden until expanded. - -PASTE LOGS HEREClick to expand
- -These details remain hidden until expanded. - -PASTE LOGS HERE- -Click to _expand._ - -
- -These details _remain_ **hidden** until expanded. - -``` -PASTE LOGS HERE -``` - -Click to expand.
- -These details remain hidden until expanded. - -PASTE LOGS HERE- This line shows an [inline-style link](https://www.google.com)
-- This line shows a [link to a repository file in the same directory](permissions.md)
-- This line shows a [relative link to a file one directory higher](../index.md)
-- This line shows a [link that also has title text](https://www.google.com "This link takes you to Google!")
+## Math
-Using heading ID anchors:
+> - LaTeX-compatible fencing [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21757) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `markdown_dollar_math`. Disabled by default. Enabled on GitLab.com.
+> - LaTeX-compatible fencing [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/371180) in GitLab 15.8. Feature flag `markdown_dollar_math` removed.
-- This line links to [a section on a different Markdown page, using a "#" and the heading ID](permissions.md#project-features-permissions)
-- This line links to [a different section on the same page, using a "#" and the heading ID](#heading-ids-and-links)
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#math).
-Using references:
+Math written in LaTeX syntax is rendered with [KaTeX](https://github.com/KaTeX/KaTeX).
+_KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._
+This syntax also works in AsciiDoc wikis and files using `:stem: latexmath`. For details, see
+the [Asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support).
-- This line shows a [reference-style link, see below][Arbitrary case-insensitive reference text]
-- You can [use numbers for reference-style link definitions, see below][1]
-- Or leave it empty and use the [link text itself][], see below.
+To prevent malicious activity, GitLab renders only the first 50 inline math instances.
+The number of math blocks is also limited based on render time. If the limit is exceeded,
+GitLab renders the excess math instances as text. Wiki and repository files do not have
+these limits.
-Some text to show that the reference links can follow later.
+Math written between dollar signs with backticks (``$`...`$``) or single dollar signs (`$...$`)
+is rendered inline with the text.
-[arbitrary case-insensitive reference text]: https://www.mozilla.org/en-US/
-[1]: https://slashdot.org
-[link text itself]: https://about.gitlab.com/
-A footnote reference tag looks like this: [^1]
+
+This reference tag is a mix of letters and numbers. [^footnote-42]
+
+[^1]: This text is inside a footnote.
+
+[^footnote-42]: This text is another footnote.
+-
+
- Definition list +
- Is something people use sometimes. + +
- Markdown in HTML +
- Does *not* work **very** well. HTML tags do work, in most cases. +
-
+
- Definition list +
- Is something people use sometimes. + +
- Markdown in HTML +
- Does *not* work **very** well. HTML tags do work, in most cases. +
-
+
- Markdown in HTML +
- Does *not* work **very** well. HTML tags work, in most cases. + +
- Markdown in HTML with proper spacing +
- + + Does *not* work **very** well. HTML tags work, in most cases. + + +
-
+
- Markdown in HTML +
- Does *not* work **very** well. HTML tags work, in most cases. + +
- Markdown in HTML with proper spacing +
- + + Does not work very well. HTML tags work, in most cases. + + +
`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details)
+and [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary)
+tags. For example, collapse a long log file so it takes up less screen space.
+
+```html
+
`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary)
+tags. For example, collapse a long log file so it takes up less screen space.
+
+```html
+
+Click to expand
+
+These details remain hidden until expanded.
+
+PASTE LOGS HERE
+
+
+```
+
+
+Click to expand
+
+These details remain hidden until expanded.
+
+PASTE LOGS HERE
+
+
+
+---
+
+Markdown inside these tags is also supported.
+
+Remember to leave a blank line before and after any Markdown sections, as shown in the example:
+
+````html
+
+
+
+Click to _expand._
+
+
+
+These details _remain_ **hidden** until expanded.
+
+```
+PASTE LOGS HERE
+```
+
+
+````
+
+
+
+
+Click to expand.
+
+These details remain hidden until expanded.
+
+PASTE LOGS HERE
+
+
+
+### Keyboard HTML tag
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#keyboard-html-tag).
+
+The `` element is used to identify text that represents user keyboard input. Text surrounded by `` tags is typically displayed in the browser's default monospace font.
+
+```html
+Press Enter to go to the next page.
+```
+
+Press Enter to go to the next page.
+
+### Superscripts / Subscripts
+
+[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#superscripts-subscripts).
+
+For superscripts and subscripts, use the standard HTML syntax:
+
+```html
+The formula for water is H2O
+while the equation for the theory of relativity is E = mc2.
+```
+
+
+
+The formula for water is H2O
+while the equation for the theory of relativity is E = mc2.
+
+
+
+GitLab Flavored Markdown doesn't support the Redcarpet superscript syntax ( `x^2` ).
+
+## Wiki-specific Markdown
+
+The following topics show how links inside wikis behave.
+
+When linking to wiki pages, you should use the **page slug** rather than the page name.
+
+### Wiki - direct page link
+
+A direct page link includes the slug for a page that points to that page,
+at the base level of the wiki.
+
+This example links to a `documentation` page at the root of your wiki:
+
+```markdown
+[Link to Documentation](documentation)
+```
+
+### Wiki - direct file link
+
+A direct file link points to a file extension for a file, relative to the current page.
+
+If the following example is on a page at `/documentation/related`,
+it links to `/documentation/file.md`:
+
+```markdown
+[Link to File](file.md)
+```
+
+### Wiki - hierarchical link
+
+A hierarchical link can be constructed relative to the current wiki page by using `./`,
+`../`, and so on.
+
+If this example is on a page at `/documentation/main`,
+it links to `/documentation/related`:
+
+```markdown
+[Link to Related Page](related)
+```
+
+If this example is on a page at `/documentation/related/content`,
+it links to `/documentation/main`:
+
+```markdown
+[Link to Related Page](../main)
+```
+
+If this example is on a page at `/documentation/main`,
+it links to `/documentation/related.md`:
+
+```markdown
+[Link to Related Page](related.md)
+```
+
+If this example is on a page at `/documentation/related/content`,
+it links to `/documentation/main.md`:
+
+```markdown
+[Link to Related Page](../main.md)
+```
+
+### Wiki - root link
+
+A root link starts with a `/` and is relative to the wiki root.
+
+This example links to `/documentation`:
+
+```markdown
+[Link to Related Page](/documentation)
+```
+
+This example links to `/miscellaneous.md`:
+
+```markdown
+[Link to Related Page](/miscellaneous.md)
+```
+
+### diagrams.net editor
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/322174) in GitLab 15.10.
+
+In wikis, you can use the [diagrams.net](https://www.diagrams.net/) editor to create diagrams. You
+can also edit diagrams created with the diagrams.net editor. The diagram editor is available in both
+the plain text editor and the rich text editor.
+
+For more information, see [Diagrams.net](../administration/integration/diagrams_net.md).
+
+#### Plain text editor
+
+To create a diagram in the plain text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the plain text editor
+ (the button on the bottom left says **Switch to rich text editing**).
+1. In the editor's toolbar, select **Insert or edit diagram** (**{diagram}**).
+1. Create the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+A Markdown image reference to the diagram is inserted in the wiki content.
+
+To edit a diagram in the plain text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the plain text editor
+ (the button on the bottom left says **Switch to rich text editing**).
+1. Position your cursor in the Markdown image reference that contains the diagram.
+1. Select **Insert or edit diagram** (**{diagram}**).
+1. Edit the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+A Markdown image reference to the diagram is inserted in the wiki content,
+replacing the previous diagram.
+
+#### Rich text editor
+
+To create a diagram in the rich text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the rich text editor
+ (the button on the bottom left says **Switch to plain text editing**).
+1. In the editor's toolbar, select **More options** (**{plus}**).
+1. In the dropdown list, select **Create or edit diagram**.
+1. Create the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+The diagram as visualized in the diagrams.net editor is inserted in the wiki content.
+
+To edit a diagram in the rich text editor:
+
+1. On the wiki page you want to edit, select **Edit**.
+1. In the text box, make sure you're using the rich text editor
+ (the button on the bottom left says **Switch to plain text editing**).
+1. Select the diagram that you want to edit.
+1. In the floating toolbar, select **Edit diagram** (**{diagram}**).
+1. Edit the diagram in the [app.diagrams.net](https://app.diagrams.net/) editor.
+1. Select **Save & exit**.
+
+The selected diagram is replaced with an updated version.
+
+## GitLab-specific references
+
+> - Autocomplete for wiki pages [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/442229) in GitLab 16.11.
+
+GitLab Flavored Markdown renders GitLab-specific references. For example, you can reference
+an issue, a commit, a team member, or even an entire project team. GitLab Flavored Markdown turns
+that reference into a link so you can navigate between them. All references to projects should use the
+**project slug** rather than the project name.
+
+Additionally, GitLab Flavored Markdown recognizes certain cross-project references and also has a shorthand
+version to reference other projects from the same namespace.
+
+GitLab Flavored Markdown recognizes the following:
+
+| References | Input | Cross-project reference | Shortcut inside the same namespace |
+|--------------------------------------------------------------------------------------|-------------------------------------------------------|-----------------------------------------|------------------------------------|
+| Specific user | `@user_name` | | |
+| Specific group | `@group_name` | | |
+| Entire team | [`@all`](discussions/index.md#mentioning-all-members) | | |
+| Project | `namespace/project>` | | |
+| Issue | ``#123`` | `namespace/project#123` | `project#123` |
+| Merge request | `!123` | `namespace/project!123` | `project!123` |
+| 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 ID1 | `[cadence:123]` | | |
+| [Iteration cadence](group/iterations/index.md) by title (one word)1 | `[cadence:plan]` | | |
+| [Iteration cadence](group/iterations/index.md) by title (multiple words)1 | `[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` |
+| Label by name (one word) | `~bug` | `namespace/project~bug` | `project~bug` |
+| Label by name (multiple words) | `~"feature request"` | `namespace/project~"feature request"` | `project~"feature request"` |
+| Label by name (scoped) | `~"priority::high"` | `namespace/project~"priority::high"` | `project~"priority::high"` |
+| Project milestone by ID 2 | `%123` | `namespace/project%123` | `project%123` |
+| Milestone by name (one word) 2 | `%v1.23` | `namespace/project%v1.23` | `project%v1.23` |
+| Milestone by name (multiple words) 2 | `%"release candidate"` | `namespace/project%"release candidate"` | `project%"release candidate"` |
+| Commit (specific) | `9ba12248` | `namespace/project@9ba12248` | `project@9ba12248` |
+| Commit range comparison | `9ba12248...b19a04f5` | `namespace/project@9ba12248...b19a04f5` | `project@9ba12248...b19a04f5` |
+| Repository file reference | `[README](doc/README.md)` | | |
+| Repository file reference (specific line) | `[README](doc/README.md#L13)` | | |
+| [Alert](../operations/incident_management/alerts.md) | `^alert#123` | `namespace/project^alert#123` | `project^alert#123` |
+| [Contact](crm/index.md#contacts) | `[contact:test@example.com]` | | |
+| [Wiki page](project/wiki/index.md) (if the page slug is the same as the title) | `[[Home]]` | | |
+| [Wiki page](project/wiki/index.md) (if the page slug is different from the title) | `[[How to use GitLab\|how-to-use-gitlab]]` | | |
+
+**Footnotes:**
+
+1. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/384885) in GitLab 16.9.
+ Iteration cadence references are always rendered following the format `[cadence:]`.
+ For example, the text reference `[cadence:"plan"]` renders as `[cadence:1]` if the referenced
+ iterations cadence's ID is `1`.
+1. For milestones, prepend a `/` before `namespace/project` to specify the exact milestone,
+ removing any possible ambiguity.
+
+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,
+add a leading backslash `\#123`.
+
+In addition to this, links to some objects are also recognized and formatted.
+For example:
+
+- Comments on issues: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234#note_101075757"`, rendered as `#1234 (comment 101075757)`
+- The issues designs tab: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234/designs"`, rendered as `#1234 (designs)`.
+- Links to individual designs: `"https://gitlab.com/gitlab-org/gitlab/-/issues/1234/designs/layout.png"`, rendered as `#1234[layout.png]`.
+
+### Show the issue, merge request, or epic title in the reference
+
+> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
+
+To include the title in the rendered link of an issue, work item, merge request, or epic:
+
+- Add a plus (`+`) at the end of the reference.
+
+For example, a reference like `#123+` is rendered as `The issue title (#123)`.
+
+URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+` are also expanded.
+
+### Show the issue, work item or merge request summary in the reference
+
+> - Support for issues and merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386937) in GitLab 15.10.
+> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
+
+To include an extended summary in the rendered link of an issue, work item, or merge request:
+
+- Add a `+s` at the end of the reference.
+
+Summary includes information about **assignees**, **milestone** and **health status** of referenced item.
+
+For example, a reference like `#123+s` is rendered as
+`The issue title (#123) • First Assignee, Second Assignee+ • v15.10 • Needs attention`.
+
+URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+s` are also expanded.
+
+To update the rendered references if the assignee, milestone, or health status changed:
+
+- Edit the comment or description and save it.
+
+Issue [420807](https://gitlab.com/gitlab-org/gitlab/-/issues/420807) tracks improving how these
+references refresh.
+
+### Embedding Observability dashboards
+
+You can embed GitLab Observability UI dashboards descriptions and comments, for example in epics, issues, and MRs.
+
+To embed an Observability dashboard URL:
+
+1. In GitLab Observability UI, copy the URL in the address bar.
+1. Paste your link in a comment or description. GitLab Flavored Markdown recognizes the URL and displays the source.
+
## References
- The [GitLab Flavored Markdown (GLFM) Specification Guide](../development/gitlab_flavored_markdown/index.md) is a developer-facing document that describes in detail the various goals, tools, implementations, and terms related to the GLFM specification.
diff --git a/doc/user/project/img/issue_board_creation_v13_6.png b/doc/user/project/img/issue_board_creation_v13_6.png
deleted file mode 100644
index e36b53418fd..00000000000
Binary files a/doc/user/project/img/issue_board_creation_v13_6.png and /dev/null differ
diff --git a/doc/user/project/img/issue_board_creation_v17_1.png b/doc/user/project/img/issue_board_creation_v17_1.png
new file mode 100644
index 00000000000..79f67c91217
Binary files /dev/null and b/doc/user/project/img/issue_board_creation_v17_1.png differ
diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md
index 5fbf7991ade..a96a9c22818 100644
--- a/doc/user/project/issue_board.md
+++ b/doc/user/project/issue_board.md
@@ -277,15 +277,15 @@ An issue board can be associated with a [milestone](milestones/index.md),
which automatically filter the board issues accordingly.
This allows you to create unique boards according to your team's need.
-
+
-You can define the scope of your board when creating it or by selecting the **Edit board** button.
+You can define the scope of your board when creating it or by selecting the **Configure board** (**{settings}**) button.
After a milestone, iteration, assignee, or weight is assigned to an issue board, you can no longer
filter through these in the search bar. To do that, you need to remove the desired scope
(for example, milestone, assignee, or weight) from the issue board.
If you don't have editing permission in a board, you're still able to see the configuration by
-selecting **View scope**.
+selecting **Board configuration** (**{settings}**).
Watch a [video presentation](https://youtu.be/m5UTNCSqaDk) of
diff --git a/doc/user/project/members/index.md b/doc/user/project/members/index.md
index 2f5fce72138..d197052d4c4 100644
--- a/doc/user/project/members/index.md
+++ b/doc/user/project/members/index.md
@@ -35,7 +35,11 @@ Indirect membership can be inherited, shared, or inherited shared.
| [Inherited shared](../../group/manage.md#share-a-group-with-another-group) | The user is a member of a parent of a group or project invited to the current group or project. |
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart RL
+ accTitle: Membership types
+ accDescr: Describes membership types and their inheritance
+
subgraph Group A
A(Direct member)
B{{Shared member}}
@@ -397,7 +401,10 @@ In the following example, `User` is a:
- Indirect inherited member of `subsubgroup-2` and `subsubgroup-3`.
```mermaid
+%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD
+ accTitle: Diagram of group inheritance
+ accDescr: User inheritance, both direct and indirect through subgroups
classDef user stroke:green,color:green;
root --> subgroup --> subsubgroup
diff --git a/doc/user/project/time_tracking.md b/doc/user/project/time_tracking.md
index 88e21c119e3..f4aeb2fca3b 100644
--- a/doc/user/project/time_tracking.md
+++ b/doc/user/project/time_tracking.md
@@ -10,17 +10,21 @@ DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
-You can estimate and track the time you spend on [issues](issues/index.md)
-and [merge requests](merge_requests/index.md).
+> - Time tracking for tasks [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438577) in GitLab 17.0.
-Then you can [view a report](#view-a-time-tracking-report) that shows totals over time.
+You can estimate and track the time you spend on an item, such as:
+
+- [Issue](issues/index.md)
+- [Task](../tasks.md)
+- [Merge request](merge_requests/index.md)
+
+Then you can [view a report](#view-an-items-time-tracking-report) that shows totals over time.
Use time tracking for these tasks:
-- Record the time spent working on an issue or a merge request.
-- Add or update an estimate of the total time to complete an issue or a merge
- request.
-- View a breakdown of time spent working on an issue or a merge request.
+- Record the time spent working on an item.
+- Add or update an estimate of the total time to complete an item.
+- View a breakdown of time spent working on an item.
You don't have to indicate an estimate to enter the time spent, and vice versa.
@@ -28,13 +32,13 @@ To enter and remove time tracking data, you must use [quick actions](quick_actio
Type all quick actions on their own lines.
If you use any quick action more than once in a single comment, only its last occurrence is applied.
-You can see the data about time tracking on the right sidebar in issues and merge requests:
+You can see the data about time tracking on the right sidebar:
## Estimates
-The estimate is designed to show the total time needed to complete an issue or merge request.
+The estimate is designed to show the total time needed to complete an item.
You can see the estimated time remaining when you hover over the time tracking information in the right sidebar.
@@ -45,6 +49,7 @@ You can see the estimated time remaining when you hover over the time tracking i
Prerequisites:
- In issues, you must have at least the Reporter role for the project.
+- In tasks, you must have at least the Reporter role for the project.
- In merge requests, you must have at least the Developer role for the project.
To enter an estimate, use the `/estimate` [quick action](quick_actions.md), followed by the time.
@@ -53,7 +58,7 @@ For example, if you need to enter an estimate of 1 month, 2 weeks, 3 days, 4 hou
type `/estimate 1mo 2w 3d 4h 5m`.
Check the [time units you can use](#available-time-units).
-An issue or a merge request can have only one estimate.
+An item can have only one estimate.
Every time you enter a new time estimate, it overwrites the previous value.
### Remove an estimate
@@ -61,6 +66,7 @@ Every time you enter a new time estimate, it overwrites the previous value.
Prerequisites:
- In issues, you must have at least the Reporter role for the project.
+- In tasks, you must have at least the Reporter role for the project.
- In merge requests, you must have at least the Developer role for the project.
To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_actions.md).
@@ -70,9 +76,9 @@ To remove an estimate entirely, use the `/remove_estimate` [quick action](quick_
As you work, you can log the time you've spent.
Every new time spent entry is added to the current total time spent for the
-issue or the merge request.
+issue, task, or the merge request.
-The total amount of time spent on an issue or merge request cannot exceed a year.
+The total amount of time spent on an issue, task, or merge request cannot exceed a year.
### Add time spent
@@ -96,7 +102,7 @@ To add a time entry using the user interface:
1. Select **Save**.
-The **Spent** total in the sidebar is updated and you can view all entries in a [time tracking report](#view-a-time-tracking-report).
+The **Spent** total in the sidebar is updated and you can view all entries in a [time tracking report](#view-an-items-time-tracking-report).
#### Using a quick action
@@ -106,7 +112,7 @@ For example, if you need
to log 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes, type `/spend 1mo 2w 3d 4h 5m`.
Check the [time units you can use](#available-time-units).
-To add a [time tracking report](#view-a-time-tracking-report) entry with a note, create a comment
+To add a [time tracking report](#view-an-items-time-tracking-report) entry with a note, create a comment
with a description and the quick action.
It then shows in the time tracking report **Summary/Notes** column. For example:
@@ -156,20 +162,25 @@ Prerequisites:
To delete all the time spent at once, use the `/remove_time_spent` [quick action](quick_actions.md).
-## View a time tracking report
+## View an item's time tracking report
-### For an issue or merge request
+To view a time tracking report of time spent on an item:
-To view a time tracking report of time spent on an issue or merge request:
+- For an issue or merge request:
-1. Go to an issue or a merge request.
-1. In the right sidebar, select **Time tracking report**.
+ 1. Go to an issue or a merge request.
+ 1. In the right sidebar, select **Time tracking report**.
+
+- For a task:
+
+ 1. Go to a task.
+ 1. In the right sidebar, select the time next to **Spent**.
The breakdown of spent time displayed is limited to a maximum of 100 entries.
-### Global time tracking report
+## Global time tracking report
DETAILS:
**Status**: Experiment
@@ -182,7 +193,7 @@ On self-managed GitLab, by default this feature is not available. To make it ava
On GitLab.com, this feature is available. On GitLab Dedicated, this feature is not available.
This feature is not ready for production use.
-View a report of time spent in issues and merge requests across all of GitLab.
+View a report of time spent in issues, tasks, and merge requests across all of GitLab.
This feature is an [experiment](../../policy/experiment-beta-support.md).
If you find a bug, let us know in the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/435222).
diff --git a/doc/user/tasks.md b/doc/user/tasks.md
index b7d7cd94da1..6331f69b9ac 100644
--- a/doc/user/tasks.md
+++ b/doc/user/tasks.md
@@ -348,6 +348,12 @@ To add a task to an iteration:
1. Next to **Iteration**, select **Add to iteration**.
1. From the dropdown list, select the iteration to be associated with the task.
+## Set time tracking
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/438577) in GitLab 17.0.
+
+To set time tracking, refer to the [time tracking page](project/time_tracking.md)
+
## View task system notes
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/378949) in GitLab 15.7 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default.
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index e2f2c004ba7..f730ffb236e 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -8831,9 +8831,6 @@ msgstr ""
msgid "Boards|Create new issue"
msgstr ""
-msgid "Boards|Edit board"
-msgstr ""
-
msgid "Boards|Edit list settings"
msgstr ""
@@ -8867,16 +8864,16 @@ msgstr ""
msgid "Boards|View all blocking %{issuableType}s"
msgstr ""
-msgid "Boards|View scope"
-msgstr ""
-
msgid "Boards|You can add a new list to the board here"
msgstr ""
msgid "Board|Are you sure you want to delete this board?"
msgstr ""
-msgid "Board|Board scope"
+msgid "Board|Board configuration"
+msgstr ""
+
+msgid "Board|Configure board"
msgstr ""
msgid "Board|Create board"
@@ -8888,9 +8885,6 @@ msgstr ""
msgid "Board|Delete board"
msgstr ""
-msgid "Board|Edit board"
-msgstr ""
-
msgid "Board|Enter board name"
msgstr ""
@@ -29507,15 +29501,15 @@ msgstr ""
msgid "Jobs|Raw text search is not currently supported for the jobs filtered search feature. Please use the available search tokens."
msgstr ""
-msgid "Jobs|Root cause analysis"
-msgstr ""
-
msgid "Jobs|Stage"
msgstr ""
msgid "Jobs|There was a problem fetching the failed jobs."
msgstr ""
+msgid "Jobs|Troubleshoot"
+msgstr ""
+
msgid "Jobs|Use jobs to automate your tasks"
msgstr ""
diff --git a/package.json b/package.json
index b91eedadbac..de2061dfb12 100644
--- a/package.json
+++ b/package.json
@@ -63,7 +63,7 @@
"@gitlab/favicon-overlay": "2.0.0",
"@gitlab/fonts": "^1.3.0",
"@gitlab/svgs": "3.99.0",
- "@gitlab/ui": "80.10.0",
+ "@gitlab/ui": "80.11.0",
"@gitlab/web-ide": "^0.0.1-dev-20240508140740",
"@mattiasbuelens/web-streams-adapter": "^0.1.0",
"@rails/actioncable": "7.0.8-1",
diff --git a/spec/frontend/boards/components/board_form_spec.js b/spec/frontend/boards/components/board_form_spec.js
index 058ae3f9aa9..fa0dd8b7e29 100644
--- a/spec/frontend/boards/components/board_form_spec.js
+++ b/spec/frontend/boards/components/board_form_spec.js
@@ -117,7 +117,7 @@ describe('BoardForm', () => {
});
it('displays board scope title', () => {
- expect(findModal().attributes('title')).toBe('Board scope');
+ expect(findModal().attributes('title')).toBe('Board configuration');
});
it('does not display a form', () => {
@@ -246,7 +246,7 @@ describe('BoardForm', () => {
});
it('shows a correct title about creating a board', () => {
- expect(findModal().attributes('title')).toBe('Edit board');
+ expect(findModal().attributes('title')).toBe('Configure board');
});
it('passes correct primary action text and variant', () => {
diff --git a/spec/frontend/boards/components/config_toggle_spec.js b/spec/frontend/boards/components/config_toggle_spec.js
index 648d61036a1..9084fadbaec 100644
--- a/spec/frontend/boards/components/config_toggle_spec.js
+++ b/spec/frontend/boards/components/config_toggle_spec.js
@@ -17,14 +17,14 @@ describe('ConfigToggle', () => {
const findButton = () => wrapper.findComponent(GlButton);
- it('renders a button with label `View scope` when `canAdminList` is `false`', () => {
+ it('renders a button with label `Board configuration` when `canAdminList` is `false`', () => {
wrapper = createComponent({ canAdminList: false });
- expect(findButton().attributes('title')).toBe('View scope');
+ expect(findButton().attributes('title')).toBe('Board configuration');
});
- it('renders a button with label `Edit board` when `canAdminList` is `true`', () => {
+ it('renders a button with label `Configure board` when `canAdminList` is `true`', () => {
wrapper = createComponent();
- expect(findButton().element.title).toBe('Edit board');
+ expect(findButton().element.title).toBe('Configure board');
});
it('emits `showBoardModal` when button is clicked', () => {
diff --git a/spec/frontend/issues/create_merge_request_dropdown_spec.js b/spec/frontend/issues/create_merge_request_dropdown_spec.js
index 0404118f010..56dad4b0a7c 100644
--- a/spec/frontend/issues/create_merge_request_dropdown_spec.js
+++ b/spec/frontend/issues/create_merge_request_dropdown_spec.js
@@ -93,7 +93,7 @@ describe('CreateMergeRequestDropdown', () => {
`('toggle loading spinner when loading is $loading', ({ loading, hasClass }) => {
dropdown.setLoading(loading);
- expect(document.querySelector('.js-spinner').classList.contains('gl-display-none')).toEqual(
+ expect(document.querySelector('.js-spinner').classList.contains('gl-hidden')).toEqual(
hasClass,
);
});
diff --git a/spec/support/helpers/database/duplicate_indexes.yml b/spec/support/helpers/database/duplicate_indexes.yml
index a010f048453..26631b407bb 100644
--- a/spec/support/helpers/database/duplicate_indexes.yml
+++ b/spec/support/helpers/database/duplicate_indexes.yml
@@ -107,6 +107,9 @@ requirements_management_test_reports:
sbom_component_versions:
index_sbom_component_versions_on_component_id_and_version:
- index_sbom_component_versions_on_component_id
+sbom_occurrences:
+ index_unarchived_occurrences_on_version_id_and_traversal_ids:
+ - index_sbom_occurrences_on_component_version_id
search_namespace_index_assignments:
index_search_namespace_index_assignments_uniqueness_index_type:
- index_search_namespace_index_assignments_on_namespace_id
diff --git a/spec/support/matchers/exceed_query_limit.rb b/spec/support/matchers/exceed_query_limit.rb
index cc912d8de66..71cdac317e7 100644
--- a/spec/support/matchers/exceed_query_limit.rb
+++ b/spec/support/matchers/exceed_query_limit.rb
@@ -194,7 +194,7 @@ module ExceedQueryLimitHelpers
#{sections.join("\n\n")}
MSG
else
- @recorder.log_message
+ query_log(@recorder).join("\n\n")
end
end
@@ -348,7 +348,12 @@ RSpec::Matchers.define :exceed_all_query_limit do |expected|
include ExceedQueryLimitHelpers
match do |block|
- verify_count(&block)
+ if block.is_a?(ActiveRecord::QueryRecorder)
+ @recorder = block
+ verify_count
+ else
+ verify_count(&block)
+ end
end
failure_message_when_negated do |actual|
diff --git a/yarn.lock b/yarn.lock
index 3fd32010349..d86024213ae 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1331,10 +1331,10 @@
resolved "https://registry.yarnpkg.com/@gitlab/svgs/-/svgs-3.99.0.tgz#85d2752787c3a87d40d5468a797e67c1e736a9fc"
integrity sha512-N1y2W8ti0Pw7N8UYUdcl7DQuIZfOcL0R85EzJlSgXLt+I0NdmX4s3CCqBV1g62ZDxLgfDqBfiLKLCcYz8JkJ8w==
-"@gitlab/ui@80.10.0":
- version "80.10.0"
- resolved "https://registry.yarnpkg.com/@gitlab/ui/-/ui-80.10.0.tgz#3c748d3127197e1d576aee7546497286e169bdf9"
- integrity sha512-SL/obWt6uMVEW1qYSBNaI8U1sekInuckDQbdRH5eo6sjICdlOljm0rTvYaH8hux188sIFhuLD7Ovl84UhF6PFg==
+"@gitlab/ui@80.11.0":
+ version "80.11.0"
+ resolved "https://registry.yarnpkg.com/@gitlab/ui/-/ui-80.11.0.tgz#8bdaba3f31d5737d47f007488d95444fc0a42dad"
+ integrity sha512-NaVVNAYYFtnU90Wdhs1iJDVwOeRq5j6iG7QCxl4pEKvjdoVxU504rUUlp2YUmVzHBuDoZlaWIfvPi4p0hVO/9w==
dependencies:
"@floating-ui/dom" "1.4.3"
bootstrap-vue "2.23.1"
Click to expand
+ +These details remain hidden until expanded. + +PASTE LOGS HEREClick to expand
+ +These details remain hidden until expanded. + +PASTE LOGS HERE+ +Click to _expand._ + +
+ +These details _remain_ **hidden** until expanded. + +``` +PASTE LOGS HERE +``` + +Click to expand.
+ +These details remain hidden until expanded. + +PASTE LOGS HERE