Skip to content

Commit 8c9d19c

Browse files
authored
Merge pull request #21385 from dvdksn/tidy-vale-rules
vale: housekeeping vocabulary and acronyms
2 parents 5ffcf87 + 03120e9 commit 8c9d19c

File tree

24 files changed

+116
-128
lines changed

24 files changed

+116
-128
lines changed

_vale/Docker/Acronyms.yml

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,29 @@ link: https://docs.docker.com/contribute/style/grammar/#acronyms-and-initialisms
44
level: warning
55
ignorecase: false
66
# Ensures that the existence of 'first' implies the existence of 'second'.
7-
first: '\b([A-Z]{3,5})\b'
8-
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
7+
first: '\b([A-Z]{2,5})\b'
8+
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{2,5})\)'
99
# ... with the exception of these:
1010
exceptions:
11+
- AGPL
1112
- API
1213
- ARM
1314
- ASP
1415
- AUFS
1516
- AWS
1617
- BIOS
18+
- CISA
1719
- CLI
20+
- CNCF
21+
- CORS
1822
- CPU
1923
- CSS
2024
- CSV
2125
- CVE
2226
- DCT
2327
- DEBUG
28+
- DHCP
29+
- DNS
2430
- DOM
2531
- DPI
2632
- DSOS
@@ -32,53 +38,84 @@ exceptions:
3238
- GDB
3339
- GET
3440
- GHSA
41+
- GNU
42+
- GPG
43+
- GPL
3544
- GPU
45+
- GRUB
3646
- GTK
3747
- GUI
3848
- HEAD
3949
- HTML
4050
- HTTP
4151
- HTTPS
52+
- IAM
4253
- IDE
54+
- IP
4355
- JAR
4456
- JSON
4557
- JSX
4658
- LESS
4759
- LLDB
60+
- LTS
61+
- MAC
62+
- MDM
63+
- NAT
4864
- NET
4965
- NFS
5066
- NOTE
67+
- NTLM
5168
- NVDA
69+
- OCI
5270
- OSS
5371
- PATH
5472
- PDF
73+
- PEM
5574
- PHP
5675
- POSIX
5776
- POST
77+
- QEMU
5878
- RAM
5979
- REPL
6080
- REST
81+
- RHEL
82+
- RPM
6183
- RSA
84+
- SAML
85+
- SARIF
6286
- SBOM
87+
- SCIM
6388
- SCM
6489
- SCSS
6590
- SDK
91+
- SLES
92+
- SLSA
93+
- SPDX
6694
- SQL
6795
- SSD
6896
- SSH
6997
- SSL
98+
- SSO
7099
- SVG
71100
- TBD
72101
- TCP
102+
- TCP
73103
- TIP
104+
- TLS
74105
- TODO
75106
- TTY
107+
- TXT
108+
- UDP
76109
- URI
77110
- URL
78111
- USB
79112
- USD
80113
- UTF
114+
- UUID
81115
- VAT
116+
- VLAN
117+
- VM
118+
- VPN
82119
- WSL
83120
- XML
84121
- XSS

