Skip to content

Commit 5f7da29

Browse files
Fix markdown syntax violations (#5777)
Co-authored-by: Matt Thalman <[email protected]>
1 parent 3726c1a commit 5f7da29

File tree

10 files changed

+19
-18
lines changed

10 files changed

+19
-18
lines changed

.markdownlint.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
{
22
"default": true,
3+
"MD013": false, // line length
4+
"MD024": false, // no-duplicate-heading Multiple headings with the same content
35
"MD033": false, // no inline HTML
46

57
// The following rules are disabled to allow the linter to be enabled.
68
// Follow-up work will be done to enable these rules and clean up the violations.
79
"MD001": false, // heading-increment Heading levels should only increment by one level at a time
8-
"MD013": false, // line length
910
"MD022": false, // blanks-around-headings Headings should be surrounded by blank lines
10-
"MD024": false, // no-duplicate-heading Multiple headings with the same content
1111
"MD025": false, // single-title/single-h1 Multiple top-level headings in the same document
1212
"MD034": false, // no-bare-urls Bare URL used
13-
"MD036": false, // no-emphasis-as-heading Emphasis used instead of a heading
1413
"MD041": false, // first-line-heading/first-line-h1 First line in a file should be a top-level heading
1514
}

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can use C# or F# to write .NET apps.
2323

2424
You are invited to [contribute new features](https://github.com/dotnet/core/blob/master/CONTRIBUTING.md), fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
2525

26-
> https://docs.microsoft.com/dotnet/core/
26+
> [.NET Documentation](https://docs.microsoft.com/dotnet/core/)
2727
2828
Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements.
2929

documentation/azurelinux.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ flowchart TD
152152

153153
Here's an example configuration based off of a simple ASP.NET Core app:
154154

155-
**.csproj**
155+
### *.csproj
156156

157157
```diff
158158
<PropertyGroup>
@@ -162,7 +162,7 @@ Here's an example configuration based off of a simple ASP.NET Core app:
162162
</PropertyGroup>
163163
```
164164

165-
**Dockerfile**
165+
### Dockerfile
166166

167167
```diff
168168
# Learn about building .NET container images:

documentation/image-variants.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,23 @@ By default, these images do not include `icu` or `tzdata`, meaning that these im
1111
Apps that require globalization support can use the `extra` image variant of the [dotnet/runtime-deps](https://hub.docker.com/_/microsoft-dotnet-runtime-deps/) images. Because this is only available with `runtime-deps` images, it requires a [self-contained deployment](https://learn.microsoft.com/dotnet/core/deploying/#publish-self-contained) of the application.
1212
Alpine, Azure Linux, and Ubuntu Chiseled images also come in `extra`, `composite`, and `aot` variants (see below).
1313

14-
### Distroless
14+
## Distroless
1515

1616
[Ubuntu Chiseled](https://ubuntu.com/engage/chiselled-ubuntu-images-for-containers) and [Azure Linux](./azurelinux.md) distroless .NET images contain only the minimum set of libraries necessary to run .NET applications with everything else removed.
1717
For more information, see the [Distroless .NET images documentation](./distroless.md).
1818

19-
### `extra` (.NET 8.0+)
19+
## `extra` (.NET 8.0+)
2020

2121
For apps that depend on globalization functionality, the `extra` image variant is offered for [Ubuntu Chiseled](./ubuntu-chiseled.md) and [Azure Linux](./azurelinux.md) distroless `runtime-deps`, `runtime`, and `aspnet` images as well as `runtime-deps` images for Alpine Linux.
2222
These `extra` images contain everything that the default images do, plus `icu` and `tzdata`.
2323

24-
### `composite` (.NET 8.0+)
24+
## `composite` (.NET 8.0+)
2525

2626
ASP.NET Core Composite images provide a smaller size on disk while keeping the performance of the default [ReadyToRun (R2R) setting](https://learn.microsoft.com/dotnet/core/deploying/ready-to-run).
2727
The caveat is that the composite images have tighter version coupling. This means the final app run on them cannot use handpicked custom versions of the framework and/or ASP.NET assemblies that are built into the composite binary.
2828
For a full technical description on how the composites work, we have a [feature doc here](https://github.com/dotnet/runtime/blob/main/docs/design/features/readytorun-composite-format-design.md).
2929

30-
### (Preview) `aot` (.NET 8.0+)
30+
## (Preview) `aot` (.NET 8.0+)
3131

3232
The `aot` images provide an optimized deployment size for [Native AOT](https://learn.microsoft.com/dotnet/core/deploying/native-aot/) compiled .NET apps.
3333
Native AOT has the lowest size, startup time, and memory footprint of all .NET deployment models.

documentation/scenarios/nuget-credentials.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The `VSS_NUGET_EXTERNAL_FEED_ENDPOINTS` environment variable is a well-known var
144144

145145
Instead, the credentials for `customfeed` are defined in the Dockerfile by making use of an `ARG` for the access token:
146146

147-
_Linux_
147+
### Linux
148148

149149
```Dockerfile
150150
FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
@@ -170,7 +170,7 @@ COPY --from=build /app/out ./
170170
ENTRYPOINT ["dotnet", "dotnetapp.dll"]
171171
```
172172

173-
_Windows_
173+
### Windows
174174

175175
```Dockerfile
176176
# escape=`

eng/pipelines/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
# .NET Docker Pipelines
2+
13
The contents of the `pipelines` folder are used by the .NET Core engineering infrastructure to build and publish the images.

eng/readme-templates/About.product-family.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ You can use C# or F# to write .NET apps.
1111

1212
You are invited to [contribute new features](https://github.com/dotnet/core/blob/master/CONTRIBUTING.md), fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
1313

14-
> https://docs.microsoft.com/dotnet/core/
14+
> [.NET Documentation](https://docs.microsoft.com/dotnet/core/)

samples/build-for-a-platform.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,12 @@ The `--platform` argument is the best way to specify the desired architecture. T
8080
In addition, Docker [Buildkit exposes multiple environment variables](https://github.com/dotnet/dotnet-docker/pull/4387#issuecomment-1416565213) that can be used to further conditionalize behavior. These environment variables can be controlled with the pattern demonstrated in [Dockerfile](https://github.com/mthalman/dredge/blob/main/src/Valleysoft.Dredge/Dockerfile). As mentioned, .NET doesn't support being run in emulation. The pattern in that Dockerfile results in the SDK always being run natively while the final image is affected by the `--platform` switch. This model also has the best performance since the bulk of computation is run natively.
8181

8282
> [!NOTE]
83-
> We are enabling the following model in a future release: https://github.com/dotnet/dotnet-docker/issues/4388#issuecomment-1421401384.
83+
> We are enabling this [model](https://github.com/dotnet/dotnet-docker/issues/4388#issuecomment-1421401384) in a future release.
8484
8585
## .NET and QEMU
8686

8787
Docker Desktop uses [QEMU](https://www.qemu.org/) for emulation, for example running x64 code on an Arm64 machine. [.NET doesn't support being run in QEMU](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md#qemu). That means that the SDK needs to always be run natively, to enable [multi-stage build](https://docs.docker.com/build/building/multi-stage/). Multi-stage build is used by all of our samples.
8888

8989
As a result, we need a reliable pattern that can produce multiple variants of images on one machine, but that doesn't use emulation. That's what this document describes.
9090

91-
Context: https://gitlab.com/qemu-project/qemu/-/issues/249
91+
> [QEMU context](https://gitlab.com/qemu-project/qemu/-/issues/249)

samples/enable-globalization.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ System.Globalization.CultureNotFoundException: Only the invariant culture is sup
3535
en-us is an invalid culture identifier.
3636
```
3737

38-
This is by design. `Microsoft.Data.SqlClient` requires ICU to be installed. See https://github.com/dotnet/SqlClient/issues/220 for more information.
38+
This is by design. `Microsoft.Data.SqlClient` requires ICU to be installed. See this [Sql Client issue](https://github.com/dotnet/SqlClient/issues/220) for more information.
3939

4040
### Alpine images
4141

@@ -54,7 +54,7 @@ RUN apk add --no-cache \
5454

5555
### Ubuntu chiseled images
5656

57-
ICU can be added to an Ubuntu chiseled image, as demonstrated by https://github.com/ubuntu-rocks/dotnet/issues/21.
57+
ICU can be added to an Ubuntu chiseled image, as demonstrated in this [chisel issue](https://github.com/ubuntu-rocks/dotnet/issues/21).
5858

5959
## Tzdata
6060

samples/releasesapp/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ docker build --pull -t app .
1313
docker run --rm app
1414
```
1515

16-
It will produce output similar to: https://gist.github.com/richlander/4701a33592abd021f767644974c0ced6
16+
It will produce output similar to this [example app output](https://gist.github.com/richlander/4701a33592abd021f767644974c0ced6).
1717

1818
## App
1919

0 commit comments

Comments
 (0)