Skip to content

Commit

Permalink
Merge pull request #21022 from dvdksn/chorework-24q3
Browse files Browse the repository at this point in the history
chore: dependency updates and vale tweaks
  • Loading branch information
dvdksn authored Sep 30, 2024
2 parents 099d2bf + e6af352 commit 29eff6b
Show file tree
Hide file tree
Showing 19 changed files with 146 additions and 125 deletions.
12 changes: 10 additions & 2 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@ MinAlertLevel = suggestion

Vocab = Docker

Packages = Hugo

[*.md]
BasedOnStyles = Vale, Docker
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
(\[.+\]\({{< .+ >}}\)), \
[^\S\r\n]({{[%<] \w+ .+ [%>]}})\s, \
[^\S\r\n]({{[%<](?:/\*) .* (?:\*/)[%>]}})\s, \
(?sm)({{[%<] .*?\s[%>]}})

# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
8 changes: 4 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# ALPINE_VERSION sets the Alpine Linux version for all Alpine stages
ARG ALPINE_VERSION=3.20
# GO_VERSION sets the Go version for the base stage
ARG GO_VERSION=1.22
ARG GO_VERSION=1.23
# HTML_TEST_VERSION sets the wjdp/htmltest version for HTML testing
ARG HTMLTEST_VERSION=0.17.0

Expand All @@ -21,7 +21,7 @@ RUN npm install

# hugo downloads and extracts the Hugo binary
FROM base AS hugo
ARG HUGO_VERSION=0.132.0
ARG HUGO_VERSION=0.134.3
ARG TARGETARCH
WORKDIR /tmp/hugo
RUN wget -O "hugo.tar.gz" "https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-${TARGETARCH}.tar.gz"
Expand All @@ -45,7 +45,7 @@ ARG DOCS_URL
RUN hugo --gc --minify -d /out -e $HUGO_ENV -b $DOCS_URL

# lint lints markdown files
FROM davidanson/markdownlint-cli2:v0.13.0 AS lint
FROM davidanson/markdownlint-cli2:v0.14.0 AS lint
USER root
RUN --mount=type=bind,target=. \
/usr/local/bin/markdownlint-cli2 \
Expand Down Expand Up @@ -123,7 +123,7 @@ EOT

