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

(GH-8799) Initial address of incorrect formatting/syntax #8805

Merged

Conversation

michaeltlombardi
Copy link
Contributor

PR Summary

This PR begins the work to correct syntax with a focus on the formatting of symbols that should be formatted as code, e.g. |.

It includes clean ups of formatting and syntax for documents that required extensive updates.

PR Context

Check the boxes below to indicate the content affected by this PR.

Repository or docset configuration

  • Repo documentation and configuration (.git/.github/.vscode etc.)
  • Docs build files (.openpublishing.* and build scripts)
  • Docset configuration (docfx.json, mapping, bread, module folder)

Conceptual documentation

  • Files in docs-conceptual

Cmdlet reference & about_ topics
When changing cmdlet reference or about_ topics, the changes should be copied to all
relevant versions. Check the boxes below to indicate the versions affected by this change.

  • Preview content
  • Version 7.2 content
  • Version 7.1 content
  • Version 7.0 content
  • Version 5.1 content

PR Checklist

  • I have read the contributors guide and followed the style and process guidelines
  • PR has a meaningful title
  • PR is targeted at the main branch
  • All relevant versions updated
  • Includes content related to issues and PRs - see Closing issues using keywords.
  • This PR is ready to merge and is not Work in Progress. If the PR is work in progress,
    please add the prefix WIP: or [WIP] to the beginning of the title and remove the prefix when
    the PR is ready.

@opbld32
Copy link

opbld32 commented May 12, 2022

Docs Build status updates of commit 5a4a68e:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-5.1) Details
reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7) Details
reference/7.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7.1) Details
reference/7.2/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7.2) Details
reference/7.3/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7.3) Details
reference/5.1/CimCmdlets/Remove-CimInstance.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_WQL.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7.1)

This comment lists only the first 25 files in the pull request.

reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 491, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 454, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 502, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.2/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 502, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.3/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 502, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

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:

reference/5.1/CimCmdlets/Remove-CimInstance.md Outdated Show resolved Hide resolved
reference/7.1/Microsoft.PowerShell.Management/Move-Item.md Outdated Show resolved Hide resolved
> Certificates that have an empty **EnhancedKeyUsageList** can be used for
> all purposes.
> Parameters that perform filtering against the **EnhancedKeyUsageList**
> property also return items with an empty **`**EnhancedKeyUsageList**`**
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
> property also return items with an empty **`**EnhancedKeyUsageList**`**
> property also return items with an empty **EnhancedKeyUsageList**

@opbld33
Copy link

opbld33 commented May 12, 2022

Docs Build status updates of commit c3cbfaf:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-5.1) Details
reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7) Details
reference/7.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7.1) Details
reference/7.2/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7.2) Details
reference/7.3/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md 💡Suggestion View (powershell-7.3) Details
reference/5.1/CimCmdlets/Remove-CimInstance.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_WQL.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7.1)

This comment lists only the first 25 files in the pull request.

reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 491, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 454, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 502, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.2/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 502, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

reference/7.3/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md

  • Line 502, Column 15: [Suggestion: disallowed-html-tag - See documentation] HTML tag 'String' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

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:

@michaeltlombardi michaeltlombardi force-pushed the gh-8799/main/backtick-single-chars branch from c3cbfaf to aa07bbb Compare May 12, 2022 18:11
@opbld33
Copy link

opbld33 commented May 12, 2022

Docs Build status updates of commit aa07bbb:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/CimCmdlets/Remove-CimInstance.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_WQL.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7.1)

This comment lists only the first 25 files in the pull request.
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:

@michaeltlombardi michaeltlombardi force-pushed the gh-8799/main/backtick-single-chars branch from aa07bbb to 80c673d Compare May 12, 2022 18:46
@opbld30
Copy link

opbld30 commented May 12, 2022

Docs Build status updates of commit 80c673d:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/CimCmdlets/Remove-CimInstance.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_WQL.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7.1)

This comment lists only the first 25 files in the pull request.
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:

michaeltlombardi and others added 12 commits May 12, 2022 14:05
This commit uses the regex "\((\\.\\.)\)" to find and replace
instances of pairs of backslash-escaped characters in the
reference docs with their backticked equivalent so they render
correctly instead of as normal text.
This commit uses the regex '([^`])\(`\)' and replace '$1`` ` ``' to find
and replace instances of a single backtick wrapped in parentheses with
the markdown to ensure they render correctly as code without greedily
replacing text it shouldn't.

For example:

    "Foo bar (`) baz"   => "Foo bar (`` ` ``) baz"

    "Foo bar (`(`) baz" => "Foo bar (`(`) baz
This commit uses the regex '\(\\(.)\)' and replace '(`$1`)' to find and
replace instances of an escaped single character wrapped in parentheses
with the markdown to ensure they render correctly as code.

It also updates a few escaped backticks (`` ` ``) which the previous
regex did not find because they were escaped.
Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
@sdwheeler sdwheeler force-pushed the gh-8799/main/backtick-single-chars branch from 80c673d to 3fe47b2 Compare May 12, 2022 19:05
@opbld30
Copy link

opbld30 commented May 12, 2022

Docs Build status updates of commit 3fe47b2:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/CimCmdlets/Remove-CimInstance.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_WQL.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Security/About/about_Certificate_Provider.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/ConvertFrom-StringData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Debuggers.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Core/About/about_Properties.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Clear-Content.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Get-ItemProperty.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Move-Item.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Management/Start-Service.md ✅Succeeded View (powershell-7.1)

This comment lists only the first 25 files in the pull request.
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 3b098b7 into MicrosoftDocs:main May 12, 2022
@michaeltlombardi michaeltlombardi deleted the gh-8799/main/backtick-single-chars branch May 26, 2022 21:33
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.

5 participants