Commit a7ea824a authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-fix-whitespace' into 'master'

Remove extra EOL whitespace automatically

See merge request gitlab-org/gitlab!44691
parents e0c430ae a972e2e0
......@@ -15,7 +15,7 @@ See [Geo limitations](../index.md#limitations) for more information.
CAUTION: **Warning:**
Disaster recovery for multi-secondary configurations is in **Alpha**.
For the latest updates, check the [Disaster Recovery epic for complete maturity](https://gitlab.com/groups/gitlab-org/-/epics/590).
For the latest updates, check the [Disaster Recovery epic for complete maturity](https://gitlab.com/groups/gitlab-org/-/epics/590).
Multi-secondary configurations require the complete re-synchronization and re-configuration of all non-promoted secondaries and
will cause downtime.
......@@ -132,7 +132,7 @@ Note the following when promoting a secondary:
DANGER: **Danger:**
In GitLab 13.2 and later versions, promoting a secondary node to a primary while the secondary is paused fails. We are [investigating the issue](https://gitlab.com/gitlab-org/gitlab/-/issues/225173). Do not pause replication before promoting a secondary. If the node is paused, please resume before promoting.
To promote the secondary node to primary along with preflight checks:
```shell
......
......@@ -128,7 +128,7 @@ The following are PostgreSQL upgrade validation tests we performed.
PostgreSQL 12 with a database cluster on the primary is not recommended until the issues are resolved.
- Known issues for PostgreSQL clusters:
- [Ensure Patroni detects PostgreSQL update](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5423)
- [Allow configuring permanent replication slots in patroni](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5628)
- [Allow configuring permanent replication slots in patroni](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5628)
### August 2020
......
......@@ -397,7 +397,7 @@ To configure the `s3` storage driver in Omnibus:
}
}
```
- `regionendpoint` is only required when configuring an S3 compatible service such as MinIO. It takes a URL such as `http://127.0.0.1:9000`.
- `your-s3-bucket` should be the name of a bucket that exists, and can't include subdirectories.
......
......@@ -1428,7 +1428,7 @@ Considering these, you should carefully plan your PostgreSQL upgrade:
```shell
gitlab-ctl patroni check-leader
# OR
# OR
gitlab-ctl patroni members
```
......
......@@ -158,7 +158,7 @@ Projects::HousekeepingService.new(p, :gc).execute
### Delete references to missing remote uploads
`gitlab-rake gitlab:uploads:check VERBOSE=1` detects remote objects that do not exist because they were
deleted externally but their references still exist in the GitLab database.
deleted externally but their references still exist in the GitLab database.
Example output with error message:
......
......@@ -18,12 +18,12 @@ tests failed so that they can fix them.
You can configure your job to use Unit test reports, and GitLab will display a
report on the merge request so that it's easier and faster to identify the
failure without having to check the entire log. Unit test reports currently
failure without having to check the entire log. Unit test reports currently
only support test reports in the JUnit report format.
If you don't use Merge Requests but still want to see the unit test report
output without searching through job logs, the full
[Unit test reports](#viewing-unit-test-reports-on-gitlab) are available
If you don't use Merge Requests but still want to see the unit test report
output without searching through job logs, the full
[Unit test reports](#viewing-unit-test-reports-on-gitlab) are available
in the pipeline detail view.
Consider the following workflow:
......
......@@ -740,7 +740,7 @@ using [`|` (literal) and `>` (folded) YAML multi-line block scalar indicators](h
CAUTION: **Warning:**
If multiple commands are combined into one command string, only the last command's
failure or success is reported.
failure or success is reported.
[Failures from earlier commands are ignored due to a bug](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25394).
To work around this,
run each command as a separate `script:` item, or add an `exit 1` command
......
......@@ -323,7 +323,7 @@ More experienced contributors are very welcome to tackle
For more complex features that have a weight of 2 or more and clear scope, we recommend looking at issues
with the [label `~"Community Challenge"`](https://gitlab.com/gitlab-org/gitlab/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=Accepting%20merge%20requests&label_name[]=Community%20challenge).
If your MR for the `~"Community Challenge"` issue gets merged, you will also have a chance to win a custom
GitLab merchandise.
GitLab merchandise.
If you've decided that you would like to work on an issue, please @-mention
the [appropriate product manager](https://about.gitlab.com/handbook/product/#who-to-talk-to-for-what)
......
......@@ -187,7 +187,7 @@ As shown in the code example by using `produce`, we can perform any kind of dire
`draftState`. Besides, `immer` guarantees that a new state which includes the changes to `draftState` will be generated.
Finally, to verify whether the immutable cache update is working properly, we need to change
`assumeImmutableResults` to `true` in the `default client config` (see [Apollo Client](#apollo-client) for more info).
`assumeImmutableResults` to `true` in the `default client config` (see [Apollo Client](#apollo-client) for more info).
If everything is working properly `assumeImmutableResults` should remain set to `true`.
......
......@@ -226,7 +226,7 @@ sum(JiraImportState.finished, :imported_issues_count)
### Grouping & Batch Operations
The `count`, `distinct_count`, and `sum` batch counters can accept an `ActiveRecord::Relation`
object, which groups by a specified column. With a grouped relation, the methods do batch counting,
object, which groups by a specified column. With a grouped relation, the methods do batch counting,
handle errors, and returns a hash table of key-value pairs.
Examples:
......@@ -369,7 +369,7 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF
end
```
1. Track event using `track_usage_event(event_name, values) in services and graphql
1. Track event using `track_usage_event(event_name, values)` in services and graphql
Increment unique values count using Redis HLL, for given event name.
......@@ -912,7 +912,7 @@ The following is example content of the Usage Ping payload.
## Exporting Usage Ping SQL queries and definitions
Two Rake tasks exist to export Usage Ping definitions.
Two Rake tasks exist to export Usage Ping definitions.
- The Rake tasks export the raw SQL queries for `count`, `distinct_count`, `sum`.
- The Rake tasks export the Redis counter class or the line of the Redis block for `redis_usage_data`.
......
......@@ -81,7 +81,7 @@ browser is much slower than parsing the HTML response from the app.
A common cause of slow tests is excessive creation of objects, and thus
computation and DB time. Factories are essential to development, but they can
make inserting data into the DB so easy that we may be able to optimize.
make inserting data into the DB so easy that we may be able to optimize.
The two basic techniques to bear in mind here are:
......
......@@ -274,7 +274,7 @@ CHROME_HEADLESS=false bundle exec bin/qa QA::EE::Scenario::Test::Geo --primary-a
### Using Geo in Docker
You can use [GitLab-QA Orchestrator](https://gitlab.com/gitlab-org/gitlab-qa) to orchestrate two GitLab containers and configure them as a Geo setup.
You can use [GitLab-QA Orchestrator](https://gitlab.com/gitlab-org/gitlab-qa) to orchestrate two GitLab containers and configure them as a Geo setup.
Geo requires an EE license. To visit the Geo sites in your browser, you will need a reverse proxy server (for example, [NGINX](https://www.nginx.com/)).
......@@ -319,7 +319,7 @@ Geo requires an EE license. To visit the Geo sites in your browser, you will nee
_Map the hostnames to the local IP in `/etc/hosts` file on your machine:_
```plaintext
127.0.0.1 gitlab-primary.geo gitlab-secondary.geo
127.0.0.1 gitlab-primary.geo gitlab-secondary.geo
```
_Note the assigned ports:_
......
......@@ -31,7 +31,7 @@ cd <destination folder>
[Create a new branch](create-branch.md) to add your file into. Submitting changes directly
to the default branch should be avoided unless your project is very small and you're the
only person working on it.
only person working on it.
You can also [switch to an existing branch](start-using-git.md#work-on-an-existing-branch)
if you have one already.
......@@ -80,7 +80,7 @@ Now you can push (send) your changes (in the branch `<branch-name>`) to GitLab
git push origin <branch-name>
```
Your image is added to your branch in your repository in GitLab.
Your image is added to your branch in your repository in GitLab.
<!-- ## Troubleshooting
......
......@@ -321,7 +321,7 @@ Starting from GitLab 12.1, only PostgreSQL is supported. Since GitLab 13.0, we [
```shell
sudo apt-get install -y postgresql postgresql-client libpq-dev postgresql-contrib
```
1. Verify the PostgreSQL version you have is supported by the version of GitLab you're
installing:
......
......@@ -178,7 +178,7 @@ To enable Advanced Search, you need to have admin access to GitLab:
[license](../user/admin_area/license.md).
1. Configure the [Advanced Search settings](#advanced-search-configuration) for
your Elasticsearch cluster. Do not enable **Search with Elasticsearch enabled**
your Elasticsearch cluster. Do not enable **Search with Elasticsearch enabled**
yet.
1. Now enable **Elasticsearch indexing** in **Admin Area > Settings >
General > Advanced Search** and click **Save changes**. This will create
......
......@@ -31,7 +31,7 @@ You will need to activate the endpoint and obtain credentials to set up this int
### External Prometheus integration
For GitLab versions 13.1 and greater, please see [External Prometheus Instances](../metrics/alerts.md#external-prometheus-instances) to configure alerts for this integration.
For GitLab versions 13.1 and greater, please see [External Prometheus Instances](../metrics/alerts.md#external-prometheus-instances) to configure alerts for this integration.
## Customizing the payload
......
......@@ -184,12 +184,12 @@ bash_history
Each file name contained in a Git push is compared to the regular expression in this field. Filenames in Git consist of both the file's name and any directory that may precede it. A singular regular expression can contain multiple independent matches used as exclusions. File names can be broadly matched to any location in the repository, or restricted to specific locations. Filenames can also be partial matches used to exclude file types by extension.
The following examples make use of regex string boundary characters which match the beginning of a string (`^`), and the end (`$`). They also include instances where either the directory path or the filename can include `.` or `/`. Both of these special regex characters have to be escaped with a backslash `\` to be used as normal characters in a match condition.
The following examples make use of regex string boundary characters which match the beginning of a string (`^`), and the end (`$`). They also include instances where either the directory path or the filename can include `.` or `/`. Both of these special regex characters have to be escaped with a backslash `\\` to be used as normal characters in a match condition.
Example: prevent pushing any `.exe` files to any location in the repository. This is an example of a partial match, which can match any filename that contains `.exe` at the end:
```plaintext
\.exe$
\.exe$
```
Example: prevent a specific configuration file in the repository root from being pushed:
......@@ -214,7 +214,7 @@ Example: combining all of the above in a single expression. Note that all of the
```plaintext
(\.exe|^config\.yml|^directory-name\/config\.yml|(^|\/)install\.exe)$
```
```
<!-- ## Troubleshooting
......
......@@ -35,7 +35,7 @@ If you see a **Revoke** button, you can revoke that user's PAT. Whether you see
|-------------|------------------------|--------------------|----------------------------------------------------------------------------|
| Active | Yes | Yes | Allows administrators to revoke the PAT, such as for a compromised account |
| Active | No | Yes | Allows administrators to revoke the PAT, such as for a compromised account |
| Expired | Yes | No | PAT expires automatically |
| Expired | No | Yes | The administrator may revoke the PAT to prevent indefinite use |
| Revoked | Yes | No | Not applicable; token is already revoked |
| Revoked | No | No | Not applicable; token is already revoked |
| Expired | Yes | No | PAT expires automatically |
| Expired | No | Yes | The administrator may revoke the PAT to prevent indefinite use |
| Revoked | Yes | No | Not applicable; token is already revoked |
| Revoked | No | No | Not applicable; token is already revoked |
......@@ -8,8 +8,8 @@ type: reference, howto
# Web API Fuzz Testing **(ULTIMATE)**
You can add web API fuzzing to your [GitLab CI/CD](../../../ci/README.md)
pipelines. This helps you discover bugs and potential security issues that other QA processes may miss.
API fuzzing performs fuzz testing of API operation parameters.
pipelines. This helps you discover bugs and potential security issues that other QA processes may miss.
API fuzzing performs fuzz testing of API operation parameters.
Fuzz testing sets operation parameters to unexpected values in an effort to cause unexpected behavior and errors in the API backend.
We recommend that you use fuzz testing in addition to [GitLab Secure](../index.md)'s
......@@ -443,7 +443,7 @@ Example usage for setting a single header:
```json
{
"headers": {
"Authorization": "Bearer dXNlcm5hbWU6cGFzc3dvcmQ="
"Authorization": "Bearer dXNlcm5hbWU6cGFzc3dvcmQ="
}
}
```
......@@ -453,7 +453,7 @@ Example usage for setting both a header and cookie:
```json
{
"headers": {
"Authorization": "Bearer dXNlcm5hbWU6cGFzc3dvcmQ="
"Authorization": "Bearer dXNlcm5hbWU6cGFzc3dvcmQ="
},
"cookies": {
"flags": "677"
......
......@@ -61,7 +61,7 @@ is **not** `19.03.0`. See [troubleshooting information](#error-response-from-dae
GitLab SAST supports a variety of languages, package managers, and frameworks. Our SAST security scanners also feature automatic language detection which works even for mixed-language projects. If any supported language is detected in project source code we will automatically run the appropriate SAST analyzers.
You can also [view our language roadmap](https://about.gitlab.com/direction/secure/static-analysis/sast/#language-support) and [request other language support by opening an issue](https://gitlab.com/groups/gitlab-org/-/epics/297).
You can also [view our language roadmap](https://about.gitlab.com/direction/secure/static-analysis/sast/#language-support) and [request other language support by opening an issue](https://gitlab.com/groups/gitlab-org/-/epics/297).
| Language (package managers) / framework | Scan tool | Introduced in GitLab Version |
|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
......
......@@ -24,7 +24,7 @@ can be any public or private repository.
mkdir my-composer-package && cd my-composer-package
```
1. Run [`composer init`](https://getcomposer.org/doc/03-cli.md#init) and answer the prompts.
1. Run [`composer init`](https://getcomposer.org/doc/03-cli.md#init) and answer the prompts.
For namespace, enter your unique [namespace](../../../user/group/index.md#namespaces), like your GitLab username or group name.
......@@ -71,7 +71,7 @@ Prerequisites:
To publish the package:
- Send a `POST` request to the [Packages API](../../../api/packages.md).
For example, you can use `curl`:
```shell
......@@ -156,7 +156,7 @@ To install a package:
1. Create an `auth.json` file with your GitLab credentials:
```shell
composer config gitlab-token.<DOMAIN-NAME> <personal_access_token>
composer config gitlab-token.<DOMAIN-NAME> <personal_access_token>
```
Output indicates that the package has been successfully installed.
......
......@@ -223,7 +223,7 @@ To publish a Conan package, you need:
- The Package Registry [set as a remote](#add-the-package-registry-as-a-conan-remote).
- [Authentication](#authenticate-to-the-package-registry) set up with the Package Registry.
- A local [Conan package](https://docs.conan.io/en/latest/creating_packages/getting_started.html).
- A local [Conan package](https://docs.conan.io/en/latest/creating_packages/getting_started.html).
- For an instance remote, the package must meet the [naming convention](#package-recipe-naming-convention-for-instance-remotes).
- A project ID, which is on the project's homepage.
......@@ -276,12 +276,12 @@ To install a Conan package, you need:
1. Add the Conan recipe to the `[requires]` section of the file:
```ini
[requires]
Hello/0.1@mycompany/beta
[generators]
cmake
```plaintext
[requires]
Hello/0.1@mycompany/beta
[generators]
cmake
```
1. At the root of your project, create a `build` directory and change to that directory:
......@@ -316,7 +316,7 @@ There are two ways to remove a Conan package from the GitLab Package Registry.
NOTE: **Note:**
This command removes all recipe and binary package files from the Package Registry.
- From the GitLab user interface:
- From the GitLab user interface:
Go to your project's **Packages & Registries > Package Registry**. Remove the package by clicking the red trash icon.
......
......@@ -113,9 +113,9 @@ To authenticate, run the `docker` command. For example:
To build and push to the Container Registry:
1. Authenticate with the Container Registry.
1. Authenticate with the Container Registry.
1. Run the command to build or push. For example, to build:
1. Run the command to build or push. For example, to build:
```shell
docker build -t registry.example.com/group/project/image .
......@@ -181,7 +181,7 @@ You can configure your `.gitlab-ci.yml` file to build and push images to the Con
longer, but it ensures your image is up-to-date.
- Before each `docker run`, do an explicit `docker pull` to fetch
the image that was just built. This is especially important if you are
using multiple runners that cache images locally.
using multiple runners that cache images locally.
If you use the Git SHA in your image tag, each job is unique and you
should never have a stale image. However, it's still possible to have a
......@@ -603,7 +603,7 @@ are not deleted by the cleanup policy.
## Disable the Container Registry for a project
The Container Registry is enabled by default.
The Container Registry is enabled by default.
You can, however, remove the Container Registry for a project:
......
......@@ -290,7 +290,7 @@ Administrators can disable this behavior in the [Continuous Integration settings
You can route package requests to organizations and users outside of GitLab.
To do this, add lines to your `.npmrc` file, replacing `my-org` with the namespace or group that owns your project's repository. The name is case-sensitive and must match the name of your group or namespace exactly.
To do this, add lines to your `.npmrc` file, replacing `my-org` with the namespace or group that owns your project's repository. The name is case-sensitive and must match the name of your group or namespace exactly.
```shell
@foo:registry=https://gitlab.example.com/api/v4/packages/npm/
......@@ -442,7 +442,7 @@ npm install @scope/package@my-tag # Install a specific tag
```
NOTE: **Note:**
You cannot use your `CI_JOB_TOKEN` or deploy token with the `npm dist-tag` commands. View [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/258835) for details.
You cannot use your `CI_JOB_TOKEN` or deploy token with the `npm dist-tag` commands. View [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/258835) for details.
CAUTION: **Warning:**
Due to a bug in NPM 6.9.0, deleting dist tags fails. Make sure your NPM version is greater than 6.9.1.
......@@ -158,7 +158,7 @@ file.md @group-x @group-x/subgroup-y
### Code Owners Sections **(PREMIUM)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12137) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.2 behind a feature flag, enabled by default.
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42389) in GitLab 13.4.
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42389) in GitLab 13.4.
Code Owner rules can be grouped into named sections. This allows for better
organization of broader categories of Code Owner rules to be applied.
......
......@@ -107,7 +107,7 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/
be done automatically and no action is necessary.
If you are using GCP to manage clusters, you can see the deployment details in GCP itself by going to **Workloads > deployment name > Details**:
![Deploy Boards Kubernetes Label](img/deploy_boards_kubernetes_label.png)
Once all of the above are set up and the pipeline has run at least once,
......
......@@ -58,7 +58,7 @@ Here are some common use cases for issue boards.
### Use cases for a single issue board
With the GitLab Workflow you can discuss proposals in issues, label
With the GitLab Workflow you can discuss proposals in issues, label
them, and organize and prioritize them with issue boards.
For example, let's consider this simplified development workflow:
......@@ -169,9 +169,9 @@ At this point, that issue is assigned a relative order value by the system,
with respect to the other issues in the list. Any time
you drag and reorder the issue, its relative order value changes accordingly.
Also, any time that issue appears in any board, the ordering is done according to
Also, any time that issue appears in any board, the ordering is done according to
the updated relative order value. It's only the first
time an issue appears that it takes from the priority order mentioned above. If a user in your GitLab instance
time an issue appears that it takes from the priority order mentioned above. If a user in your GitLab instance
drags issue `A` above issue `B`, the ordering is maintained when these two issues are subsequently
loaded in any board in the same instance. This could be a different project board or a different group
board, for example.
......
......@@ -97,7 +97,7 @@ test-jdk11:
- target/site/jacoco/jacoco.xml
coverage-jdk11:
# Must be in a stage later than test-jdk11's stage.
# Must be in a stage later than test-jdk11's stage.
# The `visualize` stage does not exist by default.
# Please define it first, or chose an existing stage like `deploy`.
stage: visualize
......@@ -137,7 +137,7 @@ test-jdk11:
- build/jacoco/jacoco.xml
coverage-jdk11:
# Must be in a stage later than test-jdk11's stage.
# Must be in a stage later than test-jdk11's stage.
# The `visualize` stage does not exist by default.
# Please define it first, or chose an existing stage like `deploy`.
stage: visualize
......
......@@ -229,7 +229,7 @@ backed by the database and allows searching in:
- Commits (Project only)
- Wiki (Project only)
To start a search, type into the search bar on the top-right of the screen. You can always search
To start a search, type into the search bar on the top-right of the screen. You can always search
in all GitLab and may also see the options to search within a group or project if you are in the
group or project dashboard.
......@@ -239,7 +239,7 @@ Once the results are returned, you can modify the search, select a different typ
search, or choose a specific group or project.
![basic_search_results](img/basic_search_results.png)
### Code search
To search through code or other documents in a single project, you can use
......
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