From 8c092d2dde0a8ebc277eb94cdd38f043af1981a2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 25 Sep 2023 15:27:59 -0700 Subject: [PATCH 1/2] Document how to disable content linter rules with comments (#42669) --- .../using-the-content-linter.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/content/contributing/collaborating-on-github-docs/using-the-content-linter.md b/content/contributing/collaborating-on-github-docs/using-the-content-linter.md index a97a212bb0f7..0ef56babd85e 100644 --- a/content/contributing/collaborating-on-github-docs/using-the-content-linter.md +++ b/content/contributing/collaborating-on-github-docs/using-the-content-linter.md @@ -141,3 +141,31 @@ These rules should be fixed before merging content into the `main` branch, but t | [GHD001](https://github.com/github/docs/blob/main/src/content-linter/lib/linting-rules/code-fence-line-length.js) | Code fence content should be 60 lines or less in length. | | [GHD003](https://github.com/github/docs/blob/main/src/content-linter/lib/linting-rules/image-alt-text-length.js) | Images alternate text should be between 40-150 characters. | | [GHD004](https://github.com/github/docs/blob/main/src/content-linter/lib/linting-rules/internal-links-slash.js) | Internal links must start with a `/`. | + +## Suppressing linter rules + +Rarely, you may need to document something that violates one or more linter rules. In these cases, you can suppress rules by adding a comment to the Markdown file. You can disable all rules or specific rules. Always try to limit as few rules as possible. + + +For example, if you are writing an article that includes a regular expression such as (^|/)[Cc]+odespace/, you can suppress the `MD011` rule that checks for reversed link syntax by adding the following comment. + +
+<!-- markdownlint-disable MD011 -->
+(^|/)[Cc]+odespace/
+<!-- markdownlint-enable MD011 -->
+
+ + + +You can use these comments to enable or disable rules. + +| Comment | Effect | +| :-- | :-- | +|
<!-- markdownlint-disable -->
| Disable all rules | +|
<!-- markdownlint-enable -->
| Enable all rules | +|
<!-- markdownlint-disable-line -->
| Disable all rules for the current line | +|
<!-- markdownlint-disable-next-line -->
| Disable all rules for the next line | +|
<!-- markdownlint-disable RULE-ONE RULE-TWO -->
| Disable one or more rules by name | +|
<!-- markdownlint-enable RULE-ONE RULE-TWO -->
| Enable one or more rules by name | +|
<!-- markdownlint-disable-line RULE-NAME -->
| Disable one or more rules by name for the current line | +|
<!-- markdownlint-disable-next-line RULE-NAME -->
| Disable one or more rules by name for the next line | From 70ab6bc525df2ebfb1c93edf4d1ee251dca73afc Mon Sep 17 00:00:00 2001 From: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Date: Mon, 25 Sep 2023 16:45:26 -0600 Subject: [PATCH 2/2] Enterprise bug fix hour for week of September 18, 2023 (#43117) Co-authored-by: Laura Coursen --- .../migrating-from-github-enterprise-1110x-to-2123.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md b/content/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md index 053c4f8de4b9..44ae3d41e6ea 100644 --- a/content/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md +++ b/content/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md @@ -21,6 +21,12 @@ topics: - Upgrades shortTitle: Migrate from 11.10.x to 2.1.23 --- +{% note %} + +**Note**: {% data variables.product.prodname_ghe_server %} 11.10 is an unsupported release from 2014. For a list of supported releases, see "[AUTOTITLE](/admin/all-releases)." + +{% endnote %} + Migrations from {% data variables.product.prodname_enterprise %} 11.10.348 and later are supported. Migrating from {% data variables.product.prodname_enterprise %} 11.10.348 and earlier is not supported. You must first upgrade to 11.10.348 in several upgrades. For more information, see the 11.10.348 upgrading procedure, "[Upgrading to the latest release](/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)." To upgrade to the latest version of {% data variables.product.prodname_enterprise %}, you must first migrate to {% data variables.product.prodname_ghe_server %} 2.1, then you can follow the normal upgrade process. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)".