Reference topic type
Reference information should be in an easily-scannable format, like a table or list. It’s similar to a dictionary or encyclopedia entry.
Format
Reference topics should be in this format:
title: Title (a noun, like "Pipeline settings" or "Administrator options")
---
Introductory sentence.
| Setting | Description |
|---------|-------------|
| **Name** | Descriptive sentence about the setting. |
Reference topic titles
Reference topic titles are usually nouns.
Avoid these topic titles:
Important notes
. Instead, incorporate this information closer to where it belongs. For example, this information might be a prerequisite for a task, or information about a concept.Limitations
. Instead, move the content near other similar information. If you must, you can use the titleKnown issues
.
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support