Help us learn about your current experience with the documentation.
Take the survey.
Glossary topic typeA glossary provides a list of unfamiliar terms and their definitions to help users understand a specific GitLab feature.
Each glossary item provides a single term and its associated definition. The definition should answer the questions:
For glossary terms:
Glossaries should provide short, concise term-definition pairs.
Glossary topics should be in this format. Use a description list primarily. You can use a table if you need to apply additional categorization.
Try to include glossary topics on pages that explain the feature, rather than as a standalone page.
## FeatureName glossary
This glossary provides definitions for terms related to FeatureName.
Term A
: Term A does this thing.
Term B
: Term B does this thing.
Term C
: Term C does this thing.
If you use the table format:
## FeatureName glossary
This glossary provides definitions for terms related to FeatureName.
| Term | Definition | Additional category |
|--------|-------------------------|---------------------|
| Term A | Term A does this thing. | |
| Term B | Term B does this thing. | |
| Term C | Term C does this thing. | |
Glossary topic titles
Use FeatureName glossary
.
Don’t use alternatives to glossary
. For example:
Terminology
Glossary of terms
Glossary of common terms
Definitions
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4