Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-11-21 03:14:37 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-11-21 03:14:37 +0300
commitb605abacd983a19c30dc364e8014fc758f496e98 (patch)
tree783eac05129bad193709909307d09ab2960793e7 /doc/development/documentation/styleguide
parent235f755398a6a199b22e4924e7a81670b0dfdaef (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r--doc/development/documentation/styleguide/word_list.md55
1 files changed, 47 insertions, 8 deletions
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md
index cf9a22e8a86..0159ae7e06e 100644
--- a/doc/development/documentation/styleguide/word_list.md
+++ b/doc/development/documentation/styleguide/word_list.md
@@ -50,7 +50,7 @@ Don't use backticks.
Spell out **two-factor authentication** in sentence case for the first use and in topic titles, and **2FA**
thereafter. If the first word in a sentence, do not capitalize `factor` or `authentication`. For example:
-- Two-factor authentication (2FA) helps secure your account. Set up 2FA when you first log in.
+- Two-factor authentication (2FA) helps secure your account. Set up 2FA when you first sign in.
## above
@@ -509,6 +509,13 @@ To be more upbeat and precise, do not use **downgrade**. Focus instead on the ac
- For changing to earlier GitLab versions, use [**roll back**](#roll-back).
- For changing to lower GitLab tiers, use **change the subscription tier**.
+## download
+
+Use **download** to describe saving data to a user's device. For details, see
+[the Microsoft style guide](https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/d/download).
+
+Do not confuse download with [export](#export).
+
## dropdown list
Use **dropdown list** to refer to the UI element. Do not use **dropdown** without **list** after it.
@@ -618,6 +625,22 @@ Use uppercase for **Experiment**. For example: **The XYZ feature is an Experimen
You might also want to link to [this section](../../../policy/experiment-beta-support.md#experiment)
in the handbook when writing about Experiment features.
+## export
+
+Use **export** to indicate translating raw data,
+which is not represented by a file in GitLab, into a standard file format.
+
+You can differentiate **export** from **download** because:
+
+- Often, you can use export options to change the output.
+- Exported data is not necessarily downloaded to a user's device.
+
+For example:
+
+- Export the contents of your report to CSV format.
+
+Do not confuse with [download](#download).
+
## FAQ
We want users to find information quickly, and they rarely search for the term **FAQ**.
@@ -970,7 +993,15 @@ Do not use **limitations**. Use **known issues** instead.
## log in, log on
-Do not use **log in** or **log on**. Use [sign in](#sign-in-sign-in) instead. If the user interface has **Log in**, you can use it.
+Do not use:
+
+- **log in**.
+- **log on**.
+- **login**
+
+Use [sign in](#sign-in-sign-in) instead.
+
+However, if the user interface has **Log in**, you should match the UI.
## logged-in user, logged in user
@@ -1529,16 +1560,24 @@ Use **setup** as a noun, and **set up** as a verb. For example:
## sign in, sign-in
-Use **sign in** or **sign in to** as a verb to describe the action of signing in.
+To describe the action of signing in, use:
+
+- **sign in**.
+- **sign in to** as a verb. For example: Use your password to sign in to GitLab.
-Do not use **sign on** or **sign into**, or **log on**, **log in**, or **log into**.
+You can also use:
-If the user interface has different words, use those.
+- **sign-in** as a noun or adjective. For example: **sign-in page** or
+ **sign-in restrictions**.
+- **single sign-on**.
+
+Do not use:
-You can use **sign-in** as a noun or adjective. For example, **sign-in page** or
-**sign-in restrictions**.
+- **sign on**.
+- **sign into**.
+- [**log on**, **log in**, or **log into**](#log-in-log-on).
-You can use **single sign-on**.
+If the user interface has different words, you can use those.
## sign up