Commit ac011a06 authored by Marcel Amirault's avatar Marcel Amirault

Merge branch '276199-vale-acronym-rule' into 'master'

Docs - clean up some warnings detected by the Vale Acronym rule

See merge request gitlab-org/gitlab!49531
parents 2695d26e ca7f4a99
...@@ -14,6 +14,7 @@ first: '\b([A-Z]{3,5})\b' ...@@ -14,6 +14,7 @@ first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these: # ... with the exception of these:
exceptions: exceptions:
- AJAX
- ANSI - ANSI
- API - API
- ARM - ARM
...@@ -21,11 +22,14 @@ exceptions: ...@@ -21,11 +22,14 @@ exceptions:
- ASCII - ASCII
- AWS - AWS
- BSD - BSD
- CAS
- CLI - CLI
- CNA - CNA
- CNAME - CNAME
- CORE - CORE
- CPU - CPU
- CRIME
- CSRF
- CSS - CSS
- CSV - CSV
- CVE - CVE
...@@ -33,19 +37,28 @@ exceptions: ...@@ -33,19 +37,28 @@ exceptions:
- DAST - DAST
- DHCP - DHCP
- DNS - DNS
- DOM
- DSA
- DVCS - DVCS
- ECDSA
- EKS - EKS
- EOL - EOL
- EXIF
- FAQ - FAQ
- FOSS - FOSS
- FQDN
- GCP - GCP
- GDK - GDK
- GDPR
- GET - GET
- GIF - GIF
- GKE - GKE
- GNU - GNU
- GPG - GPG
- GPL - GPL
- GUI
- HAML
- HIPAA
- HTML - HTML
- HTTP - HTTP
- HTTPS - HTTPS
...@@ -55,11 +68,13 @@ exceptions: ...@@ -55,11 +68,13 @@ exceptions:
- IDE - IDE
- IID - IID
- IMAP - IMAP
- IOPS
- IRC - IRC
- ISO - ISO
- JPEG - JPEG
- JPG - JPG
- JSON - JSON
- JWT
- LAN - LAN
- LDAP - LDAP
- LDAPS - LDAPS
...@@ -76,17 +91,25 @@ exceptions: ...@@ -76,17 +91,25 @@ exceptions:
- NOTE - NOTE
- NPM - NPM
- ONLY - ONLY
- OWASP
- PAT
- PCI-DSS
- PDF - PDF
- PEM
- PEP
- PGP - PGP
- PHP - PHP
- PNG - PNG
- POST - POST
- PUT - PUT
- RAM - RAM
- RDP
- REST - REST
- RFC
- RHEL - RHEL
- RPC - RPC
- RPM - RPM
- RPS
- RSA - RSA
- RSS - RSS
- RVM - RVM
...@@ -101,8 +124,12 @@ exceptions: ...@@ -101,8 +124,12 @@ exceptions:
- SLA - SLA
- SMS - SMS
- SMTP - SMTP
- SOC
- SOX
- SPF
- SQL - SQL
- SSD - SSD
- SSG
- SSH - SSH
- SSL - SSL
- SSO - SSO
...@@ -119,9 +146,12 @@ exceptions: ...@@ -119,9 +146,12 @@ exceptions:
- URL - URL
- USB - USB
- UTC - UTC
- UTF
- UUID - UUID
- VCS
- VPC - VPC
- WIP - WIP
- WSL - WSL
- XML - XML
- XSS
- YAML - YAML
...@@ -300,6 +300,7 @@ NGINX ...@@ -300,6 +300,7 @@ NGINX
Nokogiri Nokogiri
npm npm
Nurtch Nurtch
nyc
OAuth OAuth
offboarded offboarded
offboarding offboarding
......
...@@ -159,7 +159,7 @@ later, can be written with `go env -w <var>=<value>`. For example, ...@@ -159,7 +159,7 @@ later, can be written with `go env -w <var>=<value>`. For example,
Go modules and module versions are defined by source repositories, such as Git, Go modules and module versions are defined by source repositories, such as Git,
SVN, and Mercurial. A module is a repository that contains `go.mod` and Go SVN, and Mercurial. A module is a repository that contains `go.mod` and Go
files. Module versions are defined by VCS tags. files. Module versions are defined by version control system (VCS) tags.
To publish a module, push `go.mod` and source files to a VCS repository. To To publish a module, push `go.mod` and source files to a VCS repository. To
publish a module version, push a VCS tag. publish a module version, push a VCS tag.
......
...@@ -28,7 +28,7 @@ The paths here are simply Git's built-in [`.gitattributes` interface](https://gi ...@@ -28,7 +28,7 @@ The paths here are simply Git's built-in [`.gitattributes` interface](https://gi
/Nicefile gitlab-language=ruby /Nicefile gitlab-language=ruby
``` ```
To disable highlighting entirely, use `gitlab-language=text`. Lots more fun shenanigans are available through CGI options, such as: To disable highlighting entirely, use `gitlab-language=text`. Lots more fun shenanigans are available through common gateway interface (CGI) options, such as:
``` conf ``` conf
# json with erb in it # json with erb in it
......
...@@ -60,7 +60,7 @@ the `filename` of a `class` element contains the full path relative to the proje ...@@ -60,7 +60,7 @@ the `filename` of a `class` element contains the full path relative to the proje
### JavaScript example ### JavaScript example
The following [`gitlab-ci.yml`](../../../ci/yaml/README.md) example uses [Mocha](https://mochajs.org/) The following [`gitlab-ci.yml`](../../../ci/yaml/README.md) example uses [Mocha](https://mochajs.org/)
JavaScript testing and [NYC](https://github.com/istanbuljs/nyc) coverage-tooling to JavaScript testing and [nyc](https://github.com/istanbuljs/nyc) coverage-tooling to
generate the coverage artifact: generate the coverage artifact:
```yaml ```yaml
......
...@@ -17,7 +17,7 @@ it secured by HTTPS, you will have to issue a certificate for that ...@@ -17,7 +17,7 @@ it secured by HTTPS, you will have to issue a certificate for that
(sub)domain and install it on your project. (sub)domain and install it on your project.
NOTE: NOTE:
Certificates are NOT required to add to your custom Certificates are **not** required to add to your custom
(sub)domain on your GitLab Pages project, though they are (sub)domain on your GitLab Pages project, though they are
highly recommendable. highly recommendable.
......
...@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Create a Pages website from a forked sample # Create a Pages website from a forked sample
GitLab provides [sample projects for the most popular Static Site Generators](https://gitlab.com/pages). GitLab provides [sample projects for the most popular Static Site Generators (SSG)](https://gitlab.com/pages).
You can fork one of the sample projects and run the CI/CD pipeline to generate a Pages website. You can fork one of the sample projects and run the CI/CD pipeline to generate a Pages website.
Fork a sample project when you want to test GitLab Pages or start a new project that's already Fork a sample project when you want to test GitLab Pages or start a new project that's already
......
...@@ -13,7 +13,7 @@ This method is still valid but was **deprecated** in favor of the ...@@ -13,7 +13,7 @@ This method is still valid but was **deprecated** in favor of the
introduced in GitLab 12.1. introduced in GitLab 12.1.
If you have a GitLab Pages website served under your own domain, If you have a GitLab Pages website served under your own domain,
you might want to secure it with a SSL/TSL certificate. you might want to secure it with a SSL/TLS certificate.
[Let's Encrypt](https://letsencrypt.org) is a free, automated, and [Let's Encrypt](https://letsencrypt.org) is a free, automated, and
open source Certificate Authority. open source Certificate Authority.
......
...@@ -32,7 +32,7 @@ When you are satisfied with your new file, click **Commit Changes** at the botto ...@@ -32,7 +32,7 @@ When you are satisfied with your new file, click **Commit Changes** at the botto
### Shortcuts ### Shortcuts
You can use handy shortcuts when editing a file through the Web Editor, which are the same as You can use handy shortcuts when editing a file through the Web Editor, which are the same as
the WEB IDE's. For details, see the documentation for [Command Palette](../web_ide/index.md#command-palette). the Web IDE's. For details, see the documentation for [Command Palette](../web_ide/index.md#command-palette).
### Template dropdowns ### Template dropdowns
......
...@@ -119,7 +119,7 @@ The following items will be exported: ...@@ -119,7 +119,7 @@ The following items will be exported:
- Pipelines history - Pipelines history
- Push Rules - Push Rules
The following items will NOT be exported: The following items will **not** be exported:
- Build traces and artifacts - Build traces and artifacts
- Container registry images - Container registry images
......
...@@ -31,11 +31,11 @@ The project description also partially supports [standard Markdown](../../markdo ...@@ -31,11 +31,11 @@ The project description also partially supports [standard Markdown](../../markdo
You can select a framework label to identify that your project has certain compliance requirements or needs additional oversight. Available labels include: You can select a framework label to identify that your project has certain compliance requirements or needs additional oversight. Available labels include:
- GDPR - General Data Protection Regulation - GDPR (General Data Protection Regulation)
- HIPAA - Health Insurance Portability and Accountability Act - HIPAA (Health Insurance Portability and Accountability Act)
- PCI-DSS - Payment Card Industry-Data Security Standard - PCI-DSS (Payment Card Industry-Data Security Standard)
- SOC 2 - Service Organization Control 2 - SOC 2 (Service Organization Control 2)
- SOX - Sarbanes-Oxley - SOX (Sarbanes-Oxley)
NOTE: NOTE:
Compliance framework labels do not affect your project settings. Compliance framework labels do not affect your project settings.
......
...@@ -226,4 +226,4 @@ Example for `_sidebar` (using Markdown format): ...@@ -226,4 +226,4 @@ Example for `_sidebar` (using Markdown format):
- [Sidebar](_sidebar) - [Sidebar](_sidebar)
``` ```
Support for displaying a generated TOC with a custom side navigation is planned. Support for displaying a generated table of contents with a custom side navigation is planned.
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