Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[nightly] Fix markdown linting errors #5811

Merged
merged 2 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.aspire-dashboard.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspire-dashboard/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is unrelated to your changes but I'm surprised the linter is ok with having text before the top-level header has even been defined.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's because the . prefixed directories are not scanned. They break this rule which has a lot of value outside of this directory. I chose to leave them unscanned due to the overlap w/the GH readmes.

> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspire-dashboard/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.aspnet.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspnet/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspnet/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.monitor-base.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor-base/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor-base/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.monitor.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.runtime-deps.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime-deps/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime-deps/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.runtime.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/docker-hub/README.sdk.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-sdk/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-sdk/) for images with official releases of [.NET](https://github.com/dotnet/core).

# Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.aspire-dashboard.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/aspire-dashboard/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/aspire-dashboard/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the .NET Aspire Dashboard.

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.aspnet.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/aspnet/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/aspnet/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the ASP.NET Core and .NET runtimes and libraries and is optimized for running ASP.NET Core apps in production.

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.monitor-base.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/monitor/base/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/monitor/base/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the .NET Monitor Base installation.

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.monitor.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/monitor/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/monitor/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the .NET Monitor tool.

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.runtime-deps.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/runtime-deps/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/runtime-deps/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the native dependencies needed by .NET. It does not include .NET. It is for [self-contained](https://docs.microsoft.com/dotnet/articles/core/deploying/index) applications.

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.runtime.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/runtime/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/runtime/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the .NET runtimes and libraries and is optimized for running .NET apps in production.

Expand Down
8 changes: 3 additions & 5 deletions .portal-docs/mar/README.sdk.portal.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## About

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://mcr.microsoft.com/product/dotnet/sdk/about) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://mcr.microsoft.com/product/dotnet/sdk/about) for images with official releases of [.NET](https://github.com/dotnet/core).

This image contains the .NET SDK which is comprised of three parts:

Expand Down
8 changes: 3 additions & 5 deletions README.aspire-dashboard.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET Aspire Dashboard

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspire-dashboard/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspire-dashboard/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions README.aspnet.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# ASP.NET Core Runtime

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspnet/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-aspnet/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Repos

Expand Down
8 changes: 3 additions & 5 deletions README.monitor-base.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET Monitor Base

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor-base/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor-base/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions README.monitor.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET Monitor Tool

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-monitor/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions README.runtime-deps.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET Runtime Dependencies

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime-deps/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime-deps/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions README.runtime.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET Runtime

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-runtime/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions README.sdk.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# .NET SDK

**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet](https://hub.docker.com/r/microsoft/dotnet-sdk/) for images with official releases of [.NET](https://github.com/dotnet/core).**
> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet](https://hub.docker.com/r/microsoft/dotnet-sdk/) for images with official releases of [.NET](https://github.com/dotnet/core).

## Featured Tags

Expand Down
8 changes: 3 additions & 5 deletions eng/readme-templates/Announcement.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@
set isNightlyRepo to match(split(REPO, "/")[1], "nightly")
}}{{if isNightlyRepo || VARIABLES["branch"] = "nightly"
:{{if ARGS["leading-line-break"]:
}}**IMPORTANT**

**The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).**

**See [dotnet]({{InsertTemplate("Url.md", [ "readme-host": ARGS["readme-host"], "repo": nonNightlyRepo ])}}) for images with official releases of [.NET](https://github.com/dotnet/core).**
}}> **Important**: The images from the dotnet/nightly repositories include last-known-good (LKG) builds for the next release of [.NET](https://github.com/dotnet/core).
>
> See [dotnet]({{InsertTemplate("Url.md", [ "readme-host": ARGS["readme-host"], "repo": nonNightlyRepo ])}}) for images with official releases of [.NET](https://github.com/dotnet/core).
{{if ARGS["trailing-line-break"]:
}}}}
2 changes: 1 addition & 1 deletion samples/aspnetapp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You may notice that the sample includes a [health check](https://learn.microsoft

## Build image with the SDK

The easiest way to [build images is with the SDK](https://github.com/dotnet/sdk-container-builds).
The easiest way to [build images is with the SDK](https://github.com/dotnet/sdk-container-builds).

```console
dotnet publish /p:PublishProfile=DefaultContainer
Expand Down
4 changes: 2 additions & 2 deletions samples/releasesapi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release Json Report API

This app demonstrates publishing an app as [native AOT](https://learn.microsoft.com/dotnet/core/deploying/native-aot/) in containers.
This app demonstrates publishing an app as [native AOT](https://learn.microsoft.com/dotnet/core/deploying/native-aot/) in containers.

> [!NOTE]
> The base images used by this sample are in preview.
Expand All @@ -23,7 +23,7 @@ It exposes two endpoints:

## App

The app is intended as a sort of compliance report for .NET. The report includes supported major releases and those recently out of support. It includes the latest and latest security patch versions for each of those major releases.
The app is intended as a sort of compliance report for .NET. The report includes supported major releases and those recently out of support. It includes the latest and latest security patch versions for each of those major releases.

This same information is available from the [release JSON](https://github.com/dotnet/core/blob/main/release-notes/releases-index.json) files that the team maintains, but that requires a bit of code to provide the same report.

Expand Down
Loading