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

Publish to live #94

Merged
merged 5 commits into from
Aug 18, 2022
Merged

Publish to live #94

merged 5 commits into from
Aug 18, 2022

Conversation

sdwheeler
Copy link
Collaborator

Publishing latest changes to live

michaeltlombardi and others added 4 commits August 10, 2022 12:06
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.
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
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 18, 2022

Docs Build status updates of commit 27ecb4a:

✅ Validation status: passed

File Status Preview URL Details
.github/workflows/expectations.yml ✅Succeeded
.markdownlint.json ✅Succeeded
.markdownlint-cli2.yaml ✅Succeeded
reference/docs-conceptual/PSScriptAnalyzer/Rules/.markdownlint.json ✅Succeeded
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/toc.yml ✅Succeeded View (ps-modules)
reference/ps-modules/Microsoft.PowerShell.Crescendo/About/.markdownlint.json ✅Succeeded
reference/ps-modules/Microsoft.PowerShell.Crescendo/About/about_Crescendo.md ✅Succeeded View (ps-modules)
reference/ps-modules/Microsoft.PowerShell.Crescendo/Export-CrescendoModule.md ✅Succeeded View (ps-modules)
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:

@opbld33
Copy link

opbld33 commented Aug 18, 2022

Docs Build status updates of commit 9bcddad:

✅ Validation status: passed

File Status Preview URL Details
.github/workflows/expectations.yml ✅Succeeded
.markdownlint.json ✅Succeeded
.markdownlint-cli2.yaml ✅Succeeded
reference/docs-conceptual/PSScriptAnalyzer/Rules/.markdownlint.json ✅Succeeded
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/toc.yml ✅Succeeded View (ps-modules)
reference/ps-modules/Microsoft.PowerShell.Crescendo/About/.markdownlint.json ✅Succeeded
reference/ps-modules/Microsoft.PowerShell.Crescendo/About/about_Crescendo.md ✅Succeeded View (ps-modules)
reference/ps-modules/Microsoft.PowerShell.Crescendo/Export-CrescendoModule.md ✅Succeeded View (ps-modules)
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 e4dd62a into live Aug 18, 2022
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