_vale/Docker/RecommendedWords.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ swap:
3131
check box: checkbox
3232
check boxes: checkboxes
3333
click: select
34+
distro: distribution
3435
ergo: therefore
3536
file name: filename
3637
keypress: keystroke

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 5 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
A?GPL(v3)?
2-
APIs?
3-
ARM
4-
AWS
1+
(?-i)[A-Z]{2,}s
52
Admin Console
63
Amazon
7-
Ambassador
84
Anchore
95
Apple
106
Artifactory
@@ -14,10 +10,6 @@ Azure
1410
Btrfs
1511
BuildKit
1612
BusyBox
17-
CISA
18-
CNCF
19-
CORS
20-
CVEs?
2113
CentOS
2214
Ceph
2315
Chrome
@@ -27,10 +19,6 @@ Codefresh
2719
Codespaces
2820
CouchDB
2921
Couchbase
30-
DHCP
31-
DNS
32-
DSOS
33-
DVP
3422
Datadog
3523
Ddosify
3624
Debootstrap
@@ -55,91 +43,52 @@ Ethernet
5543
Fargate
5644
Fedora
5745
Flink
58-
GPG
59-
GPUs?
60-
GRUB
6146
GeoNetwork
6247
Git
6348
GitHub( Actions)?
6449
Google
6550
Grafana
6651
Gravatar
67-
HTTP
6852
HyperKit
69-
IAM
70-
IPs?
7153
IPv[46]
7254
IPvlan
7355
Intel
7456
Intune
75-
Jamf
7657
JFrog
58+
Jamf
7759
JetBrains
7860
Kerberos
79-
[Kk]eyrings?
8061
Kitematic
8162
Kubernetes
82-
LTS
8363
Linux
8464
LinuxKit
8565
Logstash
86-
MAC
8766
Mac
8867
Mail(chimp|gun)
89-
MDM
9068
Microsoft
9169
MySQL
92-
NAT
9370
Netplan
9471
Nginx
95-
NTLM
9672
Nuxeo
97-
OAT
9873
OAuth
99-
OCI
10074
OTel
10175
Okta
102-
PAT
103-
PEM
10476
Postgres
10577
PowerShell
10678
Python
107-
QEMU
108-
RHEL
109-
RPM
11079
S3
111-
SAML
112-
SARIF
113-
SBOMs?
114-
SCIM
115-
SDKs?
116-
SLES
117-
SLSA
118-
SPDX
11980
SQLite
120-
SSH
121-
SSO
12281
Slack
12382
Snyk
12483
Solr
12584
SonarQube
12685
Syft
12786
Sysdig
128-
TCP
129-
TLS
130-
TXT
13187
Testcontainers
13288
Traefik
133-
UDP
134-
URLs?
135-
UUID
13689
Ubuntu
13790
Unix
138-
VLAN
139-
VM
14091
VMware
141-
VPN
142-
WSL
14392
Wasm
14493
Windows
14594
WireMock
@@ -148,12 +97,13 @@ Zsh
14897
[Bb]uildx
14998
[Cc]odenames?
15099
[Cc]ompose
151-
[Dd]istros
100+
[Dd]istroless
152101
[Ff]ilepaths?
153102
[Ff]iletypes?
154103
[GgCc]oroutine
155104
[Hh]ostname
156105
[Ii]nfosec
106+
[Kk]eyrings?
157107
[Ll]oopback
158108
[Mm]oby
159109
[Oo]nboarding
@@ -165,8 +115,8 @@ Zsh
165115
[Ss]wappable
166116
[Ss]warm
167117
[Tt]oolchains?
168-
[Vv]irtualize
169118
[Vv]irtiofs
119+
[Vv]irtualize
170120
[Ww]alkthrough
171121
cgroup
172122
config

content/manuals/compose/install/linux.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For Compose standalone, see [Install Compose Standalone](standalone.md).
2525

2626
## Install using the repository
2727

28-
1. Set up the repository. Find distro-specific instructions in:
28+
1. Set up the repository. Find distribution-specific instructions in:
2929

