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

(AB-4196) Codify markdownlint #92

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Aug 17, 2022

PR Summary

Prior to this change, the repository had no markdownlint configuration. This change adds configuration based on the rules defined in the MicrosoftDocs/PowerShell-Docs project.

The root-folder .markdownlint.json file specifies the enforced syntax for Markdown files in this project.

The root-folder .markdownlint-cli2.yaml file governs the behavior of the linter overall. The settings included are minimal and do not effect the editing experience. This file may require iteration for advanced usage later.

In every About folder for reference content, this change adds a .markdownlint.json file. When editing Markdown in VS Code, the editor uses the closest configuration file to the edited document. That allows us to override and specify alternate rules on a per-folder basis.

In this change, the configuration files in the About folders:

  • Extend the root configuration. Any settings not specified in these configurations is inherited from the configuration at the project root.
  • Overrides the line-length rule, setting the maximum line length for code blocks to 74 characters and for other text to 79 characters.This is to accomodate the PowerShell Help System's line length requirements.

In the rules folder for PSScriptAnalyzer's conceptual content, this change adds a .markdownlint.json file which ignores the markdownlint rule no-emphasis-as-heading. PSSA rules indicate their severity level by a single line of emphasized text.

This change is related to AB#4196 and AB#4197.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

Prior to this change, the repository had no markdownlint configuration.
This change adds configuration based on the rules defined in the
MicrosoftDocs/PowerShell-Docs project.

The root-folder `.markdownlint.json` file specifies the enforced syntax
for Markdown files in this project.

The root-folder `.markdownlint-cli2.yaml` file governs the behavior of
the linter overall. The settings included are minimal and do not effect
the editing experience. This file may require iteration for advanced
usage later.

In every `About` folder for reference content, this change adds a
`.markdownlint.json` file. When editing Markdown in VS Code, the editor
uses the closest configuration file to the edited document. That allows
us to override and specify alternate rules on a per-folder basis.

In this change, the configuration files in the `About` folders:

- Extend the root configuration. Any settings not specified in these
  configurations is inherited from the configuration at the project
  root.
- Overrides the `line-length` rule, setting the maximum line length for
  code blocks to 74 characters and for other text to 79 characters.This
  is to accomodate the PowerShell Help System's line length
  requirements.

In the `rules` folder for PSScriptAnalyzer's conceptual content, this
change adds a `.markdownlint.json` file which ignores the markdownlint
rule `no-emphasis-as-heading`. PSSA rules indicate their severity level
by a single line of emphasized text.

This change is related to AB#4196 and AB#4197.
@opbld33
Copy link

opbld33 commented Aug 17, 2022

Docs Build status updates of commit 610b32f:

✅ Validation status: passed

File Status Preview URL Details
.markdownlint.json ✅Succeeded
.markdownlint-cli2.yaml ✅Succeeded
reference/docs-conceptual/PSScriptAnalyzer/Rules/.markdownlint.json ✅Succeeded
reference/ps-modules/Microsoft.PowerShell.Crescendo/About/.markdownlint.json ✅Succeeded
reference/ps-modules/PlatyPS/About/.markdownlint.json ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@sdwheeler sdwheeler merged commit e74c14a into MicrosoftDocs:main Aug 18, 2022
@michaeltlombardi michaeltlombardi deleted the AB-4196/main/codify-markdownlint branch August 18, 2022 13:30
sdwheeler added a commit that referenced this pull request Sep 22, 2022
* (AB-4960) Run expectations workflow every 30m (#89)

This change reduces the frequency the expectations GHA runs from
once every 10 minutes to once every 30 minutes to help reduce the
frequency of rate limiting.

* (GH-90) Document PSAvoidUsingBrokenHashAlgorithms (#91)

This change:

- documents the new `PSAvoidUsingBrokenHashAlgorithms` rule for
  **PSScriptAnalyzer** by updating the rule table and adding a document
  for the rule.
- Resolves #90
- Fixes AB#4996

* (AB-4196) Codify markdownlint (#92)

Prior to this change, the repository had no markdownlint configuration.
This change adds configuration based on the rules defined in the
MicrosoftDocs/PowerShell-Docs project.

The root-folder `.markdownlint.json` file specifies the enforced syntax
for Markdown files in this project.

The root-folder `.markdownlint-cli2.yaml` file governs the behavior of
the linter overall. The settings included are minimal and do not effect
the editing experience. This file may require iteration for advanced
usage later.

In every `About` folder for reference content, this change adds a
`.markdownlint.json` file. When editing Markdown in VS Code, the editor
uses the closest configuration file to the edited document. That allows
us to override and specify alternate rules on a per-folder basis.

In this change, the configuration files in the `About` folders:

- Extend the root configuration. Any settings not specified in these
  configurations is inherited from the configuration at the project
  root.
- Overrides the `line-length` rule, setting the maximum line length for
  code blocks to 74 characters and for other text to 79 characters.This
  is to accomodate the PowerShell Help System's line length
  requirements.

In the `rules` folder for PSScriptAnalyzer's conceptual content, this
change adds a `.markdownlint.json` file which ignores the markdownlint
rule `no-emphasis-as-heading`. PSSA rules indicate their severity level
by a single line of emphasized text.

This change is related to AB#4196 and AB#4197.

* Add CrescendoBuilt to docs (#93)

* Fix typos (#95)

Co-authored-by: Mikey Lombardi (He/Him) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants