Skip to content
Snippets Groups Projects
Commit f103d0ae authored by Amy Qualls's avatar Amy Qualls
Browse files

Merge branch 'docs/fix-eolwhitespace-and-nonstandardquotes' into 'master'

Fix vale NonStandardQuotes and EOLWhitespace rule warnings

See merge request gitlab-org/gitlab!88176
parents 200930fe 5d32e440
No related branches found
No related tags found
No related merge requests found
Showing
with 34 additions and 34 deletions
Loading
Loading
@@ -14,7 +14,7 @@ Users with auditor access have read-only access to all groups, projects, and oth
For more information, see [Auditor user permissions and restrictions](#auditor-user-permissions-and-restrictions)
section.
 
Situations where auditor access for users could be helpful include:
Situations where auditor access for users could be helpful include:
 
- Your compliance department wants to run tests against the entire GitLab base
to ensure users are complying with password, credit card, and other sensitive
Loading
Loading
Loading
Loading
@@ -9,13 +9,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85689) in GitLab 15.0 [with a flag](../administration/feature_flags.md) named `inactive_projects_deletion`. Disabled by default.
 
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to
On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to
[enable the feature flag](../administration/feature_flags.md) named `inactive_projects_deletion`.
On GitLab.com, this feature is not available. This feature is not ready for production use.
 
Administrators of large GitLab instances can find that over time, projects become inactive and are no longer used.
These projects take up unnecessary disk space. With inactive project deletion, you can identify these projects, warn
the maintainers ahead of time, and then delete the projects if they remain inactive. When an inactive project is
These projects take up unnecessary disk space. With inactive project deletion, you can identify these projects, warn
the maintainers ahead of time, and then delete the projects if they remain inactive. When an inactive project is
deleted, the action generates an audit event that it was performed by the first active administrator.
 
## Configure inactive project deletion
Loading
Loading
Loading
Loading
@@ -1180,7 +1180,7 @@ Reference: <https://docs.docker.com/registry/spec/auth/token/>
 
### Communication between GitLab and Registry
 
Registry doesnt have a way to authenticate users internally so it relies on
Registry doesn't have a way to authenticate users internally so it relies on
GitLab to validate credentials. The connection between Registry and GitLab is
TLS encrypted. The key is used by GitLab to sign the tokens while the certificate
is used by Registry to validate the signature. By default, a self-signed certificate key pair is generated
Loading
Loading
Loading
Loading
@@ -36,7 +36,7 @@ rapid growth of CI/CD adoption on GitLab.com.
We can not, however, continue using Docker Machine. Work on that project [was
paused in July 2018](https://github.com/docker/machine/issues/4537) and there
was no development made since that time (except for some highly important
security fixes). In 2018, after Docker Machine entered the maintenance mode,
security fixes). In 2018, after Docker Machine entered the "maintenance mode",
we decided to create [our own fork](https://gitlab.com/gitlab-org/ci-cd/docker-machine)
to be able to keep using this and ship fixes and updates needed for our use case.
[On September 26th, 2021 the project got archived](https://github.com/docker/docker.github.io/commit/2dc8b49dcbe85686cc7230e17aff8e9944cb47a5)
Loading
Loading
@@ -48,7 +48,7 @@ new mechanism for GitLab Runner auto-scaling. It not only needs to support
auto-scaling, but it also needs to do that in the way to enable us to build on
top of it to improve efficiency, reliability and availability.
 
We call this new mechanism the next GitLab Runner Scaling architecture.
We call this new mechanism the "next GitLab Runner Scaling architecture".
 
_Disclaimer The following contain information related to upcoming products,
features, and functionality._
Loading
Loading
@@ -82,11 +82,11 @@ about how people are using Docker Machine right now, and it seems that GitLab
CI is one of the most frequent reasons for people to keep using Docker Machine.
 
There is also an opportunity in being able to optionally run multiple jobs in a
single, larger virtual machine. We cant do that today, but we know that this
single, larger virtual machine. We can't do that today, but we know that this
can potentially significantly improve efficiency. We might want to build a new
architecture that makes it easier and allows us to test how efficient it is
with PoCs. Running multiple jobs on a single machine can also make it possible
to reuse what we call a sticky context - a space for build artifacts / user
to reuse what we call a "sticky context" - a space for build artifacts / user
data that can be shared between job runs.
 
### 💡 Design a simple abstraction that users will be able to build on top of
Loading
Loading
@@ -165,7 +165,7 @@ sequence diagram.
![GitLab Runner Autoscaling Overview](gitlab-autoscaling-overview.png)
 
On the diagrams above we see that currently a GitLab Runner Manager runs on a
machine that has access to a cloud providers API. It is using Docker Machine
machine that has access to a cloud provider's API. It is using Docker Machine
to provision new Virtual Machines with Docker Engine installed and it
configures the Docker daemon there to allow external authenticated requests. It
stores credentials to such ephemeral Docker environments on disk. Once a
Loading
Loading
@@ -186,8 +186,8 @@ through os/exec system calls.
 
Thanks to the custom executor abstraction there is no more need to implement
new executors internally in Runner. Users who have specific needs can implement
their own drivers and dont need to wait for us to make their work part of the
official GitLab Runner. As each driver is a separate project, it also makes
their own drivers and don't need to wait for us to make their work part of the
"official" GitLab Runner. As each driver is a separate project, it also makes
it easier to create communities around them, where interested people can
collaborate together on improvements and bug fixes.
 
Loading
Loading
@@ -197,7 +197,7 @@ provide a context and an environment in which a build will be executed by one
of the Custom Executors.
 
There are multiple solutions to implementing a custom provider abstraction. We
can use raw Go plugins, Hashcorps Go Plugin, HTTP interface or gRPC based
can use raw Go plugins, Hashcorp's Go Plugin, HTTP interface or gRPC based
facade service. There are many solutions, and we want to choose the most
optimal one. In order to do that, we will describe the solutions in a separate
document, define requirements and score the solution accordingly. This will
Loading
Loading
Loading
Loading
@@ -200,7 +200,7 @@ GitLab SaaS shared runners have different cost factors, depending on the runner
| GitLab SaaS runner type | Virtual machine configuration | CI/CD minutes cost factor |
| :--------- | :------------------- | :--------- |
| Linux OS + Docker executor| 1 vCPU, 3.75 GB RAM |1|
| macOS + shell executor | 4 vCPU, 10 GB RAM| 6 |
| macOS + shell executor | 4 vCPU, 10 GB RAM| 6 |
 
### Monthly reset of CI/CD minutes
 
Loading
Loading
Loading
Loading
@@ -61,7 +61,7 @@ To use fastlane to code sign your application:
get_provisioning_profile
# match(type: "appstore",read_only: true)
gym
upload_to_testflight
upload_to_testflight
end
end
```
Loading
Loading
Loading
Loading
@@ -134,7 +134,7 @@ applied to many other technical implementations.
GitLab is a DevOps platform. We popularize DevOps because it helps companies
be more efficient and achieve better results. One important component of
DevOps culture is to take ownership over features and code that you are
building. It is very difficult to do that when you dont know how your features
building. It is very difficult to do that when you don't know how your features
perform and behave in the production environment.
 
This is why we want to make our features and code observable. It
Loading
Loading
@@ -181,7 +181,7 @@ updating, because their feedback might be limited to code style and syntax.
Depending on the complexity and impact of a change, assigning the right people
to review your changes might be very important.
 
If you dont know who to assign, consult `git blame` or ask in the `#verify`
If you don't know who to assign, consult `git blame` or ask in the `#verify`
Slack channel (GitLab team members only).
 
### Incremental rollouts
Loading
Loading
@@ -220,7 +220,7 @@ scenario relating to a software being built by one of our [early customers](http
 
That would be quite an undesirable outcome of a small bug in GitLab CI/CD status
processing. Please take extra care when you are working on CI/CD statuses,
we dont want to implode our Universe!
we don't want to implode our Universe!
 
This is an extreme and unlikely scenario, but presenting data that is not accurate
can potentially cause a myriad of problems through the
Loading
Loading
Loading
Loading
@@ -53,6 +53,6 @@ To add a story:
 
## Mock backend APIs
 
GitLab’s Storybook uses [MirajeJS](https://miragejs.com/) to mock REST and GraphQL APIs. Storybook shares the MirajeJS server
The GitLab Storybook uses [MirajeJS](https://miragejs.com/) to mock REST and GraphQL APIs. Storybook shares the MirajeJS server
with the [frontend integration tests](../testing_guide/testing_levels.md#frontend-integration-tests). You can find the MirajeJS
configuration files in `spec/frontend_integration/mock_server`.
Loading
Loading
@@ -236,7 +236,7 @@ export default {
If the extension needs to poll multiple endpoints at the same time, then `fetchMultiData`
can be used to return an array of functions. A new `poll` object will be created for each
endpoint and they will be polled separately. Once all endpoints are resolved, polling will
be stopped and `setCollapsedData` will be called with an array of `response.data`.
be stopped and `setCollapsedData` will be called with an array of `response.data`.
 
```javascript
export default {
Loading
Loading
@@ -253,7 +253,7 @@ export default {
};
```
 
**Important** The function needs to return a `Promise` that resolves the `response` object.
**Important** The function needs to return a `Promise` that resolves the `response` object.
The implementation relies on the `POLL-INTERVAL` header to keep polling, therefore it is
important not to alter the status code and headers.
 
Loading
Loading
Loading
Loading
@@ -14,7 +14,7 @@ Advanced Search provides faster search response times and [improved search featu
 
### Elasticsearch version requirements
 
> Support for Elasticsearch 6.8 was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/350275) in GitLab 15.0.
> Support for Elasticsearch 6.8 was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/350275) in GitLab 15.0.
 
Advanced Search works with the following versions of Elasticsearch.
 
Loading
Loading
Loading
Loading
@@ -179,7 +179,7 @@ If you get this error message while configuring GitLab, the following are possib
- The Jenkins instance is at a local address and is not included in the
[GitLab installation's allowlist](../security/webhooks.md#allowlist-for-local-requests).
- The credentials for the Jenkins instance do not have sufficient access or are invalid.
- The **Enable authentication for /project end-point** checkbox is not selected in your [Jenkin's plugin configuration](#configure-the-jenkins-server).
- The **Enable authentication for `/project` end-point** checkbox is not selected in your [Jenkin's plugin configuration](#configure-the-jenkins-server).
 
### Error in merge requests - "Could not connect to the CI server"
 
Loading
Loading
Loading
Loading
@@ -1447,7 +1447,7 @@ To prepare the new server:
1. Copy the
[SSH host keys](https://superuser.com/questions/532040/copy-ssh-keys-from-one-server-to-another-server/532079#532079)
from the old server to avoid man-in-the-middle attack warnings.
See [Manually replicate the primary sites SSH host keys](../administration/geo/replication/configuration.md#step-2-manually-replicate-the-primary-sites-ssh-host-keys) for example steps.
See [Manually replicate the primary site's SSH host keys](../administration/geo/replication/configuration.md#step-2-manually-replicate-the-primary-sites-ssh-host-keys) for example steps.
1. [Install and configure GitLab](https://about.gitlab.com/install) except
[incoming email](../administration/incoming_email.md):
1. Install GitLab.
Loading
Loading
Loading
Loading
@@ -87,7 +87,7 @@ Each command has a rate limit of 600 per minute. For example:
Because the same commands are shared by `git-upload-pack`, `git pull`, and `git clone`, they share a rate limit.
 
The requests/minute threshold for this rate limit is not configurable. Self-managed customers can disable this
rate limit by [disabling the feature flag](../administration/feature_flags.md#enable-or-disable-the-feature)
rate limit by [disabling the feature flag](../administration/feature_flags.md#enable-or-disable-the-feature)
with `Feature.disable(:rate_limit_gitlab_shell)`.
 
### Repository archives
Loading
Loading
Loading
Loading
@@ -315,7 +315,7 @@ The `covfuzz-ci.yml` is the same as that in the [original synchronous example](h
 
## FIPS-enabled binary
 
[Starting in GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/352549) the coverage fuzzing binary is compiled with `golang-fips` on Linux x86 and uses OpenSSL as the cryptographic backend. For more details, see [FIPS compliance at GitLab with Go](../../../development/fips_compliance.md#go).
[Starting in GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/352549) the coverage fuzzing binary is compiled with `golang-fips` on Linux x86 and uses OpenSSL as the cryptographic backend. For more details, see [FIPS compliance at GitLab with Go](../../../development/fips_compliance.md#go).
 
## Offline environment
 
Loading
Loading
Loading
Loading
@@ -333,7 +333,7 @@ Vulnerability rules in an API scan are different than those in a normal website
 
A new DAST API scanning engine is available in GitLab 13.12 and later. For more details, see [DAST API scanning engine](../dast_api). The new scanning engine supports REST, SOAP, GraphQL, and generic APIs using forms, XML, and JSON. Testing can be performed using OpenAPI, Postman Collections, and HTTP Archive (HAR) documents.
 
The target API instances base URL is provided by using the `DAST_API_TARGET_URL` variable or an `environment_url.txt` file.
The target API instance's base URL is provided by using the `DAST_API_TARGET_URL` variable or an `environment_url.txt` file.
 
#### Specification format
 
Loading
Loading
Loading
Loading
@@ -91,10 +91,10 @@ The Vulnerability Management system automatically moves vulnerabilities from the
 
However, you'll see old vulnerabilities re-created based on Semgrep results if:
 
- A vulnerability was created by Bandit or SpotBugs and you disable those analyzers. We only recommend disabling Bandit and SpotBugs now if the analyzers arent working. Work to automatically translate Bandit and SpotBugs vulnerabilities to Semgrep is tracked in [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/328062).
- A vulnerability was created by Bandit or SpotBugs and you disable those analyzers. We only recommend disabling Bandit and SpotBugs now if the analyzers aren't working. Work to automatically translate Bandit and SpotBugs vulnerabilities to Semgrep is tracked in [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/328062).
- A vulnerability was created by ESLint, Gosec, or Flawfinder in a default-branch pipeline where Semgrep scanning did not run successfully (before Semgrep coverage was introduced for the language, because you disabled Semgrep explicitly, or because the Semgrep scan failed in that pipeline). We do not currently plan to combine these vulnerabilities if they already exist.
 
When a vulnerability is re-created, the original vulnerability is marked as no longer detected in the Vulnerability Report.
When a vulnerability is re-created, the original vulnerability is marked as "no longer detected" in the Vulnerability Report.
A new vulnerability is then created based on the Semgrep finding.
 
### Activating Semgrep-based scanning early
Loading
Loading
Loading
Loading
@@ -13,7 +13,7 @@ The whitepaper ["A Seismic Shift in Application Security"](https://about.gitlab.
explains how 4 of the top 6 attacks were application based. Download it to learn how to protect your
organization.
 
If youre using [GitLab CI/CD](../../../ci/index.md), you can use Static Application Security
If you're using [GitLab CI/CD](../../../ci/index.md), you can use Static Application Security
Testing (SAST) to check your source code for known vulnerabilities. You can run SAST analyzers in
any GitLab tier. The analyzers output JSON-formatted reports as job artifacts.
 
Loading
Loading
Loading
Loading
@@ -35,7 +35,7 @@ To read more about what is planned for the future, see [issue 2256](https://gitl
 
Customer relations management features must be enabled at the group level. If your
group also contains subgroups, and you want to use CRM features in the subgroup,
you must enable CRM features for the subgroup.
you must enable CRM features for the subgroup.
 
To enable customer relations management in a group or subgroup:
 
Loading
Loading
Loading
Loading
@@ -57,7 +57,7 @@ In your Auto DevOps project, you can use the GitLab agent to connect with your K
- Add a key called `KUBE_INGRESS_BASE_DOMAIN` with the application deployment domain as the value.
- Add a key called `KUBE_CONTEXT` with a value like `path/to/agent/project:agent-name`.
Select the environment scope of your choice.
If you are not sure what your agents context is, edit your `.gitlab-ci.yml` file and add a job to see the available contexts:
If you are not sure what your agent's context is, edit your `.gitlab-ci.yml` file and add a job to see the available contexts:
 
```yaml
deploy:
Loading
Loading
Loading
Loading
@@ -73,8 +73,8 @@ There are three different causes for the error:
 
- In GitLab 15.0, templates use [`rules`](../../../ci/yaml/index.md#rules) syntax
instead of [`only/except`](../../../ci/yaml/index.md#only--except).
Ensure the syntax in your `.gitlab-ci.yml` file does not include both.
Ensure the syntax in your `.gitlab-ci.yml` file does not include both.
#### Use an older version of the template
 
Breaking changes can occur during major releases. If you encounter a breaking change or want to use an older version of a template, you can update your `.gitlab-ci.yml` to refer to an older one. For example:
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment