Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
aa1163eb
Commit
aa1163eb
authored
Nov 09, 2021
by
Marcin Sedlak-Jakubowski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Format examples as code blocks for easier copying
parent
e9c593c3
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
1 deletion
+5
-1
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+5
-1
No files found.
doc/development/documentation/styleguide/index.md
View file @
aa1163eb
...
@@ -1055,15 +1055,19 @@ Guidance for each individual UI element is in [the word list](word_list.md).
...
@@ -1055,15 +1055,19 @@ Guidance for each individual UI element is in [the word list](word_list.md).
To be consistent, use this format when you write navigation steps in a task topic.
To be consistent, use this format when you write navigation steps in a task topic.
```
markdown
1.
On the top bar, select
**Menu > Projects**
and find your project.
1.
On the top bar, select
**Menu > Projects**
and find your project.
1.
On the left sidebar, select
**Settings > CI/CD**
.
1.
On the left sidebar, select
**Settings > CI/CD**
.
1.
Expand
**General pipelines**
.
1.
Expand
**General pipelines**
.
```
Another example:
Another example:
```
markdown
1.
On the top bar, select
**Menu > Groups**
and find your group.
1.
On the top bar, select
**Menu > Groups**
and find your group.
1.
On the left sidebar, select
**Settings > CI/CD**
.
1.
On the left sidebar, select
**Settings > CI/CD**
.
1.
Expand
**General pipelines**
.
1.
Expand
**General pipelines**
.
```
An Admin Area example:
An Admin Area example:
...
@@ -1092,7 +1096,7 @@ For example:
...
@@ -1092,7 +1096,7 @@ For example:
If the UI text sufficiently explains the fields in a section, do not include a task step for every field.
If the UI text sufficiently explains the fields in a section, do not include a task step for every field.
Instead, summarize multiple fields in a single task step.
Instead, summarize multiple fields in a single task step.
Use the phrase
**Complete the fields**
.
Use the phrase
**Complete the fields**
.
For example:
For example:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment