Skip to content

Commit 3ae3631

Browse files
authored
upgrade build dependencies (#23647)
## Description Updated/pruned some dev dependencies: - **deps: upgrade markdownlint to v0.38.0** - **deps: use igorshubovych/markdownlint-cli image for running markdownlint** - **lint: add MD059/descriptive-link-text markdownlint rule** - **deps: upgrade prettier to v3.6.2** - **deps: upgrade prettier-plugin-tailwindcss to v0.7.1** - **deps: delete unused @tailwindcss/nesting package** --------- Signed-off-by: David Karlsson <[email protected]>
2 parents 22e7c09 + 7418c6c commit 3ae3631

File tree

21 files changed

+823
-232
lines changed

21 files changed

+823
-232
lines changed

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
},
2121
"fenced-code-language": true,
2222
"table-pipe-style": true,
23-
"table-column-count": true
23+
"table-column-count": true,
24+
"descriptive-link-text": { "prohibited_texts": ["click here","here","link","more","learn more","find out more"]}
2425
}

Dockerfile

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,12 @@ RUN --mount=type=cache,target=/tmp/hugo_cache \
5353
hugo --gc --minify -e $HUGO_ENV -b $DOCS_URL
5454

5555
# lint lints markdown files
56-
FROM davidanson/markdownlint-cli2:v0.14.0 AS lint
57-
USER root
56+
FROM ghcr.io/igorshubovych/markdownlint-cli:v0.45.0 AS lint
5857
RUN --mount=type=bind,target=. \
59-
/usr/local/bin/markdownlint-cli2 \
58+
markdownlint \
6059
"content/**/*.md" \
61-
"#content/manuals/engine/release-notes/*.md" \
62-
"#content/manuals/desktop/previous-versions/*.md"
60+
--ignore "content/manuals/engine/release-notes/*.md" \
61+
--ignore "content/manuals/desktop/previous-versions/*.md"
6362

6463
# test validates HTML output and checks for broken links
6564
FROM wjdp/htmltest:v${HTMLTEST_VERSION} AS test

content/contribute/components/videos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ If all of the above criteria are met, you can reference the following best pract
2525
- Videos should adhere to the same standards for accessibility as the rest of the documentation.
2626
- Ensure the quality of your video by writing a script (if there's narration), making sure multiple browsers and URLs aren't visible, blurring or cropping out any sensitive information, and using smooth transitions between different browsers or screens.
2727

28-
Videos are not hosted in the Docker documentation repository. To add a video, you can use a [link](./links.md) to hosted content, or embed using an [iframe](#iframe).
28+
Videos are not hosted in the Docker documentation repository. To add a video, you can [link to](./links.md) hosted content, or embed using an [iframe](#iframe).
2929

3030

3131
## iframe

content/guides/localstack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Launch a quick demo of LocalStack by using the following steps:
7676

7777
When you create a local S3 bucket using LocalStack, you're essentially simulating the creation of an S3 bucket on AWS. This lets you to test and develop applications that interact with S3 without needing an actual AWS account.
7878

79-
To create Local Amazon S3 bucket, you’ll need to install an `awscli-local` package to be installed on your system. This package provides the awslocal command, which is a thin wrapper around the AWS command line interface for use with LocalStack. It lets you to test and develop against a simulated environment on your local machine without needing to access the real AWS services. You can learn more about this utility [here](https://github.com/localstack/awscli-local).
79+
To create Local Amazon S3 bucket, install the [`awscli-local` CLI](https://github.com/localstack/awscli-local) on your system. The `awslocal` command is a thin wrapper around the AWS command line interface for use with LocalStack. It lets you to test and develop against a simulated environment on your local machine without needing to access the real AWS services.
8080

8181
```console
8282
$ pip install awscli-local

content/guides/python/configure-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Each GitHub Actions workflow includes one or several jobs. Each job consists of
110110

111111
## 2. Run the workflow
112112

113-
Let's commit the changes, push them to the `main` branch. In the workflow above, the trigger is set to `push` events on the `main` branch. This means that the workflow will run every time you push changes to the `main` branch. You can find more information about the workflow triggers [here](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
113+
Commit the changes and push them to the `main` branch. This workflow is runs every time you push changes to the `main` branch. You can find more information about workflow triggers [in the GitHub documentation](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
114114

115115
Go to the **Actions** tab of you GitHub repository. It displays the workflow. Selecting the workflow shows you the breakdown of all the steps.
116116

content/guides/ruby/configure-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Each GitHub Actions workflow includes one or several jobs. Each job consists of
8989

9090
## 2. Run the workflow
9191

92-
Let's commit the changes, push them to the `main` branch. In the workflow above, the trigger is set to `push` events on the `main` branch. This means that the workflow will run every time you push changes to the `main` branch. You can find more information about the workflow triggers [here](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
92+
Commit the changes and push them to the `main` branch. This workflow is runs every time you push changes to the `main` branch. You can find more information about workflow triggers [in the GitHub documentation](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
9393

9494
Go to the **Actions** tab of you GitHub repository. It displays the workflow. Selecting the workflow shows you the breakdown of all the steps.
9595

content/manuals/build/builders/drivers/kubernetes.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,7 @@ is configurable using the following driver options:
7575
- `requests.cpu`, `requests.memory`, `requests.ephemeral-storage`, `limits.cpu`, `limits.memory`, `limits.ephemeral-storage`
7676

7777
These options allow requesting and limiting the resources available to each
78-
BuildKit pod according to the official Kubernetes documentation
79-
[here](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
78+
BuildKit pod [according to the official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
8079

8180
For example, to create 4 replica BuildKit pods:
8281

@@ -247,8 +246,8 @@ that you want to support.
247246
## Rootless mode
248247

249248
The Kubernetes driver supports rootless mode. For more information on how
250-
rootless mode works, and its requirements, see
251-
[here](https://github.com/moby/buildkit/blob/master/docs/rootless.md).
249+
rootless mode works, and its requirements, refer to the
250+
[Rootless Buildkit documentation](https://github.com/moby/buildkit/blob/master/docs/rootless.md).
252251

253252
To turn it on in your cluster, you can use the `rootless=true` driver option:
254253

content/manuals/build/builders/drivers/remote.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ Unix socket, and have Buildx connect through it.
4848
$ sudo ./buildkitd --group $(id -gn) --addr unix://$HOME/buildkitd.sock
4949
```
5050

51-
Alternatively, [see here](https://github.com/moby/buildkit/blob/master/docs/rootless.md)
52-
for running buildkitd in rootless mode or [here](https://github.com/moby/buildkit/tree/master/examples/systemd)
53-
for examples of running it as a systemd service.
51+
Alternatively, refer to the [Rootless Buildkit documentation](https://github.com/moby/buildkit/blob/master/docs/rootless.md)
52+
for running buildkitd in rootless mode, or [the BuildKit systemd examples](https://github.com/moby/buildkit/tree/master/examples/systemd)
53+
for running it as a systemd service.
5454

5555
2. Check that you have a Unix socket that you can connect to.
5656

@@ -159,13 +159,13 @@ BuildKit manually. Additionally, when executing builds from inside Kubernetes
159159
pods, the Buildx builder will need to be recreated from within each pod or
160160
copied between them.
161161

162-
1. Create a Kubernetes deployment of `buildkitd`, as per the instructions
163-
[here](https://github.com/moby/buildkit/tree/master/examples/kubernetes).
162+
1. Create a Kubernetes deployment of `buildkitd` by following the instructions
163+
[in the BuildKit documentation](https://github.com/moby/buildkit/tree/master/examples/kubernetes).
164164

165-
Following the guide, create certificates for the BuildKit daemon and client
166-
using [create-certs.sh](https://github.com/moby/buildkit/blob/master/examples/kubernetes/create-certs.sh),
167-
and create a deployment of BuildKit pods with a service that connects to
168-
them.
165+
Create certificates for the BuildKit daemon and client using the
166+
[create-certs.sh](https://github.com/moby/buildkit/blob/master/examples/kubernetes/create-certs.sh),
167+
script and create a deployment of BuildKit pods with a service that connects
168+
to them.
169169

170170
2. Assuming that the service is called `buildkitd`, create a remote builder in
171171
Buildx, ensuring that the listed certificate files are present:

content/manuals/build/buildkit/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ see [GitHub issues](https://github.com/moby/buildkit/issues?q=is%3Aissue%20state
150150

151151
Select the Docker icon in the taskbar, and then **Switch to Windows containers...**.
152152

153-
3. Install containerd version 1.7.7 or later following the setup instructions [here](https://github.com/containerd/containerd/blob/main/docs/getting-started.md#installing-containerd-on-windows).
153+
3. Install containerd version 1.7.7 or later following the [setup instructions](https://github.com/containerd/containerd/blob/main/docs/getting-started.md#installing-containerd-on-windows).
154154

155155
4. Download and extract the latest BuildKit release.
156156

content/manuals/docker-hub/repos/manage/builds/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ when the tests succeed.
3030

3131
> [!NOTE]
3232
>
33-
> You may be redirected to the settings page to [link](link-source.md) the
34-
> code repository service. Otherwise, if you are editing the build settings
33+
> You may be redirected to the settings page to [link the code repository
34+
> service](link-source.md). Otherwise, if you are editing the build settings
3535
> for an existing automated build, select **Configure automated builds**.
3636
3737
4. Select the **source repository** to build the Docker images from.

0 commit comments

Comments
 (0)