From 345a2e779730cb6f7d589b3875ba6ee40b9712c6 Mon Sep 17 00:00:00 2001
From: Uma Chandran <uchandran@gitlab.com>
Date: Tue, 4 Mar 2025 17:02:24 +0000
Subject: [PATCH] Fixes usage of "since"
Based on the docs style guide, replace "since" with "because" where appropriate.
---
doc/administration/sidekiq/_index.md | 2 +-
doc/administration/silent_mode/_index.md | 2 +-
doc/api/packages/rubygems.md | 2 +-
doc/ci/caching/_index.md | 2 +-
doc/ci/docker/buildah_rootless_tutorial.md | 4 ++--
doc/ci/environments/_index.md | 4 ++--
doc/ci/environments/deployments.md | 2 +-
doc/ci/examples/deployment/composer-npm-deploy.md | 5 +++--
doc/ci/examples/php.md | 2 +-
doc/ci/interactive_web_terminal/_index.md | 2 +-
10 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/doc/administration/sidekiq/_index.md b/doc/administration/sidekiq/_index.md
index 11c09d01a4dac..501639bc66b65 100644
--- a/doc/administration/sidekiq/_index.md
+++ b/doc/administration/sidekiq/_index.md
@@ -31,7 +31,7 @@ By default, GitLab uses UNIX sockets and is not set up to communicate via TCP. T
# Make Gitaly accept connections on all network interfaces
listen_addr: '0.0.0.0:8075',
auth: {
- ## Set up the Gitaly token as a form of authentication since you are accessing Gitaly over the network
+ ## Set up the Gitaly token as a form of authentication because you are accessing Gitaly over the network
## https://docs.gitlab.com/ee/administration/gitaly/configure_gitaly.html#about-the-gitaly-token
token: 'abc123secret',
},
diff --git a/doc/administration/silent_mode/_index.md b/doc/administration/silent_mode/_index.md
index 7c9ead3123958..71270d00d8241 100644
--- a/doc/administration/silent_mode/_index.md
+++ b/doc/administration/silent_mode/_index.md
@@ -26,7 +26,7 @@ Silent Mode allows you to silence outbound communication, such as emails, from G
[disaster recovery](../geo/disaster_recovery/_index.md) solution. You want to
regularly test promoting it to become a primary Geo site, as a best practice
to ensure your disaster recovery plan actually works. But you don't want to
- actually perform an entire failover, since the primary site lives in a region
+ actually perform an entire failover because the primary site lives in a region
which provides the lowest latency to your users. And you don't want to take
downtime during every regular test. So, you let the primary site remain up,
while you promote the secondary site. You start smoke testing the promoted
diff --git a/doc/api/packages/rubygems.md b/doc/api/packages/rubygems.md
index 83224d43333ef..718825ccb9171 100644
--- a/doc/api/packages/rubygems.md
+++ b/doc/api/packages/rubygems.md
@@ -99,7 +99,7 @@ GET projects/:id/packages/rubygems/api/v1/dependencies
curl --header "Authorization:<personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/rubygems/api/v1/dependencies?gems=my_gem,foo"
```
-This endpoint returns a marshalled array of hashes for all versions of the requested gems. Since the
+This endpoint returns a marshalled array of hashes for all versions of the requested gems. Because the
response is marshalled, you can store it in a file. If Ruby is installed, you can use the following
Ruby command to read the response. For this to work, you must
[set your credentials in `~/.gem/credentials`](../../user/packages/rubygems_registry/_index.md#authenticate-to-the-package-registry):
diff --git a/doc/ci/caching/_index.md b/doc/ci/caching/_index.md
index c83280e65779f..954c92b8339f6 100644
--- a/doc/ci/caching/_index.md
+++ b/doc/ci/caching/_index.md
@@ -408,7 +408,7 @@ default:
- virtualenv venv
- source venv/bin/activate
-variables: # Change pip's cache directory to be inside the project directory since we can only cache local items.
+variables: # Change pip's cache directory to be inside the project directory because we can only cache local items.
PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
test:
diff --git a/doc/ci/docker/buildah_rootless_tutorial.md b/doc/ci/docker/buildah_rootless_tutorial.md
index 569ea976421fb..242c340e477a4 100644
--- a/doc/ci/docker/buildah_rootless_tutorial.md
+++ b/doc/ci/docker/buildah_rootless_tutorial.md
@@ -44,10 +44,10 @@ We start by preparing a custom image based on the `quay.io/buildah/stable:v1.23.
&& echo build:10000:65536 > /etc/subuid \
&& echo build:10000:65536 > /etc/subgid
- # Use chroot since the default runc does not work when running rootless
+ # Use chroot because the default runc does not work when running rootless
RUN echo "export BUILDAH_ISOLATION=chroot" >> /home/build/.bashrc
- # Use VFS since fuse does not work
+ # Use VFS because fuse does not work
RUN mkdir -p /home/build/.config/containers \
&& (echo '[storage]';echo 'driver = "vfs"') > /home/build/.config/containers/storage.conf
diff --git a/doc/ci/environments/_index.md b/doc/ci/environments/_index.md
index 575b37be4908a..42eba56bf8042 100644
--- a/doc/ci/environments/_index.md
+++ b/doc/ci/environments/_index.md
@@ -1021,7 +1021,7 @@ deploy:
environment: production/$ENVIRONMENT
```
-Since `$ENVIRONMENT` variable does not exist in the pipeline, GitLab tries to
+Because the `$ENVIRONMENT` variable does not exist in the pipeline, GitLab tries to
create an environment with a name `production/`, which is invalid in
[the environment name constraint](../yaml/_index.md#environmentname).
@@ -1046,7 +1046,7 @@ review:
When you create a new merge request with a branch name `bug-fix!`,
the `review` job tries to create an environment with `review/bug-fix!`.
However, the `!` is an invalid character for environments, so the
-deployment job fails since it was about to run without an environment.
+deployment job fails because it was about to run without an environment.
To fix this, use one of the following solutions:
diff --git a/doc/ci/environments/deployments.md b/doc/ci/environments/deployments.md
index ac17787235b20..90819c146dd85 100644
--- a/doc/ci/environments/deployments.md
+++ b/doc/ci/environments/deployments.md
@@ -94,7 +94,7 @@ fetch = +refs/environments/*:refs/remotes/origin/environments/*
When a new deployment happens in your project,
GitLab creates [a special Git-ref to the deployment](#check-out-deployments-locally).
-Since these Git-refs are populated from the remote GitLab repository,
+Because these Git-refs are populated from the remote GitLab repository,
you could find that some Git operations, such as `git-fetch` and `git-pull`,
become slower as the number of deployments in your project increases.
diff --git a/doc/ci/examples/deployment/composer-npm-deploy.md b/doc/ci/examples/deployment/composer-npm-deploy.md
index 71275c60ffc2b..48fa902b8b106 100644
--- a/doc/ci/examples/deployment/composer-npm-deploy.md
+++ b/doc/ci/examples/deployment/composer-npm-deploy.md
@@ -76,7 +76,8 @@ In order, this means that:
1. We check if the `ssh-agent` is available and we install it if it's not.
1. We create the `~/.ssh` folder.
1. We make sure we're running bash.
-1. We disable host checking (we don't ask for user accept when we first connect to a server, and since every job equals a first connect, we need this).
+1. We disable host checking (we don't ask the user to accept when we first connect to a server and,
+ because every job equals a first connect, we need this).
And this is basically all you need in the `before_script` section.
@@ -125,7 +126,7 @@ Therefore, for a production environment we use additional steps to ensure that a
## Where to go next
-Since this was a WordPress project, it includes real code snippets. Some further ideas you can pursue:
+Because this was a WordPress project, it includes real code snippets. Some further ideas you can pursue:
- Having a slightly different script for the default branch allows you to deploy to a production server from that branch and to a stage server from any other branches.
- Instead of pushing it live, you can push it to WordPress official repository.
diff --git a/doc/ci/examples/php.md b/doc/ci/examples/php.md
index e84c7137c428e..4437395dabcf1 100644
--- a/doc/ci/examples/php.md
+++ b/doc/ci/examples/php.md
@@ -192,7 +192,7 @@ phpenv config-add my_config.ini
### Install custom extensions
-Since this is a pretty bare installation of the PHP environment, you may need
+Because this is a pretty bare installation of the PHP environment, you may need
some extensions that are not currently present on the build machine.
To install additional extensions, execute:
diff --git a/doc/ci/interactive_web_terminal/_index.md b/doc/ci/interactive_web_terminal/_index.md
index 1b58ceff46013..66db52b2cc8a3 100644
--- a/doc/ci/interactive_web_terminal/_index.md
+++ b/doc/ci/interactive_web_terminal/_index.md
@@ -14,7 +14,7 @@ title: Interactive web terminals
Interactive web terminals give the user access to a terminal in GitLab for
running one-off commands for their CI pipeline. You can think of it like a method for
-debugging with SSH, but done directly from the job page. Since this is giving the user
+debugging with SSH, but done directly from the job page. Because this is giving the user
shell access to the environment where [GitLab Runner](https://docs.gitlab.com/runner/)
is deployed, some [security precautions](../../administration/integration/terminal.md#security) were
taken to protect the users.
--
GitLab