3030
[Ubuntu](/manuals/engine/install/ubuntu.md#install-using-the-repository) |
3131
[CentOS](/manuals/engine/install/centos.md#set-up-the-repository) |
@@ -43,7 +43,7 @@ For Compose standalone, see [Install Compose Standalone](standalone.md).
4343
$ sudo apt-get update
4444
$ sudo apt-get install docker-compose-plugin
4545
```
46-
* For RPM-based distros, run:
46+
* For RPM-based distributions, run:
4747

4848
```console
4949
$ sudo yum update
@@ -74,7 +74,7 @@ To update the Compose plugin, run the following commands:
7474
$ sudo apt-get update
7575
$ sudo apt-get install docker-compose-plugin
7676
```
77-
* For RPM-based distros, run:
77+
* For RPM-based distributions, run:
7878

7979
```console
8080
$ sudo yum update

content/manuals/compose/install/uninstall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Ubuntu, Debian:
2424
```console
2525
$ sudo apt-get remove docker-compose-plugin
2626
```
27-
RPM-based distros:
27+
RPM-based distributions:
2828

2929
```console
3030
$ sudo yum remove docker-compose-plugin

content/manuals/compose/releases/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1751,7 +1751,7 @@ For a list of PRs and issues fixed in this release, see [Compose 1.28.3](https:/
17511751

17521752
- Removed `None` entries on exec command.
17531753

1754-
- Added `distro` package to get distro information.
1754+
- Added `distribution` package to get distribution information.
17551755

17561756
- Added `python-dotenv` to delegate `.env` file processing.
17571757

content/manuals/desktop/features/wsl/_index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ Now `docker` commands work from Windows using the new WSL 2 engine.
5858
> If you want to change the location, for example, to another drive you can do so via the `Settings -> Resources -> Advanced` page from the Docker Dashboard.
5959
> Read more about this and other Windows settings at [Changing settings](/manuals/desktop/settings-and-maintenance/settings.md)
6060
61-
## Enabling Docker support in WSL 2 distros
61+
## Enabling Docker support in WSL 2 distributions
6262

63-
WSL 2 adds support for "Linux distros" to Windows, where each distro behaves like a VM except they all run on top of a single shared Linux kernel.
63+
WSL 2 adds support for "Linux distributions" to Windows, where each distribution behaves like a VM except they all run on top of a single shared Linux kernel.
6464

65-
Docker Desktop does not require any particular Linux distros to be installed. The `docker` CLI and UI all work fine from Windows without any additional Linux distros. However for the best developer experience, we recommend installing at least one additional distro and enable Docker support:
65+
Docker Desktop does not require any particular Linux distributions to be installed. The `docker` CLI and UI all work fine from Windows without any additional Linux distributions. However for the best developer experience, we recommend installing at least one additional distribution and enable Docker support:
6666

6767
1. Ensure the distribution runs in WSL 2 mode. WSL can run distributions in both v1 or v2 mode.
6868

@@ -72,10 +72,10 @@ Docker Desktop does not require any particular Linux distros to be installed. Th
7272
$ wsl.exe -l -v
7373
```
7474

75-
To upgrade the Linux distro to v2, run:
75+
To upgrade the Linux distribution to v2, run:
7676

7777
```console
78-
$ wsl.exe --set-version (distro name) 2
78+
$ wsl.exe --set-version (distribution name) 2
7979
```
8080

8181
To set v2 as the default version for future installations, run:
@@ -86,19 +86,19 @@ Docker Desktop does not require any particular Linux distros to be installed. Th
8686

8787
2. When Docker Desktop starts, go to **Settings** > **Resources** > **WSL Integration**.
8888

89-
The Docker-WSL integration is enabled on the default WSL distribution, which is [Ubuntu](https://learn.microsoft.com/en-us/windows/wsl/install). To change your default WSL distro, run:
89+
The Docker-WSL integration is enabled on the default WSL distribution, which is [Ubuntu](https://learn.microsoft.com/en-us/windows/wsl/install). To change your default WSL distribution, run:
9090
```console
91-
$ wsl --set-default <distro name>
91+
$ wsl --set-default <distribution name>
9292
```
9393

9494
3. Select **Apply & Restart**.
9595

9696
> [!NOTE]
9797
>
98-
> With Docker Desktop version 4.30 and earlier, Docker Desktop installed two special-purpose internal Linux distros `docker-desktop` and `docker-desktop-data`. `docker-desktop` is used to run the Docker engine `dockerd`, while `docker-desktop-data` stores containers and images. Neither can be used for general development.
98+
> With Docker Desktop version 4.30 and earlier, Docker Desktop installed two special-purpose internal Linux distributions `docker-desktop` and `docker-desktop-data`. `docker-desktop` is used to run the Docker engine `dockerd`, while `docker-desktop-data` stores containers and images. Neither can be used for general development.
9999
>
100100
> With fresh installations of Docker Desktop 4.30 and later, `docker-desktop-data` is no longer created. Instead, Docker Desktop creates and
101-
> manages its own virtual hard disk for storage. The `docker-desktop` distro is still created and used to run the Docker engine.
101+
> manages its own virtual hard disk for storage. The `docker-desktop` distribution is still created and used to run the Docker engine.
102102
>
103103
> Note that Docker Desktop version 4.30 and later keeps using the `docker-desktop-data` distribution if it was already created by an earlier version of Docker Desktop and has not been freshly installed or factory reset.
104104

content/manuals/desktop/features/wsl/use-wsl.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ aliases:
66
- /desktop/wsl/use-wsl/
77
---
88

9-
The following section describes how to start developing your applications using Docker and WSL 2. We recommend that you have your code in your default Linux distribution for the best development experience using Docker and WSL 2. After you have turned on the WSL 2 feature on Docker Desktop, you can start working with your code inside the Linux distro and ideally with your IDE still in Windows. This workflow is straightforward if you are using [VS Code](https://code.visualstudio.com/download).
9+
The following section describes how to start developing your applications using Docker and WSL 2. We recommend that you have your code in your default Linux distribution for the best development experience using Docker and WSL 2. After you have turned on the WSL 2 feature on Docker Desktop, you can start working with your code inside the Linux distribution and ideally with your IDE still in Windows. This workflow is straightforward if you are using [VS Code](https://code.visualstudio.com/download).
1010

1111
## Develop with Docker and WSL 2
1212

13-
1. Open VS Code and install the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension. This extension lets you work with a remote server in the Linux distro and your IDE client still on Windows.
13+
1. Open VS Code and install the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension. This extension lets you work with a remote server in the Linux distribution and your IDE client still on Windows.
1414
2. Open your terminal and type:
1515

1616
```console
@@ -22,7 +22,7 @@ The following section describes how to start developing your applications using
2222
$ code .
2323
```
2424

25-
This opens a new VS Code window connected remotely to your default Linux distro which you can check in the bottom corner of the screen.
25+
This opens a new VS Code window connected remotely to your default Linux distribution which you can check in the bottom corner of the screen.
2626

2727

2828
Alternatively, you can open your default Linux distribution from the **Start** menu, navigate to your project directory, and then run `code .`

0 commit comments

Comments
 (0)