diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index 4d95a61176ba7085fe7192e6a0a9bb32ea86c22a..d4b4bdf11f460ffe06fde73e88abac64d9ce4801 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -166,7 +166,7 @@ that can also be promoted in case of disaster. ## Deviating from the suggested reference architectures -As a general rule of thumb, the further away you move from the Reference Architectures, +As a general guideline, the further away you move from the Reference Architectures, the harder it will be get support for it. With any deviation, you're introducing a layer of complexity that will add challenges to finding out where potential issues might lie. diff --git a/doc/development/fe_guide/vue.md b/doc/development/fe_guide/vue.md index ab808e6f1b7fb402fcd0967d31bb7728c2fdd39e..b947d90cc112db41818229e3d9a38ea80196c50b 100644 --- a/doc/development/fe_guide/vue.md +++ b/doc/development/fe_guide/vue.md @@ -308,7 +308,7 @@ This folder holds all components that are specific to this new feature. If you need to use or create a component that is likely to be used somewhere else, please refer to `vue_shared/components`. -A good rule of thumb to know when you should create a component is to think if +A good guideline to know when you should create a component is to think if it could be reusable elsewhere. For example, tables are used in a quite amount of places across GitLab, a table @@ -336,7 +336,7 @@ In the [Vue documentation](https://vuejs.org/v2/api/#Options-Data) the Data func > The data object for the Vue instance. Vue recursively converts its properties into getter/setters to make it "reactive". The object must be plain: native objects such as browser API objects and -prototype properties are ignored. A rule of thumb is that data should just be data - it is not +prototype properties are ignored. A guideline is that data should just be data - it is not recommended to observe objects with their own stateful behavior. Based on the Vue guidance: diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 8aa7ca511c4b6b85f4ce870e53aec02166c2d507..037fbd7063d4de7ae0fbcbd359254b9931efb79a 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -57,7 +57,7 @@ Redis version 6.0 or higher is recommended, as this is what ships with ### Storage -The necessary hard drive space largely depends on the size of the repositories you want to store in GitLab but as a *rule of thumb* you should have at least as much free space as all your repositories combined take up. +The necessary hard drive space largely depends on the size of the repositories you want to store in GitLab but as a *guideline* you should have at least as much free space as all your repositories combined take up. The Omnibus GitLab package requires about 2.5 GB of storage space for installation. diff --git a/doc/update/zero_downtime.md b/doc/update/zero_downtime.md index 244b558d375cfc0569b1996983409a05ebe8c87f..13658e6071b5b4612e50305c4c45f82d2473f846 100644 --- a/doc/update/zero_downtime.md +++ b/doc/update/zero_downtime.md @@ -56,7 +56,7 @@ increasing the number of Sidekiq workers that can process jobs in the `background_migration` queue. To see the size of this queue, [Check for background migrations before upgrading](index.md#checking-for-background-migrations-before-upgrading). -As a rule of thumb, any database smaller than 10 GB doesn't take too much time to +As a guideline, any database smaller than 10 GB doesn't take too much time to upgrade; perhaps an hour at most per minor release. Larger databases however may require more time, but this is highly dependent on the size of the database and the migrations that are being performed.