diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-01-24 15:10:54 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-01-24 15:10:54 +0300 |
| commit | 4d3bbc4990ead10831a087cece3ccdd25dc4f0b4 (patch) | |
| tree | d6daa91eaae8318b7b26bc1b9bfbbb8f7a295da0 /doc/development/documentation | |
| parent | 94df43c8c19e64afb29e8491b92c3d258f6814ea (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/styleguide/index.md | 9 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide/word_list.md | 4 |
2 files changed, 5 insertions, 8 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 1d9d1528784..c4dd7132dff 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -320,10 +320,11 @@ create an issue or an MR to propose a change to the user interface text. #### Feature names - Feature names are typically lowercase. -- Some features are capitalized, typically nouns that name GitLab-specific - capabilities or tools. - -See the [word list](word_list.md) for details. +- Some features require title case, typically nouns that name GitLab-specific capabilities or tools. Features requiring + title case should be: + - Added as a proper name to markdownlint [configuration](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.markdownlint.yml), + so that it can be consistently applied across all documentation. + - Added to the [word list](word_list.md). If the term is not in the word list, ask a GitLab Technical Writer for advice. diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index dc3dcba0c95..2e6e591e4ec 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -883,10 +883,6 @@ Instead of: Do not use **utilize**. Use **use** instead. It's more succinct and easier for non-native English speakers to understand. ([Vale](../testing.md#vale) rule: [`SubstitutionSuggestions.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionSuggestions.yml)) -## Value Stream Analytics - -Use title case for **Value Stream Analytics**. - ## via Do not use Latin abbreviations. Use **with**, **through**, or **by using** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml)) |