Commit 84999efd authored by Craig Norris's avatar Craig Norris Committed by Mike Lewis

Docs: Guide update to avoid newlines in products

parent 296c0cf9
...@@ -1368,7 +1368,35 @@ versions back, you can consider removing the text if it's irrelevant or confusin ...@@ -1368,7 +1368,35 @@ versions back, you can consider removing the text if it's irrelevant or confusin
For example, if the current major version is 12.x, version text referencing versions of GitLab 8.x For example, if the current major version is 12.x, version text referencing versions of GitLab 8.x
and older are candidates for removal if necessary for clearer or cleaner docs. and older are candidates for removal if necessary for clearer or cleaner docs.
## Product badges ## Products and features
Refer to the information in this section when describing products and features
within the GitLab product documentation.
### Avoid line breaks in names
When entering a product or feature name that includes a space (such as
GitLab Community Edition) or even other companies' products (such as
Amazon Web Services), be sure to not split the product or feature name across
lines with an inserted line break. Splitting product or feature names across
lines makes searching for these items more difficult, and can cause problems if
names change.
For example, the followng Markdown content is *not* formatted correctly:
```markdown
When entering a product or feature name that includes a space (such as GitLab
Community Edition), don't split the product or feature name across lines.
```
Instead, it should appear similar to the following:
```markdown
When entering a product or feature name that includes a space (such as
GitLab Community Edition), don't split the product or feature name across lines.
```
### Product badges
When a feature is available in EE-only tiers, add the corresponding tier according to the When a feature is available in EE-only tiers, add the corresponding tier according to the
feature availability: feature availability:
...@@ -1408,7 +1436,7 @@ For example: ...@@ -1408,7 +1436,7 @@ For example:
The absence of tiers' mentions mean that the feature is available in GitLab Core, The absence of tiers' mentions mean that the feature is available in GitLab Core,
GitLab.com Free, and all higher tiers. GitLab.com Free, and all higher tiers.
### How it works #### How it works
Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/244), Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/244),
the special markup `**(STARTER)**` will generate a `span` element to trigger the the special markup `**(STARTER)**` will generate a `span` element to trigger the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment