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
3e3cf1fc
Commit
3e3cf1fc
authored
Feb 08, 2022
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add CTRT abbreviation for SEO purposes
parent
354d1cce
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
4 deletions
+4
-4
doc/development/documentation/structure.md
doc/development/documentation/structure.md
+4
-4
No files found.
doc/development/documentation/structure.md
View file @
3e3cf1fc
...
...
@@ -5,10 +5,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w
description
:
What to include in GitLab documentation pages.
---
# Documentation topic types
# Documentation topic types
(CTRT)
At GitLab, we have not traditionally used types for our content. However, we are starting to
move in this direction, and we now use four primary topic types:
move in this direction, and we now use four primary topic types
(CTRT)
:
-
[
Concept
](
#concept
)
-
[
Task
](
#task
)
...
...
@@ -154,7 +154,7 @@ If multiple causes or workarounds exist, consider putting them into a table form
## Other types of content
There are other types of content in the GitLab documentation that don't
classify as one of the four primary
[
topic types
](
#documentation-topic-types
)
.
classify as one of the four primary
[
topic types
](
#documentation-topic-types
-ctrt
)
.
These include:
-
[
Tutorials
](
#tutorials
)
...
...
@@ -174,7 +174,7 @@ In general, you might consider using a tutorial when:
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.
Always use the primary
[
topic types
](
#documentation-topic-types
-ctrt
)
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