Skip to content
代码片段 群组 项目
未验证 提交 bff16f7e 编辑于 作者: Amy Qualls's avatar Amy Qualls 提交者: GitLab
浏览文件

Add fonts and a11y info to Mermaid diagrams

Make these diagrams prettier and more accessible. Configure the font
each one uses, and then set up accessible titles and descriptions
for each one.
上级 da4bf0fa
No related branches found
No related tags found
无相关合并请求
...@@ -113,7 +113,11 @@ and displays it to users, providing information about ongoing incidents without ...@@ -113,7 +113,11 @@ and displays it to users, providing information about ongoing incidents without
extra effort from your team: extra effort from your team:
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB graph TB
accTitle: Understand your status page
accDescr: How GitLab fetches, formats, and displays incident data
subgraph GitLab Instance subgraph GitLab Instance
issues(issue updates) -- trigger --> middleware(Background job: JSON generation) issues(issue updates) -- trigger --> middleware(Background job: JSON generation)
end end
......
...@@ -42,7 +42,10 @@ The following chart should help you determine your subscription model. Select ...@@ -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. the list item to go to the respective help page.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD graph TD
accTitle: My subscription
accDescr: Determine your subscription model and see its help page
A(Is your user account on GitLab.com?) A(Is your user account on GitLab.com?)
A --> B(Yes) A --> B(Yes)
......
...@@ -50,7 +50,11 @@ disable the automated scheduling to ...@@ -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: 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 ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD graph TD
accTitle: Iteration cadence
accDescr: Identify the group you should create an iteration cadence in
Group --> SubgroupA --> Project1 Group --> SubgroupA --> Project1
Group --> SubgroupB --> Project2 Group --> SubgroupB --> Project2
Group --> IterationCadence Group --> IterationCadence
......
...@@ -35,7 +35,11 @@ Each time you push a change, Git records it as a unique *commit*. These commits ...@@ -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. the history of when and how a file changed, and who changed it.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph LR graph LR
accTitle: Repository commit history
accDescr: Flowchart showing linear changes to a repository history
subgraph Repository commit history subgraph Repository commit history
direction LR direction LR
A(Author: Alex<br>Date: 3 Jan at 1PM<br>Commit message: Added sales figures<br> Commit ID: 123abc12) ---> B A(Author: Alex<br>Date: 3 Jan at 1PM<br>Commit message: Added sales figures<br> Commit ID: 123abc12) ---> B
...@@ -53,7 +57,11 @@ of a repository are in a default branch. To make changes, you: ...@@ -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. 1. When you're ready, *merge* your branch into the default branch.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart LR flowchart LR
accTitle: Use branches in Git
accDescr: The flow of creating, then using, a branch in Git
subgraph Default branch subgraph Default branch
A[Commit] --> B[Commit] --> C[Commit] --> D[Commit] A[Commit] --> B[Commit] --> C[Commit] --> D[Commit]
end end
......
...@@ -49,6 +49,7 @@ standardize labels, boards, and iterations across multiple projects: ...@@ -49,6 +49,7 @@ standardize labels, boards, and iterations across multiple projects:
flowchart TD flowchart TD
accTitle: GitLab inheritance model diagram accTitle: GitLab inheritance model diagram
accDescr: Shows how groups, projects, issues, labels, milestones, iterations, tasks, and epics relate to one another in GitLab accDescr: Shows how groups, projects, issues, labels, milestones, iterations, tasks, and epics relate to one another in GitLab
Group -->|Contains| Project Group -->|Contains| Project
Group -->|Contains| Epics Group -->|Contains| Epics
Group -->|Contains| Labels Group -->|Contains| Labels
...@@ -224,7 +225,11 @@ GitLab is extensible to support different flavors of backlog management. ...@@ -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: For this tutorial, we will structure our deliverables in the following way:
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart TD 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)"] Epic["Feature (Epic)"] --> Issue["Job Story (Issue)"]
Issue --> Task["Implementation Step (Task)"] Issue --> Task["Implementation Step (Task)"]
``` ```
...@@ -258,10 +263,14 @@ Here's an example of breaking a feature into vertically sliced job stories based ...@@ -258,10 +263,14 @@ Here's an example of breaking a feature into vertically sliced job stories based
journey: journey:
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart TD flowchart TD
Epic["Epic: When using the application, I need to create an <br> account, so that I can use the application features"] --> Issue1["Issue: When creating my account, I need to specify my email address,<br> so that I can receive future updates from the application"] accTitle: Slicing a feature
Epic --> Issue2["Issue: When creating my account, I need to <br>specify a password, so that my account remains secure"] accDescr: Use the end user's journey to identify slices of work to be completed in iterations
Epic --> Issue3["Issue: When creating my account and entering the required info, I need to <br>finalize creating my account, so that I can log in"]
Epic["Epic: When using the application,<br>I need to create an account,<br> so I can use the application features"] --> Issue1["Issue: When creating my account,<br> I need to specify my email address,<br> so I can receive future updates from the application"]
Epic --> Issue2["Issue: When creating my account,<br> I need to specify a password,<br> so my account remains secure"]
Epic --> Issue3["Issue: When creating my account<br> and entering the required info,<br> I need to finalize creating my account,<br> so I can log in"]
``` ```
You've taken the feature of an unmodified account sign-up for an application and broke it down into 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 ...@@ -275,12 +284,16 @@ After you have broken down a feature into stories, you can further break down th
implementation steps: implementation steps:
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart TD flowchart TD
Issue1["Issue: When creating my account, I need to specify my email address,<br> so that I can receive future updates from the application"] accTitle: Break the story down further
Issue1 --> Task2["Task: Backend - Validate email formatting"] accDescr: Split apart a story into smaller steps
Issue1 --> Task3["Task: Backend - API endpoint to accept POST request from client"]
Issue1 --> Task4["Task: Frontend - Display email input"] Issue1["Issue: When creating my account,<br> I need to specify my email address,<br> so I can receive future updates from the application"]
Issue1 --> Task5["Task: Frontend - Display error message when validation fails"] Issue1 --> Task2["Task: Backend<br> Validate email formatting"]
Issue1 --> Task3["Task: Backend<br> API endpoint to accept<br> POST request from client"]
Issue1 --> Task4["Task: Frontend<br> Display email input"]
Issue1 --> Task5["Task: Frontend<br> Display error message when validation fails"]
``` ```
### Set up a release planning board ### Set up a release planning board
......
...@@ -41,7 +41,10 @@ The possible relationships between epics and issues are: ...@@ -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. - An epic is the parent of one or more [child epics](manage_epics.md#multi-level-child-epics). Ultimate only.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD graph TD
accTitle: Epics and issues
accDescr: How issues and child epics relate to parent epics
Parent_epic --> Issue1 Parent_epic --> Issue1
Parent_epic --> Child_epic Parent_epic --> Child_epic
Child_epic --> Issue2 Child_epic --> Issue2
......
...@@ -28,7 +28,10 @@ portfolio management, see ...@@ -28,7 +28,10 @@ portfolio management, see
With epics, you can achieve the following hierarchy: With epics, you can achieve the following hierarchy:
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD graph TD
accTitle: Hierarchies with epics
accDescr: Use epics to link projects, issues, and groups
Group_epic --> Project1_Issue1 Group_epic --> Project1_Issue1
Group_epic --> Project1_Issue2 Group_epic --> Project1_Issue2
Group_epic --> Project2_Issue1 Group_epic --> Project2_Issue1
...@@ -48,6 +51,7 @@ Image below was generated with the following Mermaid code. ...@@ -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. Attached as an image because a rendered diagram doesn't look clear on the docs page.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
classDiagram classDiagram
direction TD direction TD
class Epic class Epic
......
...@@ -142,7 +142,7 @@ group overage claim attribute in the SAML response. Then group memberships must ...@@ -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 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 [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) [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 When the integration processes Group Sync, only Group Links configured with
group unique identifiers (like `12345678-9abc-def0-1234-56789abcde`) are supported. group unique identifiers (like `12345678-9abc-def0-1234-56789abcde`) are supported.
...@@ -249,6 +249,7 @@ For example, in the following diagram: ...@@ -249,6 +249,7 @@ For example, in the following diagram:
not yet signed in. not yet signed in.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB graph TB
subgraph SAML users subgraph SAML users
SAMLUserA[Sidney Jones] SAMLUserA[Sidney Jones]
...@@ -274,6 +275,7 @@ graph TB ...@@ -274,6 +275,7 @@ graph TB
``` ```
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TB graph TB
subgraph GitLab users subgraph GitLab users
GitLabUserA[Sidney Jones] GitLabUserA[Sidney Jones]
...@@ -283,9 +285,9 @@ graph TB ...@@ -283,9 +285,9 @@ graph TB
end end
subgraph GitLab groups subgraph GitLab groups
GitLabGroupA["Group A (SAML configured)"] --> GitLabGroupB["Group B (SAML Group Link not configured)"] GitLabGroupA["Group A<br> (SAML configured)"] --> GitLabGroupB["Group B<br> (SAML Group Link not configured)"]
GitLabGroupA --> GitLabGroupC["Group C (SAML Group Link configured)"] GitLabGroupA --> GitLabGroupC["Group C<br> (SAML Group Link configured)"]
GitLabGroupA --> GitLabGroupD["Group D (SAML Group Link configured)"] GitLabGroupA --> GitLabGroupD["Group D<br> (SAML Group Link configured)"]
end end
GitLabGroupB --> |Member|GitLabUserA GitLabGroupB --> |Member|GitLabUserA
...@@ -308,9 +310,9 @@ graph TB ...@@ -308,9 +310,9 @@ graph TB
subgraph GitLab groups after Alex Garcia signs in subgraph GitLab groups after Alex Garcia signs in
GitLabGroupA[Group A] GitLabGroupA[Group A]
GitLabGroupA["Group A (SAML configured)"] --> GitLabGroupB["Group B (SAML Group Link not configured)"] GitLabGroupA["Group A<br> (SAML configured)"] --> GitLabGroupB["Group B<br> (SAML Group Link not configured)"]
GitLabGroupA --> GitLabGroupC["Group C (SAML Group Link configured)"] GitLabGroupA --> GitLabGroupC["Group C<br> (SAML Group Link configured)"]
GitLabGroupA --> GitLabGroupD["Group D (SAML Group Link configured)"] GitLabGroupA --> GitLabGroupD["Group D<br> (SAML Group Link configured)"]
end end
GitLabGroupB --> |Member|GitLabUserA GitLabGroupB --> |Member|GitLabUserA
......
...@@ -35,7 +35,11 @@ Indirect membership can be inherited, shared, or inherited shared. ...@@ -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. | | [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 ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
flowchart RL flowchart RL
accTitle: Membership types
accDescr: Describes membership types and their inheritance
subgraph Group A subgraph Group A
A(Direct member) A(Direct member)
B{{Shared member}} B{{Shared member}}
...@@ -397,7 +401,10 @@ In the following example, `User` is a: ...@@ -397,7 +401,10 @@ In the following example, `User` is a:
- Indirect inherited member of `subsubgroup-2` and `subsubgroup-3`. - Indirect inherited member of `subsubgroup-2` and `subsubgroup-3`.
```mermaid ```mermaid
%%{init: { "fontFamily": "GitLab Sans" }}%%
graph TD graph TD
accTitle: Diagram of group inheritance
accDescr: User inheritance, both direct and indirect through subgroups
classDef user stroke:green,color:green; classDef user stroke:green,color:green;
root --> subgroup --> subsubgroup root --> subgroup --> subsubgroup
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册