Fix markdownlint errors (#7100)

Author: glen-84

.github/linters/.markdownlint.yml

@@ -102,7 +102,7 @@ jobs:
           node-version: "20"
       - run: npm install -g markdownlint-cli2
         name: Install markdownlint-cli2
-      - run: markdownlint-cli2 --config ".github/linters/.markdownlint.yml" "website/src/**/*.md"
+      - run: markdownlint-cli2 "*.md" "website/src/**/*.md"
         name: run Markdownlint
 
   website-tests:

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+# https://github.com/DavidAnson/markdownlint
+
+MD013: false # Rationale: Hard line breaks are unnecessary (use soft wrapping instead).
+MD024:
+  siblings_only: true
+MD025: false # Rationale: The documentation ToC generator is designed to work with multiple top-level headings.
+MD026:
+  punctuation: ".,;:"
+MD028: false # Rationale: Used for displaying separate notes or warnings in the documentation.
+MD029: false # Rationale: The documentation currently misuses list formatting for other purposes.
+MD033:
+  allowed_elements:
+    - a
+    - Annotation
+    - ApiChoiceTabs
+    - br
+    - Code
+    - ExampleTabs
+    - img
+    - InputChoiceTabs
+    - PackageInstallation
+    - Schema
+    - strong
+    - u
+    - Video
+MD036: false # Rationale: Possibly too strict, used frequently in documentation.

.markdownlint.yml

@@ -1,5 +1,6 @@
 {
   "recommendations": [
+    "davidanson.vscode-markdownlint",
     "ms-dotnettools.csharp",
     "EditorConfig.EditorConfig",
     "k--kato.docomment",

.markdownlintrc

@@ -13,12 +13,6 @@
     "*.targets": "xml",
     "*.tasks": "xml"
   },
-  "markdownlint.config": {
-    "MD028": false,
-    "MD025": {
-      "front_matter_title": ""
-    }
-  },
   "cSpell.words": [
     "Nats"
   ],

.vscode/extensions.json

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
+reported by contacting the project team at <[email protected]>. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,9 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>

.vscode/settings.json

@@ -1,6 +1,6 @@
 # Community
 
-This document highlights projects from our awesome community. 
+This document highlights projects from our awesome community.
 
 Feel free to open a PR to include your project in this list.
 
@@ -33,4 +33,3 @@ Various libraries, packages, etc. that developers can add to their own project a
 - [FairyBread](https://github.com/benmccallum/fairybread) - Input validation for HotChocolate (FluentValidation)
 - [FluentChoco](https://github.com/dalrankov/FluentChoco) - FluentValidation middleware for HotChocolate
 - [Graph.ArgumentValidator](https://github.com/VarunSaiTeja/Graph.ArgumentValidator) - Adds input argument validation to HotChocolate (DataAnnotations)
- 

CODE-OF-CONDUCT.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable-next-line MD041 -->
 ![ChilliCream GraphQL Platform](https://chillicream.com/resources/chillicream-graphql-banner.svg)
 
 [![NuGet Package](https://img.shields.io/nuget/v/hotchocolate.svg)](https://www.nuget.org/packages/HotChocolate/)
@@ -74,6 +75,7 @@ Examples of things built on top of the ChilliCream GraphQL Platform that are ope
 
 [Become a sponsor](https://opencollective.com/chillicream#contribute) and get your logo on our README on Github with a link to your site.
 
+<!-- markdownlint-disable MD045 -->
 <a href="https://opencollective.com/chillicream/sponsor/0/website?requireActive=false" target="_blank" rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/sponsor/0/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/sponsor/1/website?requireActive=false" target="_blank" rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/sponsor/1/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/sponsor/2/website?requireActive=false" target="_blank" rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/sponsor/2/avatar.svg?requireActive=false"></a>
@@ -94,11 +96,13 @@ Examples of things built on top of the ChilliCream GraphQL Platform that are ope
 <a href="https://opencollective.com/chillicream/sponsor/17/website?requireActive=false" target="_blank" rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/sponsor/17/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/sponsor/18/website?requireActive=false" target="_blank" rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/sponsor/18/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/sponsor/19/website?requireActive=false" target="_blank" rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/sponsor/19/avatar.svg?requireActive=false"></a>
+<!-- markdownlint-enable MD045 -->
 
 ### Backer
 
 [Become a backer](https://opencollective.com/chillicream#contribute) and get your image on our README on Github with a link to your site.
 
+<!-- markdownlint-disable MD045 -->
 <a href="https://opencollective.com/chillicream/backer/0/website?requireActive=false" target="_blank"  rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/backer/0/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/backer/1/website?requireActive=false" target="_blank"  rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/backer/1/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/backer/2/website?requireActive=false" target="_blank"  rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/backer/2/avatar.svg?requireActive=false"></a>
@@ -119,3 +123,4 @@ Examples of things built on top of the ChilliCream GraphQL Platform that are ope
 <a href="https://opencollective.com/chillicream/backer/17/website?requireActive=false" target="_blank"  rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/backer/17/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/backer/18/website?requireActive=false" target="_blank"  rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/backer/18/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/chillicream/backer/19/website?requireActive=false" target="_blank"  rel="noreferrer noopener"><img src="https://opencollective.com/chillicream/backer/19/avatar.svg?requireActive=false"></a>
+<!-- markdownlint-enable MD045 -->

COMMUNITY.md

@@ -11,6 +11,6 @@ We will provide security updates to the latest major version.
 
 ## Reporting a Vulnerability
 
-Security issues and bugs should be reported privately, via email, to ChilliCream Inc. by emailing [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
+Security issues and bugs should be reported privately, via email, to ChilliCream Inc. by emailing <[email protected]>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
 
 Please do not open issues for anything you think might have a security implication.

README.md

@@ -103,6 +103,3 @@ We are planning around four to six weeks for version 9 with the first previews c
 We will really start hammering out the details on version 9 in the next three weeks.
 
 If you have ideas or suggestions pleas head over to our slack channel and join the discussion.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

SECURITY.md

@@ -307,6 +307,3 @@ services.AddGraphQL(Schema.Create(c =>
 ```
 
 I hope this little post will help when you start writing tests for your schema. If you run into any issues or if you have further questions/suggestions head over to our slack channel and we will be happy to help you.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

website/src/blog/2019-03-04-hot-chocolate-0.8.0.md

@@ -413,6 +413,3 @@ As you can see version 9 will bring quite a few improvements, so stay tuned for
 With Hot Chocolate we are building a GraphQL server for the community, so join and help us along.
 
 We value any kind of contribution, whether you give us a star, a feedback, find a bug, a typo, or whether you contribute code. Every bit matters and makes our project better.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

website/src/blog/2019-04-11-integration-tests.md

@@ -241,6 +241,3 @@ So, when can you expect 10.3.0. We will deliver nullable ref types with 10.3.0-p
 I hope you are as exited as I am about this. Happy Thanksgiving :) and get a super awesome Hot Chocolate with marshmallows to get into your GraphQL groove.
 
 If you want to get into contact with us head over to our slack channel and join our community.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

website/src/blog/2019-04-12-type-system.md

@@ -577,6 +577,3 @@ I hope you will enjoy 10.3.0 as much as I already do and join the Hot Chocolate
 BTW, head over to our _pure code-first_ [Star Wars example](https://github.com/ChilliCream/hotchocolate-examples/tree/master/misc/PureCodeFirst).
 
 If you want to get into contact with us head over to our slack channel and join our community.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

website/src/blog/2019-11-29-schema-design.md

@@ -1094,6 +1094,3 @@ The example used in this post can be found [here](https://github.com/ChilliCream
 We also have a more complex real-time GraphQL server example in multiple flavors and different database integrations [here](https://github.com/ChilliCream/hotchocolate-examples/tree/master/workshop/src/Server).
 
 If you want to get into contact with us head over to our slack channel and join our community.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

website/src/blog/2019-12-26-hotchocolate-10.3.0.md

@@ -370,7 +370,7 @@ services.AddMiniProfiler
 
 Then, when you execute a GraphQL query that uses Entity Framework Core, you'll get results like the following. Notice that not only do you get the GraphQL query with it's variables, but also, you get all the SQL generated by Entity Framework that's run on that Query's behalf. Also notice the timing, you can see the time for the GraphQL query as well as the time for just the SQL.
 
-![](MiniProfiler-Detail-EF-640.png)
+![MiniProfiler Detail Web Page](MiniProfiler-Detail-EF-640.png)
 
 # Wrap
 

website/src/blog/2020-03-18-entity-framework/2020-03-18-entity-framework.md

@@ -1094,6 +1094,3 @@ The example used in this post can be found [here](https://github.com/ChilliCream
 We also have a more complex real-time GraphQL server example in multiple flavors and different database integrations [here](https://github.com/ChilliCream/hotchocolate-examples/tree/master/workshop/src/Server).
 
 If you want to get into contact with us head over to our slack channel and join our community.
-
-[hot chocolate]: https://hotchocolate.io
-[hot chocolate source code]: https://github.com/ChilliCream/graphql-platform

website/src/blog/2021-01-20-hot-chocolate-logging/2021-01-10-hot-chocolate-logging.md

@@ -183,4 +183,4 @@ The general flow for the client registry involves three main steps: validating t
 
 2. **Upload the Client**: The second step takes place during your release build. Here, you upload the client to the registry using the `barista client upload` command. This command requires the `--tag` and `--api-id` options. The `--tag` option specifies the tag for the client, and the `--api-id` option specifies the ID of the API to which you are uploading. This command create a new version of the client with the specified tag. The tag is a string that can be used to identify the client. It can be any string, but it is recommended to use a version number, such as `v1` or `v2`; or a commit hash, such as `a1b2c3d4e5f6g7h8i9j0k1l2m3n`. The tag is used to identify the client when publishing it.
 
-3. **Publish the Client **: The third step takes place just before the release. Here, you publish the client using the `barista client publish` commands. This command requires the `--tag` and `--api-id` options. The `--tag` option specifies the tag for the client, and the `--api-id` option specifies the ID of the API to which you are uploading. This command publishes the client with the specified tag, making it the active version for the specified API.
+3. **Publish the Client**: The third step takes place just before the release. Here, you publish the client using the `barista client publish` commands. This command requires the `--tag` and `--api-id` options. The `--tag` option specifies the tag for the client, and the `--api-id` option specifies the ID of the API to which you are uploading. This command publishes the client with the specified tag, making it the active version for the specified API.

website/src/blog/2021-05-30-entity-framework/2020-03-18-entity-framework.md

@@ -114,9 +114,9 @@ The schema and client registries work hand-in-hand to ensure the smooth function
 
 The general flow for the schema registry involves three main steps: validating the schema, uploading it to the registry, and publishing it.
 
-1. **Validate the Schema **: The first step takes place during your Pull Request (PR) build. Here, you validate the schema against the API using the `barista schema validate` command. This ensures that the schema is compatible with the API and will not break existing functionality.
+1. **Validate the Schema**: The first step takes place during your Pull Request (PR) build. Here, you validate the schema against the API using the `barista schema validate` command. This ensures that the schema is compatible with the API and will not break existing functionality.
 
 2. **Upload the Schema**: The second step takes place during your release build. Here, you upload the schema to the registry using the `barista schema upload` command. This command requires the `--tag` and `--api-id` options. The `--tag` option specifies the tag for the schema, and the `--api-id` option specifies the ID of the API to which you are uploading. This command create a new version of the schema with the specified tag.
    The tag is a string that can be used to identify the schema. It can be any string, but it is recommended to use a version number, such as `v1` or `v2`; or a commit hash, such as `a1b2c3d4e5f6g7h8i9j0k1l2m3n`. The tag is used to identify the schema when publishing it.
 
-3. **Publish the Schema **: The third step takes place just before the release. Here, you publish the schema using the `barista schema publish` command. This command requires the `--tag` and `--api-id` options. The `--tag` option specifies the tag for the schema, and the `--api-id` option specifies the ID of the API to which you are uploading. This command publishes the schema with the specified tag, making it the active version for the specified API.
+3. **Publish the Schema**: The third step takes place just before the release. Here, you publish the schema using the `barista schema publish` command. This command requires the `--tag` and `--api-id` options. The `--tag` option specifies the tag for the schema, and the `--api-id` option specifies the ID of the API to which you are uploading. This command publishes the schema with the specified tag, making it the active version for the specified API.

website/src/docs/bananacakepop/v2/apis/client-registry.md

@@ -6,6 +6,6 @@ The `barista launch` command is used to launch Banana Cake Pop, the GraphQL IDE,
 
 To use the `barista launch` command, simply type it in your terminal:
 
-```
+```shell
 barista launch
 ```

website/src/docs/bananacakepop/v2/apis/schema-registry.md

@@ -6,7 +6,7 @@ The `barista login` command is used to log into your user account on Barista. On
 
 To use the `barista login` command, type it into your terminal as shown below:
 
-```
+```shell
 barista login
 ```
 

website/src/docs/barista/v1/commands/launch.md

@@ -1,12 +1,12 @@
-## Barista Logout
-
-**Description**
+---
+title: Logout
+---
 
 The `barista logout` command is used to log out of your user account on Barista.
 
 To use the `barista logout` command, type it into your terminal as shown below:
 
-```
+```shell
 barista logout
 ```
 

website/src/docs/barista/v1/commands/login.md

@@ -41,7 +41,7 @@ Below the table, you'll find several options to manage stages:
 - **(e)dit**: This option allows you to edit an existing stage.
 - **(d)elete**: This option allows you to delete a stage.
 
-** Hot to use the Console UI **
+**Hot to use the Console UI**
 
 1. **Navigate**: Use the arrow keys on your keyboard to navigate through the table of stages.
 2. **Add a new stage**: To add a new stage, press the 'a' key on your keyboard. You'll be prompted to enter the details of the new stage.

website/src/docs/barista/v1/commands/logout.md

@@ -44,6 +44,6 @@ barista workspace show abc123
 
 The `barista workspace current` command is used to show the name of the currently selected workspace.
 
-```
+```shell
 barista workspace current
 ```

website/src/docs/barista/v1/commands/stage.md

@@ -6,6 +6,6 @@ Barista is a powerful .NET command-line tool used for managing your GraphQL API'
 
 To install Barista, use the .NET Core CLI command:
 
-```
+```shell
 dotnet tool install --global barista
 ```

website/src/docs/barista/v1/commands/workspace.md

@@ -137,7 +137,7 @@ query {
 }
 ```
 
-**⚠️ OR does not work when you use it like this: **
+**⚠️ OR does not work when you use it like this:**
 
 ```graphql
 query {

website/src/docs/barista/v1/index.md

@@ -1871,7 +1871,7 @@ Hot Chocolate can translate incoming filters requests directly onto collections
 
 Filter conventions make it easier to change how an expression should be generated. There are three different extension points you can use to change the behavior of the expression visitor. You do not have to worry about the visiting of the input object itself.
 
-##### Describe the Expression Visitor
+#### Describe the Expression Visitor
 
 The expression visitor descriptor is accessible through the filter convention. By calling `UseExpressionVisitor` on the convention descriptor you gain access. The expression visitor has the default set of expressions pre-configured.
 

website/src/docs/hotchocolate/v10/data-fetching/filters.md

@@ -146,7 +146,7 @@ Another variant here is to use our scoped service feature that scopes services f
 
 # Schema / Resolvers
 
-### Field ordering
+## Field ordering
 
 Hot Chocolate 11 follows the spec and returns the fields in the order they were defined. This feature
 makes migrations harder because the schema snapshot looks different compared to version 11. You can change this behavior with the following setting.

website/src/docs/hotchocolate/v11/api-reference/filtering.md

@@ -225,7 +225,7 @@ The following conventions are applied when transforming C# method and property n
 
 With the name cleaned of unnecessary information, we also change the casing at the start of the name:
 
-```
+```text
 FooBar --> fooBar
 IPAddress --> ipAddress
 PLZ --> plz