diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-20 12:06:01 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-20 12:06:01 +0000 |
commit | a68e9d3318c6847436f81f83eb347b29f52d1bff (patch) | |
tree | 511a790297f7e771f8d73025b9a1f9b4a0586d71 /doc | |
parent | 7bc0aff0b4e15fce828621d7e0919d84368f3d2b (diff) | |
download | gitlab-ce-a68e9d3318c6847436f81f83eb347b29f52d1bff.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/gitaly/praefect.md | 8 | ||||
-rw-r--r-- | doc/user/application_security/security_dashboard/index.md | 2 | ||||
-rw-r--r-- | doc/user/markdown.md | 17 |
3 files changed, 15 insertions, 12 deletions
diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 667fd48a91c..1c01f3cebd5 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -20,11 +20,10 @@ for updates and roadmap. ### Architecture -For this document, the following network topology is assumed: +The most common architecture for Praefect is simplified in the diagram below: ```mermaid graph TB - GitLab --> Gitaly; GitLab --> Praefect; Praefect --> Gitaly-1; Praefect --> Gitaly-2; @@ -32,9 +31,8 @@ graph TB ``` Where `GitLab` is the collection of clients that can request Git operations. -`Gitaly` is a Gitaly server before using Praefect. The Praefect node has three -storage nodes attached. Praefect itself doesn't store data, but connects to -three Gitaly nodes, `Praefect-Gitaly-1`, `Praefect-Gitaly-2`, and `Praefect-Gitaly-3`. +The Praefect node has threestorage nodes attached. Praefect itself doesn't +store data, but connects to three Gitaly nodes, `Gitaly-1`, `Gitaly-2`, and `Gitaly-3`. Praefect may be enabled on its own node or can be run on the GitLab server. In the example below we will use a separate server, but the optimal configuration diff --git a/doc/user/application_security/security_dashboard/index.md b/doc/user/application_security/security_dashboard/index.md index 688d231d568..7eb0d649648 100644 --- a/doc/user/application_security/security_dashboard/index.md +++ b/doc/user/application_security/security_dashboard/index.md @@ -71,7 +71,7 @@ Once you're on the dashboard, at the top you should see a series of filters for: - Report type - Project -To the right of the filters, you should see a **Hide dismissed** toggle button ([available in GitLab Ultimate 12.5](https://gitlab.com/gitlab-org/gitlab/issues/9102)). +To the right of the filters, you should see a **Hide dismissed** toggle button ([available for GitLab.com Gold, planned for GitLab Ultimate 12.6](https://gitlab.com/gitlab-org/gitlab/issues/9102)). NOTE: **Note:** The dashboard only shows projects with [security reports](#supported-reports) enabled in a group. diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 3bd0dcafc19..0696b47ad9e 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -90,7 +90,7 @@ It makes use of [new markdown features](#new-GFM-markdown-extensions), not found in standard markdown: - [Color "chips" written in HEX, RGB or HSL](#colors) -- [Diagrams and flowcharts using Mermaid](#diagrams-and-flowcharts-using-mermaid) +- [Diagrams and flowcharts](#diagrams-and-flowcharts) - [Emoji](#emoji) - [Front matter](#front-matter) - [Inline diffs](#inline-diff) @@ -151,13 +151,16 @@ Color written inside backticks will be followed by a color "chip": `HSL(540,70%,50%)` `HSLA(540,70%,50%,0.3)` -### Diagrams and flowcharts using Mermaid +### Diagrams and flowcharts + +It is possible to generate diagrams and flowcharts from text in GitLab using [Mermaid](https://mermaidjs.github.io/) or [PlantUML](http://plantuml.com). + +#### Mermaid > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15107) in GitLab 10.3. -It is possible to generate diagrams and flowcharts from text using [Mermaid](https://mermaidjs.github.io/). -Visit the official page for more details. +Visit the [official page](https://mermaidjs.github.io/) for more details. In order to generate a diagram or flowchart, you should write your text inside the `mermaid` block: @@ -179,8 +182,6 @@ graph TD; C-->D; ``` -#### Subgraphs - Subgraphs can also be included: ~~~ @@ -219,6 +220,10 @@ graph TB end ``` +#### PlantUML + +To make PlantUML available in GitLab, a GitLab administrator needs to enable it first. Read more in [PlantUML & GitLab](../administration/integration/plantuml.md). + ### Emoji > If this is not rendered correctly, [view it in GitLab itself](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md#emoji). |