summaryrefslogtreecommitdiff
path: root/doc/development/gitlab_flavored_markdown
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-05-09 15:07:50 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2022-05-09 15:07:50 +0000
commitfb19b392e2331e7663c3d65c05aeb81a1db3630d (patch)
treeedec8b9bfc56a39279df88578ccb6da5ca4783b4 /doc/development/gitlab_flavored_markdown
parente4b9c52cc9ca9478d9881d03f31517be46376060 (diff)
downloadgitlab-ce-fb19b392e2331e7663c3d65c05aeb81a1db3630d.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/gitlab_flavored_markdown')
-rw-r--r--doc/development/gitlab_flavored_markdown/specification_guide/index.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/development/gitlab_flavored_markdown/specification_guide/index.md b/doc/development/gitlab_flavored_markdown/specification_guide/index.md
index 5af642a52ce..397d555c54f 100644
--- a/doc/development/gitlab_flavored_markdown/specification_guide/index.md
+++ b/doc/development/gitlab_flavored_markdown/specification_guide/index.md
@@ -476,10 +476,12 @@ code. It contains only shell scripting commands for the relevant
```mermaid
graph LR
-subgraph script:
- A{run-snapshopt-tests.sh} --> B
+subgraph tests:
B[relevant rspec+jest test files]
end
+subgraph script:
+ A{run-snapshopt-tests.sh} -->|invokes| B
+end
subgraph input:<br/>YAML
C[examples_index.yml] --> B
D[markdown.yml] --> B
@@ -487,7 +489,7 @@ subgraph input:<br/>YAML
F[prosemirror_json.yml] --> B
end
subgraph output:<br/>test results/output
- B --> G[rspec/jest output]
+ B --> H[rspec+jest output]
end
```
@@ -534,7 +536,7 @@ is the manually updated canonical Markdown+HTML examples for GLFM extensions.
each of which contain a Markdown example and the corresponding canonical HTML.
- The `update-specification.rb` script inserts it as new sections before the appendix
of generated `spec.txt`.
-- It should consist of `H1` header sections, with a examples nested exactly 2 levels deep within `H2`
+- It should consist of `H1` header sections, with all examples nested exactly 2 levels deep within `H2`
header sections.
`glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt` sample entries: