Skip to content
Snippets Groups Projects
Commit 6698a1ba authored by Marcel Amirault's avatar Marcel Amirault Committed by Craig Norris
Browse files

Add a test to check for non-standard quotes

We don't need to allow irregular quotes, as it could
allow some tests to be avoided if the test looks for
the standard style only
parent 154739d7
No related branches found
No related tags found
No related merge requests found
Showing
with 39 additions and 27 deletions
---
# Warning: gitlab.NonStandardQuotes
#
# Use only standard single and double quotes, not left or right quotes.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.'
level: warning
ignorecase: true
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html
scope: raw
raw:
- '[‘’“”]'
Loading
Loading
@@ -5,11 +5,9 @@
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Rewrite "%s" to not use "’s".'
message: "Rewrite '%s' to not use 's."
level: error
ignorecase: true
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#trademark
tokens:
- GitLab's # Straight apostrophe.
- GitLab’s # Curly closing apostrophe.
- GitLab‘s # Curly opening apostrophe.
- GitLab's
Loading
Loading
@@ -154,7 +154,7 @@ The following are PostgreSQL upgrade validation tests we performed.
- Follow up issues:
- [`replicate-geo-database` incorrectly tries to back up repositories](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5241).
- [`pg-upgrade` fails to upgrade a standalone Geo tracking database](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5242).
- [`revert-pg-upgrade` fails to downgrade the PostgreSQL data of a Geo secondarys standalone tracking database](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5243).
- [`revert-pg-upgrade` fails to downgrade the PostgreSQL data of a Geo secondary's standalone tracking database](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5243).
- [Timeout error on Geo secondary read-replica near the end of `gitlab-ctl pg-upgrade`](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5235).
 
[Verify Geo installation with PostgreSQL 11](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4971):
Loading
Loading
Loading
Loading
@@ -81,7 +81,7 @@ from [owasp.org](https://owasp.org/).
considered an administrator with super-user privileges.
- See also: [more granular access control](https://gitlab.com/gitlab-org/gitlab/-/issues/18242)
(not Geo-specific).
- Much of Geos integration (database replication, for instance) must be
- Much of Geo's integration (database replication, for instance) must be
configured with the application, typically by system administrators.
 
### What administrative capabilities does the application offer?
Loading
Loading
@@ -223,7 +223,7 @@ from [owasp.org](https://owasp.org/).
 
### What data input validation requirements have been defined?
 
- **Secondary** nodes must have a faithful replication of the **primary** nodes data.
- **Secondary** nodes must have a faithful replication of the **primary** node's data.
 
### What data does the application store and how?
 
Loading
Loading
@@ -235,7 +235,7 @@ from [owasp.org](https://owasp.org/).
rest. A subset of database columns are encrypted at rest using the `db_otp_key`.
- A static secret shared across all hosts in a GitLab deployment.
- In transit, data should be encrypted, although the application does permit
communication to proceed unencrypted. The two main transits are the **secondary** nodes
communication to proceed unencrypted. The two main transits are the **secondary** node's
replication process for PostgreSQL, and for Git repositories/files. Both should
be protected using TLS, with the keys for that managed via Omnibus per existing
configuration for end-user access to GitLab.
Loading
Loading
Loading
Loading
@@ -838,7 +838,7 @@ addition to the GitLab nodes. Some requests handled by
process. `gitaly-ruby` uses the Gitaly address set in the GitLab server's
`git_data_dirs` setting to make this connection.
 
We hope that if youre managing fault-tolerant systems like GitLab, you have a load balancer
We hope that if you're managing fault-tolerant systems like GitLab, you have a load balancer
of choice already. Some examples include [HAProxy](https://www.haproxy.org/)
(open-source), [Google Internal Load Balancer](https://cloud.google.com/load-balancing/docs/internal/),
[AWS Elastic Load Balancer](https://aws.amazon.com/elasticloadbalancing/), F5
Loading
Loading
Loading
Loading
@@ -105,7 +105,7 @@ Limit the maximum daily member invitations allowed per group hierarchy.
 
## Gitaly concurrency limit
 
Clone traffic can put a large strain on your Gitaly service. To prevent such workloads from overwhelming your Gitaly server, you can set concurrency limits in Gitalys configuration file.
Clone traffic can put a large strain on your Gitaly service. To prevent such workloads from overwhelming your Gitaly server, you can set concurrency limits in Gitaly's configuration file.
 
Read more on [Gitaly concurrency limits](gitaly/configure_gitaly.md#limit-rpc-concurrency).
 
Loading
Loading
Loading
Loading
@@ -90,7 +90,7 @@ You can add custom metrics in the self monitoring project by:
 
## Troubleshooting
 
### Getting error message in logs: `Could not create instance administrators group. Errors: ["You dont have permission to create groups."]`
### Getting error message in logs: `Could not create instance administrators group. Errors: ["You don't have permission to create groups."]`
 
There is [a bug](https://gitlab.com/gitlab-org/gitlab/-/issues/208676) which causes
project creation to fail with the following error (which appears in the log file)
Loading
Loading
@@ -98,7 +98,7 @@ when the first administrator user is an
[external user](../../../user/permissions.md#external-users):
 
```plaintext
Could not create instance administrators group. Errors: ["You dont have permission to create groups."]
Could not create instance administrators group. Errors: ["You don't have permission to create groups."]
```
 
Run the following in a Rails console to check if the first administrator user is an external user:
Loading
Loading
Loading
Loading
@@ -25,5 +25,5 @@ Explore our features to monitor your GitLab instance:
- [`nginx_status`](https://docs.gitlab.com/omnibus/settings/nginx.html#enablingdisabling-nginx_status):
Monitor your NGINX server status.
- [Auto Monitoring](../../topics/autodevops/stages.md#auto-monitoring): Automated
monitoring for your applications server and response metrics, provided by
monitoring for your application's server and response metrics, provided by
[Auto DevOps](../../topics/autodevops/index.md).
Loading
Loading
@@ -180,7 +180,7 @@ outside world.
pages_nginx['redirect_http_to_https'] = true
```
 
1. If you havent named your certificate and key `example.io.crt` and `example.io.key`
1. If you haven't named your certificate and key `example.io.crt` and `example.io.key`
then you'll need to also add the full paths as shown below:
 
```ruby
Loading
Loading
Loading
Loading
@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
# Redis replication and failover providing your own instance **(FREE SELF)**
 
If youre hosting GitLab on a cloud provider, you can optionally use a managed
If you're hosting GitLab on a cloud provider, you can optionally use a managed
service for Redis. For example, AWS offers ElastiCache that runs Redis.
 
Alternatively, you may opt to manage your own Redis instance separate from the
Loading
Loading
Loading
Loading
@@ -12,7 +12,7 @@ This page details the recommended Reference Architectures that were built and
verified by the GitLab Quality and Support teams.
 
Below is a chart representing each architecture tier and the number of users
they can handle. As your number of users grow with time, its recommended that
they can handle. As your number of users grow with time, it's recommended that
you scale GitLab accordingly.
 
![Reference Architectures](img/reference-architectures.png)
Loading
Loading
Loading
Loading
@@ -7,7 +7,7 @@ type: reference
 
# Troubleshooting Group SAML and SCIM **(PREMIUM SAAS)**
 
These are notes and screenshots regarding Group SAML and SCIM that the GitLab Support Team sometimes uses while troubleshooting, but which do not fit into the official documentation. GitLab is making this public, so that anyone can make use of the Support teams collected knowledge.
These are notes and screenshots regarding Group SAML and SCIM that the GitLab Support Team sometimes uses while troubleshooting, but which do not fit into the official documentation. GitLab is making this public, so that anyone can make use of the Support team's collected knowledge.
 
Please refer to the GitLab [Group SAML](../../user/group/saml_sso/index.md) docs for information on the feature and how to set it up.
 
Loading
Loading
Loading
Loading
@@ -91,7 +91,7 @@ This section is for links to information elsewhere in the GitLab documentation.
 
Command exceeded allowed execution time
 
PANIC: could not write to file pg_xlog/xlogtemp.123: No space left on device
PANIC: could not write to file 'pg_xlog/xlogtemp.123': No space left on device
```
 
- [Checking Geo configuration](../geo/replication/troubleshooting.md), including:
Loading
Loading
Loading
Loading
@@ -347,7 +347,7 @@ Gitlab::SidekiqDaemon::Monitor.cancel_job('job-id')
> environment variable.
 
To perform of the interrupt we use `Thread.raise` which
has number of drawbacks, as mentioned in [Why Rubys Timeout is dangerous (and Thread.raise is terrifying)](https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/):
has number of drawbacks, as mentioned in [Why Ruby's Timeout is dangerous (and Thread.raise is terrifying)](https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/):
 
> This is where the implications get interesting, and terrifying. This means that an exception can get raised:
>
Loading
Loading
@@ -357,4 +357,4 @@ has number of drawbacks, as mentioned in [Why Ruby’s Timeout is dangerous (and
> - while creating an object to save to the database afterwards
> - in any of your code, regardless of whether it could have possibly raised an exception before
>
> Nobody writes code to defend against an exception being raised on literally any line. Thats not even possible. So Thread.raise is basically like a sneak attack on your code that could result in almost anything. It would probably be okay if it were pure-functional code that did not modify any state. But this is Ruby, so thats unlikely :)
> Nobody writes code to defend against an exception being raised on literally any line. That's not even possible. So Thread.raise is basically like a sneak attack on your code that could result in almost anything. It would probably be okay if it were pure-functional code that did not modify any state. But this is Ruby, so that's unlikely :)
Loading
Loading
@@ -12,7 +12,7 @@ description: 'Container Registry metadata database'
 
With the [Container Registry](https://gitlab.com/gitlab-org/container-registry) integrated into GitLab, every GitLab project can have its own space to store its Docker images. You can use the registry to build, push and share images using the Docker client, CI/CD or the GitLab API.
 
Each day on GitLab.com, between [150k and 200k images are pushed to the registry](https://app.periscopedata.com/app/gitlab/527857/Package-GitLab.com-Stage-Activity-Dashboard?widget=9620193&udv=0), generating about [700k API events](https://app.periscopedata.com/app/gitlab/527857/Package-GitLab.com-Stage-Activity-Dashboard?widget=7601761&udv=0). Its also worth noting that although some customers use other registry vendors, [more than 96% of instances](https://app.periscopedata.com/app/gitlab/527857/Package-GitLab.com-Stage-Activity-Dashboard?widget=9832282&udv=0) are using the GitLab Container Registry.
Each day on GitLab.com, between [150k and 200k images are pushed to the registry](https://app.periscopedata.com/app/gitlab/527857/Package-GitLab.com-Stage-Activity-Dashboard?widget=9620193&udv=0), generating about [700k API events](https://app.periscopedata.com/app/gitlab/527857/Package-GitLab.com-Stage-Activity-Dashboard?widget=7601761&udv=0). It's also worth noting that although some customers use other registry vendors, [more than 96% of instances](https://app.periscopedata.com/app/gitlab/527857/Package-GitLab.com-Stage-Activity-Dashboard?widget=9832282&udv=0) are using the GitLab Container Registry.
 
For GitLab.com and for GitLab customers, the Container Registry is a critical component to building and deploying software.
 
Loading
Loading
Loading
Loading
@@ -17,7 +17,7 @@ from development to staging, and then to production (or
through any series of custom environment flows you can set up).
With an at-a-glance view of multiple projects, you can instantly
see which pipelines are green and which are red allowing you to
diagnose if there is a block at a particular point, or if theres
diagnose if there is a block at a particular point, or if there's
a more systemic problem you need to investigate.
 
You can access the dashboard from the top bar by clicking
Loading
Loading
Loading
Loading
@@ -166,7 +166,7 @@ For examples of others who have implemented GitLab CI/CD, see:
 
To see how you can integrate GitLab CI/CD with third-party systems, see:
 
- [Streamline and shorten error remediation with Sentrys new GitLab integration](https://about.gitlab.com/blog/2019/01/25/sentry-integration-blog-post/)
- [Streamline and shorten error remediation with Sentry's new GitLab integration](https://about.gitlab.com/blog/2019/01/25/sentry-integration-blog-post/)
- [How to simplify your smart home configuration with GitLab CI/CD](https://about.gitlab.com/blog/2018/08/02/using-the-gitlab-ci-slash-cd-for-smart-home-configuration-management/)
- [Demo: GitLab + Jira + Jenkins](https://about.gitlab.com/blog/2018/07/30/gitlab-workflow-with-jira-jenkins/)
- [Introducing Auto Breakfast from GitLab (sort of)](https://about.gitlab.com/blog/2018/06/29/introducing-auto-breakfast-from-gitlab/)
Loading
Loading
Loading
Loading
@@ -2553,7 +2553,7 @@ the GitLab UI to run.
 
Also in the example, `GIT_STRATEGY` is set to `none`. If the
`stop_review_app` job is [automatically triggered](../environments/index.md#stopping-an-environment),
the runner wont try to check out the code after the branch is deleted.
the runner won't try to check out the code after the branch is deleted.
 
The example also overwrites global variables. If your `stop` `environment` job depends
on global variables, use [anchor variables](#yaml-anchors-for-variables) when you set the `GIT_STRATEGY`
Loading
Loading
@@ -4085,7 +4085,7 @@ job:
 
#### `release:ref`
 
If the `release: tag_name` doesnt exist yet, the release is created from `ref`.
If the `release: tag_name` doesn't exist yet, the release is created from `ref`.
`ref` can be a commit SHA, another tag name, or a branch name.
 
#### `release:milestones`
Loading
Loading
Loading
Loading
@@ -319,7 +319,7 @@ You can also use `workflow::ready for review` label. That means that your merge
When your merge request receives an approval from the first reviewer it can be passed to a maintainer. You should default to choosing a maintainer with [domain expertise](#domain-experts), and otherwise follow the Reviewer Roulette recommendation or use the label `ready for merge`.
 
Sometimes, a maintainer may not be available for review. They could be out of the office or [at capacity](#review-response-slo).
You can and should check the maintainers availability in their profile. If the maintainer recommended by
You can and should check the maintainer's availability in their profile. If the maintainer recommended by
the roulette is not available, choose someone else from that list.
 
It is responsibility of the author of a merge request that the merge request is reviewed. If it stays in `ready for review` state too long it is recommended to assign it to a specific reviewer.
Loading
Loading
Loading
Loading
@@ -149,7 +149,7 @@ Keep the following in mind when submitting merge requests:
- [Documentation](../documentation/styleguide/index.md) style guide.
- [Code style guides](style_guides.md).
- Sometimes style guides will be followed but the code will lack structural integrity, or the
reviewer will have reservations about the codes overall quality. When there is a reservation,
reviewer will have reservations about the code's overall quality. When there is a reservation,
the reviewer will inform the author and provide some guidance.
- Though GitLab generally allows anyone to indicate
[approval](../../user/project/merge_requests/merge_request_approvals.md) of merge requests, the
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