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
1f5356e9
Commit
1f5356e9
authored
Jul 12, 2021
by
Kati Paizee
Committed by
Suzanne Selhorn
Jul 12, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update tutorial guidance
parent
8c796cd6
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
2 deletions
+9
-2
doc/development/documentation/structure.md
doc/development/documentation/structure.md
+9
-2
No files found.
doc/development/documentation/structure.md
View file @
1f5356e9
...
...
@@ -164,8 +164,15 @@ In most cases, these pages are standalone.
### Tutorials
A tutorial is an end-to-end walkthrough of a complex workflow or scenario.
It might include tasks across a variety of GitLab features, tools, and processes.
It does not cover core conceptual information.
In general, you might consider using a tutorial when:
-
The workflow requires a number of sequential steps where each step consists
of sub-steps.
-
The steps cover a variety of GitLab features or third-party tools.
Tutorials are learning aids that complement our core documentation.
They do not introduce new features.
Always use the primary
[
topic types
](
#documentation-topic-types
)
to document new features.
Tutorials should be in this format:
...
...
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