From 78fa2e63e7b717d2cb1959a064de1e4bfa1c2733 Mon Sep 17 00:00:00 2001 From: Suzanne Selhorn <sselhorn@gitlab.com> Date: Tue, 5 Dec 2023 08:39:34 +0000 Subject: [PATCH] Adding settings, configure, configurations, preferences Related to: https://gitlab.com/gitlab-org/gitlab/-/issues/432480 --- .../documentation/styleguide/word_list.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index 556fba5c69ae8..610328806bc30 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -380,6 +380,18 @@ Use **compute minutes** instead of these (or similar) terms: For more information, see [epic 2150](https://gitlab.com/groups/gitlab-com/-/epics/2150). +## configuration + +When you update a collection of settings, call it a **configuration**. + +## configure + +Use **configure** after a feature or product has been [set up](#setup-set-up). +For example: + +1. Set up your installation. +1. Configure your installation. + ## confirmation dialog Use **confirmation dialog** to describe the dialog that asks you to confirm an action. For example: @@ -1335,6 +1347,10 @@ see the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/a- Use **Premium**, in uppercase, for the subscription tier. When you refer to **Premium** in the context of other subscription tiers, follow [the subscription tier](#subscription-tier) guidance. +## preferences + +Use **preferences** to describe user-specific, system-level settings like theme and layout. + ## prerequisites Use **prerequisites** when documenting the tasks that must be completed or the conditions that must be met before a user can complete a task. Do not use **requirements**. @@ -1556,6 +1572,17 @@ Use **setup** as a noun, and **set up** as a verb. For example: - Your remote office setup is amazing. - To set up your remote office correctly, consider the ergonomics of your work area. +Do not confuse **set up** with [**configure**](#configure). +**Set up** implies that it's the first time you've done something. For example: + +1. Set up your installation. +1. Configure your installation. + +## settings + +A **setting** changes the default behavior of the product. A **setting** consists of a key/value pair, +typically represented by a label with one or more options. + ## sign in, sign-in To describe the action of signing in, use: -- GitLab