diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-09-20 02:18:09 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-09-20 02:18:09 +0300 |
commit | 6ed4ec3e0b1340f96b7c043ef51d1b33bbe85fde (patch) | |
tree | dc4d20fe6064752c0bd323187252c77e0a89144b /doc/development/documentation/topic_types/reference.md | |
parent | 9868dae7fc0655bd7ce4a6887d4e6d487690eeed (diff) |
Add latest changes from gitlab-org/gitlab@15-4-stable-eev15.4.0-rc42
Diffstat (limited to 'doc/development/documentation/topic_types/reference.md')
-rw-r--r-- | doc/development/documentation/topic_types/reference.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/development/documentation/topic_types/reference.md b/doc/development/documentation/topic_types/reference.md new file mode 100644 index 00000000000..42f4f5f6f94 --- /dev/null +++ b/doc/development/documentation/topic_types/reference.md @@ -0,0 +1,32 @@ +--- +stage: none +group: Style Guide +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# 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. + +```markdown +# Title (a noun, like "Pipeline settings" or "Administrator options") + +Introductory sentence. + +| Setting | Description | +|---------|-------------| +| **Name** | Descriptive sentence about the setting. | +``` + +## Reference headings + +Reference headings are usually nouns. + +Avoid these heading 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 title `Known issues`. |