# pagefind installs the Pagefind runtime
FROM base AS pagefind
ARG PAGEFIND_VERSION=1.1.0
ARG PAGEFIND_VERSION=1.1.1
COPY --from=build /out ./public
RUN --mount=type=bind,src=pagefind.yml,target=pagefind.yml \
npx pagefind@v${PAGEFIND_VERSION} --output-path "/pagefind"
Expand Down
9 changes: 7 additions & 2 deletions _vale/Docker/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ 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-Za-z]+(?: |\n))+\(([A-Z]{3,5})\)'
first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- API
- ARM
- ASP
- AUFS
- AWS
- BIOS
- CLI
Expand Down Expand Up @@ -45,6 +46,7 @@ exceptions:
- LESS
- LLDB
- NET
- NFS
- NOTE
- NVDA
- OSS
Expand All @@ -62,16 +64,19 @@ exceptions:
- SCSS
- SDK
- SQL
- SSD
- SSH
- SSL
- SVG
- TBD
- TCP
- TIP
- TODO
- TTY
- URI
- URL
- USB
- USD
- UTF
- VAT
- WSL
Expand Down
6 changes: 4 additions & 2 deletions _vale/config/vocabularies/Docker/accept.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
A?GPL(v3)?
APIs?
ARM
Netplan
AWS
Admin Console
Amazon
Expand All @@ -12,6 +11,7 @@ Artifactory
Autobuild
Autotest
Azure
Btrfs
BuildKit
BusyBox
CISA
Expand All @@ -35,7 +35,6 @@ Ddosify
Debootstrap
Dev Environments?
Django
Docker's
Docker Build Cloud
Docker Business
Docker Dasboard
Expand All @@ -45,6 +44,7 @@ Docker Extension
Docker Hub
Docker Scout
Docker Team
Docker's
Docker-Sponsored Open Source
Dockerfile
Dockerize
Expand Down Expand Up @@ -83,6 +83,7 @@ Mail(chimp|gun)
Microsoft
MySQL
NAT
Netplan
Nginx
Nuxeo
OAuth
Expand Down Expand Up @@ -176,6 +177,7 @@ npm
osquery
osxfs
runc
snapshotters?
stdin
stdout
subnet
Expand Down
8 changes: 4 additions & 4 deletions content/contribute/components/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ grid:
icon: "database"
description: Icon name = database
- title: "logs"
icon: "feed"
description: Icon name = feed
icon: "text_snippet"
description: Icon name = text_snippet
- title: "Prune/cut"
icon: "cut"
description: Icon name = cut
icon: "content_cut"
description: Icon name = content_cut
- title: "Configure"
icon: "tune"
description: Icon name = tune
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ grid:
link: /admin/organization/members/
- title: Activity logs
description: Learn how to audit the activities of your members.
icon: feed
icon: text_snippet
link: /admin/organization/activity-logs/
- title: Image Access Management
description: Control which types of images your developers can pull.
Expand Down
4 changes: 2 additions & 2 deletions content/manuals/engine/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ grid:
link: /network
- title: Container logs
description: Learn how to view and read container logs.
icon: feed
icon: text_snippet
link: /config/containers/logging/
- title: Prune
description: Tidy up unused resources.
icon: cut
icon: content_cut
link: /config/pruning
- title: Configure the daemon
description: Delve into the configuration options of the Docker daemon.
Expand Down
24 changes: 14 additions & 10 deletions content/manuals/engine/storage/drivers/device-mapper-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,11 @@ After you have satisfied the [prerequisites](#prerequisites), follow the steps
below to configure Docker to use the `devicemapper` storage driver in
`direct-lvm` mode.

> [!WARNING]: Changing the storage driver makes any containers you have already
created inaccessible on the local system. Use `docker save` to save containers,
and push existing images to Docker Hub or a private repository, so you do not
need to recreate them later.
> [!WARNING]
> Changing the storage driver makes any containers you have already
> created inaccessible on the local system. Use `docker save` to save containers,
> and push existing images to Docker Hub or a private repository, so you do not
> need to recreate them later.

#### Allow Docker to configure direct-lvm mode

Expand Down Expand Up @@ -191,8 +192,9 @@ See all storage options for each storage driver in the
Restart Docker for the changes to take effect. Docker invokes the commands to
configure the block device for you.

> [!WARNING]: Changing these values after Docker has prepared the block device
> for you is not supported and causes an error.
> [!WARNING]
> Changing these values after Docker has prepared the block device for you is
> not supported and causes an error.
You still need to [perform periodic maintenance tasks](#manage-devicemapper).

Expand Down Expand Up @@ -227,8 +229,9 @@ assumes that the Docker daemon is in the `stopped` state.
4. Create a physical volume on your block device from step 1, using the
`pvcreate` command. Substitute your device name for `/dev/xvdf`.

> [!WARNING]: The next few steps are destructive, so be sure that you have
> specified the correct device!
> [!WARNING]
> The next few steps are destructive, so be sure that you have specified
> the correct device.

```console
$ sudo pvcreate /dev/xvdf
Expand Down Expand Up @@ -651,7 +654,8 @@ $ sudo lvchange -ay docker/thinpool

## How the `devicemapper` storage driver works

> [!WARNING]: Do not directly manipulate any files or directories within
> [!WARNING]
> Do not directly manipulate any files or directories within
> `/var/lib/docker/`. These files and directories are managed by Docker.
Use the `lsblk` command to see the devices and their pools, from the operating
Expand Down Expand Up @@ -835,7 +839,7 @@ storage driver.
files generated by a container are still stored in Docker's dataroot directory,
by default `/var/lib/docker`. If your containers generate lots of log messages,
this may lead to increased disk usage or the inability to manage your system due
to a full disk. You can configure a
to a full disk. You can configure a
[log driver](/manuals/engine/logging/configure.md) to store your container
logs externally.

Expand Down
2 changes: 1 addition & 1 deletion content/reference/compose-file/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ toc_min: 1
grid:
- title: Version and name top-level element
description: Understand version and name attributes for Compose.
icon: feed
icon: text_snippet
link: /reference/compose-file/version-and-name/
- title: Services top-level element
description: Explore all services attributes for Compose.
Expand Down
4 changes: 1 addition & 3 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
module github.com/docker/docs

go 1.21.0

toolchain go1.22.5
go 1.23.1

require (
github.com/docker/buildx v0.17.1 // indirect
Expand Down
4 changes: 2 additions & 2 deletions layouts/_default/_markup/render-codeblock.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@
<button @click="collapse = false"
class="flex items-center rounded-full bg-blue-light px-2 text-sm text-white dark:bg-blue-dark-400">
<span>Show more</span>
<span class="icon-svg">{{ partialCached "icon" "expand_more" "expand_more" }}</span>
<span class="icon-svg">{{ partialCached "icon" "arrow_drop_down" "arrow_drop_down" }}</span>
</button>
</div>
<div :class="{ 'h-32': collapse }">
{{ $result }}
<button @click="collapse = true" x-show="!collapse"
class="mx-auto -mt-4 flex items-center rounded-b-lg bg-blue-light px-2 text-sm text-white dark:bg-blue-dark-400">
<span>Hide</span>
<span class="icon-svg">{{ partialCached "icon" "expand_less" "expand_less" }}</span>
<span class="icon-svg">{{ partialCached "icon" "arrow_drop_up" "arrow_drop_up" }}</span>
</button>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions layouts/partials/components/accordion.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
{{- end }}
{{ .title }}
</div>
<span :class="{ 'hidden' : !open }" class="icon-svg">{{ partialCached "icon" "expand_less" "expand_less" }}</span>
<span :class="{ 'hidden' : open }" class="icon-svg">{{ partialCached "icon" "expand_more" "expand_more" }}</span>
<span :class="{ 'hidden' : !open }" class="icon-svg">{{ partialCached "icon" "arrow_drop_up" "arrow_drop_up" }}</span>
<span :class="{ 'hidden' : open }" class="icon-svg">{{ partialCached "icon" "arrow_drop_down" "arrow_drop_down" }}</span>
</button>
<div x-show="open" x-collapse class="px-4">
{{ markdownify .body }}
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/github-links.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
{{ end }}
{{ end }}
<p class="flex items-center gap-2">
<span class="icon-svg">{{ partialCached "icon" "done" "done" }}</span>
<span class="icon-svg">{{ partialCached "icon" "check" "check" }}</span>
<a class="link" target="_blank" rel="noopener"
href="{{ site.Params.repo }}/issues/new?template=doc_issue.yml&location={{ .Permalink }}&labels=status%2Ftriage">{{- T "requestChanges" -}}
<span class="icon-svg icon-sm">
Expand Down
8 changes: 4 additions & 4 deletions layouts/partials/pagination.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
<li>
<a class="{{ $selectable }}" href="{{ .URL }}" aria-label="First">
<span class="icon-svg">
{{- partialCached "icon" "navigate_before" "navigate_before" -}}
{{- partialCached "icon" "chevron_backward" "chevron_backward" -}}
</span>
</a>
</li>
{{- else }}
<li>
<a class="{{ $disabled }}" aria-disabled="true" aria-label="First">
<span class="icon-svg">
{{- partialCached "icon" "navigate_before" "navigate_before" -}}
{{- partialCached "icon" "chevron_backward" "chevron_backward" -}}
</span>
</a>
</li>
Expand Down Expand Up @@ -50,15 +50,15 @@
<li>
<a class="{{ $selectable }}" href="{{ .URL }}" aria-label="Last">
<span class="icon-svg">
{{- partialCached "icon" "navigate_next" "navigate_next" -}}
{{- partialCached "icon" "chevron_forward" "chevron_forward" -}}
</span>
</a>
</li>
{{- else }}
<li>
<a class="{{ $disabled }}" aria-disabled="true" aria-label="Last">
<span class="icon-svg">
{{- partialCached "icon" "navigate_next" "navigate_next" -}}
{{- partialCached "icon" "chevron_forward" "chevron_forward" -}}
</span>
</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions layouts/partials/sidebar/mainnav.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
</a>
<button @click="expanded = !expanded" class="rounded hover:bg-gray-light-300 hover:dark:bg-gray-dark-300">
<span x-show="! expanded" class="icon-svg">
{{ partialCached "icon" "expand_more" "expand_more" }}
{{ partialCached "icon" "arrow_drop_down" "arrow_drop_down" }}
</span>
<span x-cloak x-show="expanded" class="icon-svg">
{{ partialCached "icon" "expand_less" "expand_less" }}
{{ partialCached "icon" "arrow_drop_up" "arrow_drop_up" }}
</span>
</button>
</div>
Expand Down
4 changes: 2 additions & 2 deletions layouts/partials/sidebar/sections.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@
</div>
<button @click="expanded = !expanded" class="hover:bg-gray-light-300 hover:dark:bg-gray-dark-300 rounded">
<span :class="{ 'hidden' : expanded }" class="icon-svg {{ if $expanded }}hidden{{ end }}">
{{ partialCached "icon" "expand_more" "expand_more" }}
{{ partialCached "icon" "arrow_drop_down" "arrow_drop_down" }}
</span>
<span :class="{ 'hidden' : !expanded }" class="icon-svg {{ if not $expanded }}hidden{{ end }}">
{{ partialCached "icon" "expand_less" "expand_less" }}
{{ partialCached "icon" "arrow_drop_up" "arrow_drop_up" }}
</span>
</button>
</div>
Expand Down
4 changes: 2 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ publish = "public"
[context.deploy-preview.environment]
NODE_VERSION = "20"
NODE_ENV = "production"
HUGO_VERSION = "0.132.0"
HUGO_VERSION = "0.134.3"
HUGO_ENABLEGITINFO = "true"
HUGO_ENVIRONMENT = "preview"

[context.deploy-preview]
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL && npx pagefind@v1.1.0"
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL && npx pagefind@v1.1.1"
Loading

0 comments on commit 29eff6b

Please sign in to comment.