Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
fbf879c
releaser: update go to 1.23 and update dependencies
crazy-max Nov 7, 2024
b759ac6
releaser(aws): remove type assertion on errors
crazy-max Nov 7, 2024
0ec23df
Update new-plans.md callouts for Dec. 10th date
sarahsanders-docker Nov 7, 2024
94d72ed
Fix callout in Hub guide
sarahsanders-docker Nov 8, 2024
8946175
chore: fix "norway problem" in new guide issue template
dvdksn Nov 8, 2024
473a19c
chore: use dynamic api version in example
dvdksn Nov 8, 2024
473edab
chore: sort vale vocabulary
dvdksn Nov 8, 2024
f4878e6
vale: remove PAT and OAT from vocabulary
dvdksn Nov 8, 2024
b5364b3
vale: remove Ambassador from vocabulary
dvdksn Nov 8, 2024
64736e4
style: s/distro/distribution/g
dvdksn Nov 8, 2024
7b7ef84
vale: suggest "distribution" over "distro"
dvdksn Nov 8, 2024
d2038b4
vale: add distroless to vocabulary
dvdksn Nov 8, 2024
1829e85
vale: add GNU to acronym exceptions
dvdksn Nov 8, 2024
9f87432
vale: move acronyms from vocabulary to Acronyms rule
dvdksn Nov 8, 2024
e9effe9
vale: remove AGPLv3 from vocabulary
dvdksn Nov 8, 2024
d3d0b96
vale: add GPL, AGPL to acronym exceptions
dvdksn Nov 8, 2024
c646f07
vale: add pluralized acronyms to vocabulary
dvdksn Nov 8, 2024
8e2705b
vale: also check for two-letter acronyms
dvdksn Nov 8, 2024
03120e9
vale: move IP from vocabulary to Acronyms rule
dvdksn Nov 8, 2024
8c9d19c
Merge pull request #21385 from dvdksn/tidy-vale-rules
dvdksn Nov 8, 2024
84917b1
Merge pull request #21378 from dvdksn/fix-new-guide-issue-tpl
dvdksn Nov 8, 2024
16c86ec
Merge pull request #21379 from dvdksn/dynamic-api-version-example
thaJeztah Nov 8, 2024
a955d1b
Merge pull request #21358 from crazy-max/releaser-bump-deps
dvdksn Nov 11, 2024
4121679
remove banner (#21395)
aevesdocker Nov 11, 2024
d4c7e4a
Update VMM page (#21396)
Nov 11, 2024
ee41406
hub: refresh quickstart (#21374)
craig-osterhout Nov 11, 2024
524b00f
Merge pull request #21370 from sarahsanders-docker/ENGDOCS-2288
sarahsanders-docker Nov 11, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new_guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ body:
and someone (a Docker employee, Docker captain, or community member)
may pick it up and start working on it.
options:
- label: Yes
- label: "Yes"
2 changes: 1 addition & 1 deletion _releaser/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# syntax=docker/dockerfile:1

ARG GO_VERSION=1.19
ARG GO_VERSION=1.23

FROM scratch AS sitedir

Expand Down
6 changes: 4 additions & 2 deletions _releaser/aws.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"archive/zip"
"bytes"
"encoding/json"
"errors"
"fmt"
"log"
"os"
Expand Down Expand Up @@ -143,13 +144,14 @@ func (s *AwsCloudfrontUpdateCmd) Run() error {
FunctionName: aws.String(s.Function),
})
if err != nil {
if aerr, ok := err.(awserr.Error); ok && aerr.Code() != lambda.ErrCodeResourceNotFoundException {
var aerr awserr.Error
if errors.As(err, &aerr) && aerr.Code() != lambda.ErrCodeResourceNotFoundException {
return fmt.Errorf("cannot find lambda function %q: %w", s.Function, err)
}
_, err = svc.CreateFunction(&lambda.CreateFunctionInput{
FunctionName: aws.String(s.Function),
})
if aerr, ok := err.(awserr.Error); ok && aerr.Code() != lambda.ErrCodeResourceConflictException {
if errors.As(err, &aerr) && aerr.Code() != lambda.ErrCodeResourceConflictException {
return err
}
}
Expand Down
7 changes: 3 additions & 4 deletions _releaser/go.mod
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
module github.com/docker/docs/_releaser

go 1.18
go 1.22

require (
github.com/alecthomas/kong v0.7.1
github.com/aws/aws-sdk-go v1.44.180
github.com/alecthomas/kong v1.4.0
github.com/aws/aws-sdk-go v1.55.5
)

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/jmespath/go-jmespath v0.4.0 // indirect
golang.org/x/net v0.17.0 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
)
46 changes: 9 additions & 37 deletions _releaser/go.sum
Original file line number Diff line number Diff line change
@@ -1,51 +1,23 @@
github.com/alecthomas/assert/v2 v2.1.0 h1:tbredtNcQnoSd3QBhQWI7QZ3XHOVkw1Moklp2ojoH/0=
github.com/alecthomas/kong v0.7.1 h1:azoTh0IOfwlAX3qN9sHWTxACE2oV8Bg2gAwBsMwDQY4=
github.com/alecthomas/kong v0.7.1/go.mod h1:n1iCIO2xS46oE8ZfYCNDqdR0b0wZNrXAIAqro/2132U=
github.com/alecthomas/repr v0.1.0 h1:ENn2e1+J3k09gyj2shc0dHr/yjaWSHRlrJ4DPMevDqE=
github.com/aws/aws-sdk-go v1.44.180 h1:VLZuAHI9fa/3WME5JjpVjcPCNfpGHVMiHx8sLHWhMgI=
github.com/aws/aws-sdk-go v1.44.180/go.mod h1:aVsgQcEevwlmQ7qHE9I3h+dtQgpqhFB+i8Phjh7fkwI=
github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8vS6K3D0=
github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
github.com/alecthomas/kong v1.4.0 h1:UL7tzGMnnY0YRMMvJyITIRX1EpO6RbBRZDNcCevy3HA=
github.com/alecthomas/kong v1.4.0/go.mod h1:p2vqieVMeTAnaC83txKtXe8FLke2X07aruPWXyMPQrU=
github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc=
github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
github.com/aws/aws-sdk-go v1.55.5 h1:KKUZBfBoyqy5d3swXyiC7Q76ic40rYcbqH7qjh59kzU=
github.com/aws/aws-sdk-go v1.55.5/go.mod h1:eRwEWoyTWFMVYVQzKMNHWP5/RV4xIUGMQfXQHfHkpNU=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco=
golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
Expand Down
41 changes: 39 additions & 2 deletions _vale/Docker/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,29 @@ link: https://docs.docker.com/contribute/style/grammar/#acronyms-and-initialisms
level: warning
ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
first: '\b([A-Z]{2,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{2,5})\)'
# ... with the exception of these:
exceptions:
- AGPL
- API
- ARM
- ASP
- AUFS
- AWS
- BIOS
- CISA
- CLI
- CNCF
- CORS
- CPU
- CSS
- CSV
- CVE
- DCT
- DEBUG
- DHCP
- DNS
- DOM
- DPI
- DSOS
Expand All @@ -32,53 +38,84 @@ exceptions:
- GDB
- GET
- GHSA
- GNU
- GPG
- GPL
- GPU
- GRUB
- GTK
- GUI
- HEAD
- HTML
- HTTP
- HTTPS
- IAM
- IDE
- IP
- JAR
- JSON
- JSX
- LESS
- LLDB
- LTS
- MAC
- MDM
- NAT
- NET
- NFS
- NOTE
- NTLM
- NVDA
- OCI
- OSS
- PATH
- PDF
- PEM
- PHP
- POSIX
- POST
- QEMU
- RAM
- REPL
- REST
- RHEL
- RPM
- RSA
- SAML
- SARIF
- SBOM
- SCIM
- SCM
- SCSS
- SDK
- SLES
- SLSA
- SPDX
- SQL
- SSD
- SSH
- SSL
- SSO
- SVG
- TBD
- TCP
- TCP
- TIP
- TLS
- TODO
- TTY
- TXT
- UDP
- URI
- URL
- USB
- USD
- UTF
- UUID
- VAT
- VLAN
- VM
- VPN
- WSL
- XML
- XSS
Expand Down
1 change: 1 addition & 0 deletions _vale/Docker/RecommendedWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ swap:
check box: checkbox
check boxes: checkboxes
click: select
distro: distribution
ergo: therefore
file name: filename
keypress: keystroke
Expand Down
60 changes: 5 additions & 55 deletions _vale/config/vocabularies/Docker/accept.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
A?GPL(v3)?
APIs?
ARM
AWS
(?-i)[A-Z]{2,}s
Admin Console
Amazon
Ambassador
Anchore
Apple
Artifactory
Expand All @@ -14,10 +10,6 @@ Azure
Btrfs
BuildKit
BusyBox
CISA
CNCF
CORS
CVEs?
CentOS
Ceph
Chrome
Expand All @@ -27,10 +19,6 @@ Codefresh
Codespaces
CouchDB
Couchbase
DHCP
DNS
DSOS
DVP
Datadog
Ddosify
Debootstrap
Expand All @@ -55,91 +43,52 @@ Ethernet
Fargate
Fedora
Flink
GPG
GPUs?
GRUB
GeoNetwork
Git
GitHub( Actions)?
Google
Grafana
Gravatar
HTTP
HyperKit
IAM
IPs?
IPv[46]
IPvlan
Intel
Intune
Jamf
JFrog
Jamf
JetBrains
Kerberos
[Kk]eyrings?
Kitematic
Kubernetes
LTS
Linux
LinuxKit
Logstash
MAC
Mac
Mail(chimp|gun)
MDM
Microsoft
MySQL
NAT
Netplan
Nginx
NTLM
Nuxeo
OAT
OAuth
OCI
OTel
Okta
PAT
PEM
Postgres
PowerShell
Python
QEMU
RHEL
RPM
S3
SAML
SARIF
SBOMs?
SCIM
SDKs?
SLES
SLSA
SPDX
SQLite
SSH
SSO
Slack
Snyk
Solr
SonarQube
Syft
Sysdig
TCP
TLS
TXT
Testcontainers
Traefik
UDP
URLs?
UUID
Ubuntu
Unix
VLAN
VM
VMware
VPN
WSL
Wasm
Windows
WireMock
Expand All @@ -148,12 +97,13 @@ Zsh
[Bb]uildx
[Cc]odenames?
[Cc]ompose
[Dd]istros
[Dd]istroless
[Ff]ilepaths?
[Ff]iletypes?
[GgCc]oroutine
[Hh]ostname
[Ii]nfosec
[Kk]eyrings?
[Ll]oopback
[Mm]oby
[Oo]nboarding
Expand All @@ -165,8 +115,8 @@ Zsh
[Ss]wappable
[Ss]warm
[Tt]oolchains?
[Vv]irtualize
[Vv]irtiofs
[Vv]irtualize
[Ww]alkthrough
cgroup
config
Expand Down
Loading
Loading