Commit 70da6178 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'russell/development-guide-future-tense-2' into 'master'

Remove more instances of future tense from Development Guide

See merge request gitlab-org/gitlab!49888
parents 0c7f16fd be5cc2b1
...@@ -468,7 +468,7 @@ Enterprise Edition instance. This has some implications: ...@@ -468,7 +468,7 @@ Enterprise Edition instance. This has some implications:
1. Similarly, if you need to remove a worker, stop it from being scheduled in 1. Similarly, if you need to remove a worker, stop it from being scheduled in
one release, then remove it in the next. This allows existing jobs to one release, then remove it in the next. This allows existing jobs to
execute. execute.
1. Don't forget, not every instance will upgrade to every intermediate version 1. Don't forget, not every instance is upgraded to every intermediate version
(some people may go from X.1.0 to X.10.0, or even try bigger upgrades!), so (some people may go from X.1.0 to X.10.0, or even try bigger upgrades!), so
try to be liberal in accepting the old format if it is cheap to do so. try to be liberal in accepting the old format if it is cheap to do so.
1. **Cached values** may persist across releases. If you are changing the type a 1. **Cached values** may persist across releases. If you are changing the type a
...@@ -480,12 +480,12 @@ Enterprise Edition instance. This has some implications: ...@@ -480,12 +480,12 @@ Enterprise Edition instance. This has some implications:
1. Try to avoid that, and add to `ApplicationSetting` instead. 1. Try to avoid that, and add to `ApplicationSetting` instead.
1. Ensure that it is also 1. Ensure that it is also
[added to Omnibus](https://docs.gitlab.com/omnibus/settings/gitlab.yml.html#adding-a-new-setting-to-gitlab-yml). [added to Omnibus](https://docs.gitlab.com/omnibus/settings/gitlab.yml.html#adding-a-new-setting-to-gitlab-yml).
1. **Filesystem access** can be slow, so try to avoid 1. **File system access** can be slow, so try to avoid
[shared files](shared_files.md) when an alternative solution is available. [shared files](shared_files.md) when an alternative solution is available.
### Review turnaround time ### Review turnaround time
Since [unblocking others is always a top priority](https://about.gitlab.com/handbook/values/#global-optimization), Because [unblocking others is always a top priority](https://about.gitlab.com/handbook/values/#global-optimization),
reviewers are expected to review assigned merge requests in a timely manner, reviewers are expected to review assigned merge requests in a timely manner,
even when this may negatively impact their other tasks and priorities. even when this may negatively impact their other tasks and priorities.
......
...@@ -121,7 +121,7 @@ module Gitlab ...@@ -121,7 +121,7 @@ module Gitlab
end end
``` ```
Now the cop won't complain. Here's a bad example which we could rewrite: Now the cop doesn't complain. Here's a bad example which we could rewrite:
``` ruby ``` ruby
module SpamCheckService module SpamCheckService
...@@ -213,14 +213,14 @@ module M ...@@ -213,14 +213,14 @@ module M
end end
``` ```
Note that you need to enable it at some point, otherwise everything below Note that you need to enable it at some point, otherwise nothing below
won't be checked. that point is checked.
## Things we might need to ignore right now ## Things we might need to ignore right now
Because of the way Rails helpers and mailers work, we might not be able to Because of the way Rails helpers and mailers work, we might not be able to
avoid the use of instance variables there. For those cases, we could ignore avoid the use of instance variables there. For those cases, we could ignore
them at the moment. At least we're not going to share those modules with them at the moment. Those modules are not shared with
other random objects, so they're still somewhat isolated. other random objects, so they're still somewhat isolated.
## Instance variables in views ## Instance variables in views
......
...@@ -138,7 +138,7 @@ the model/service. ...@@ -138,7 +138,7 @@ the model/service.
- `with_reactive_cache` must be called where the result of `calculate_reactive_cache` - `with_reactive_cache` must be called where the result of `calculate_reactive_cache`
is required. is required.
- A block can be given to `with_reactive_cache`. `with_reactive_cache` can also take - A block can be given to `with_reactive_cache`. `with_reactive_cache` can also take
any number of arguments. Any arguments passed to `with_reactive_cache` will be any number of arguments. Any arguments passed to `with_reactive_cache` are
passed to `calculate_reactive_cache`. The arguments passed to `with_reactive_cache` passed to `calculate_reactive_cache`. The arguments passed to `with_reactive_cache`
are appended to the cache key name. are appended to the cache key name.
- If `with_reactive_cache` is called when the result has already been cached, the - If `with_reactive_cache` is called when the result has already been cached, the
......
...@@ -100,7 +100,7 @@ Refer to [`override.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gi ...@@ -100,7 +100,7 @@ Refer to [`override.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gi
end end
``` ```
Note that the check will only happen when either: Note that the check only happens when either:
- The overriding method is defined in a class, or: - The overriding method is defined in a class, or:
- The overriding method is defined in a module, and it's prepended to - The overriding method is defined in a module, and it's prepended to
......
...@@ -15,7 +15,7 @@ This is a guide for how to get a Windows development virtual machine on Google C ...@@ -15,7 +15,7 @@ This is a guide for how to get a Windows development virtual machine on Google C
Use of Microsoft Windows operating systems on company laptops is banned under GitLab's [Approved Operating Systems policy](https://about.gitlab.com/handbook/security/approved_os.html#windows). Use of Microsoft Windows operating systems on company laptops is banned under GitLab's [Approved Operating Systems policy](https://about.gitlab.com/handbook/security/approved_os.html#windows).
This can make it difficult to develop features for the Windows platforms. Using GCP will allow us to have a temporary Windows machine that can be removed once we're done with it. This can make it difficult to develop features for the Windows platforms. Using GCP allows us to have a temporary Windows machine that can be removed once we're done with it.
## Shared Windows runners ## Shared Windows runners
...@@ -74,7 +74,7 @@ Build a Google Cloud image with the above shared runners repository by doing the ...@@ -74,7 +74,7 @@ Build a Google Cloud image with the above shared runners repository by doing the
1. Click **Set Windows password**. 1. Click **Set Windows password**.
1. Optional: Set a username or use default. 1. Optional: Set a username or use default.
1. Click **Next**. 1. Click **Next**.
1. Copy and save the password as it won't be shown again. 1. Copy and save the password as it is not shown again.
1. Click **RDP** down arrow. 1. Click **RDP** down arrow.
1. Click **Download the RDP file**. 1. Click **Download the RDP file**.
1. Open the downloaded RDP file with the Windows remote desktop app (<https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients>). 1. Open the downloaded RDP file with the Windows remote desktop app (<https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients>).
...@@ -98,8 +98,8 @@ Here are a few tips on GCP and Windows. ...@@ -98,8 +98,8 @@ Here are a few tips on GCP and Windows.
### GCP cost savings ### GCP cost savings
To minimise the cost of your GCP VM instance, stop it when you're not using it. To minimize the cost of your GCP VM instance, stop it when you're not using it.
If you do, you'll need to re-download the RDP file from the console as the IP If you do, you must download the RDP file again from the console as the IP
address changes every time you stop and start it. address changes every time you stop and start it.
### chocolatey ### chocolatey
......
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