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) Correctly format core reference docs #8832

Merged

Conversation

michaeltlombardi
Copy link
Contributor

PR Summary

Fixes #8799.

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.

@opbld33
Copy link

opbld33 commented May 18, 2022

Docs Build status updates of commit 4c3e70a:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Get-Module.md ⚠️Warning View (powershell-5.1) Details
reference/5.1/Microsoft.PowerShell.Core/Connect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disconnect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSessionOption.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Remove-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-StrictMode.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Unregister-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/Connect-PSSession.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Disconnect-PSSession.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Get-Module.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Get-PSSession.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/New-PSSession.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/New-PSSessionOption.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Remove-PSSession.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Set-StrictMode.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Unregister-PSSessionConfiguration.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7)

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

reference/5.1/Microsoft.PowerShell.Core/Get-Module.md

  • Line 0, Column 0: [Warning: file-not-found - See documentation] Invalid file link: 'About/about_PowerShell_Editions.md'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

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.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

sdwheeler
sdwheeler previously approved these changes May 18, 2022
Copy link
Contributor

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

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

Fix the syntax block formatting

@opbld30
Copy link

opbld30 commented May 18, 2022

Docs Build status updates of commit ab00351:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Get-Module.md ⚠️Warning View (powershell-5.1) Details
reference/5.1/Microsoft.PowerShell.Core/Clear-History.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Connect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disconnect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSessionOption.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Remove-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-StrictMode.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Unregister-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Diagnostics/Import-Counter.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/Clear-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-HotFix.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/Get-Process.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/New-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Remove-PSDrive.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Format-List.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/5.1/PowershellGet/Find-RoleCapability.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/Clear-History.md ✅Succeeded View (powershell-7)

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

reference/5.1/Microsoft.PowerShell.Core/Get-Module.md

  • Line 0, Column 0: [Warning: file-not-found - See documentation] Invalid file link: 'About/about_PowerShell_Editions.md'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

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.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@opbld33
Copy link

opbld33 commented May 18, 2022

Docs Build status updates of commit 813fe88:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Clear-History.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Connect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disconnect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-Module.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSessionOption.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Remove-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-StrictMode.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Unregister-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Diagnostics/Import-Counter.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/Clear-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-HotFix.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/Get-Process.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/New-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Remove-PSDrive.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Format-List.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/5.1/PowershellGet/Find-RoleCapability.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/Clear-History.md ✅Succeeded View (powershell-7)

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:

@opbld33
Copy link

opbld33 commented May 18, 2022

Docs Build status updates of commit f6bfa64:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Clear-History.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Connect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disconnect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-Module.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSessionOption.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Remove-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-StrictMode.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Unregister-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Diagnostics/Import-Counter.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/Clear-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-HotFix.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/Get-Process.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/New-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Remove-PSDrive.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Format-List.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/5.1/PowershellGet/Find-RoleCapability.md ✅Succeeded View (powershell-5.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:

@opbld33
Copy link

opbld33 commented May 18, 2022

Docs Build status updates of commit 437caa9:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Clear-History.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Connect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disable-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Disconnect-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-Module.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Get-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/New-PSSessionOption.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Remove-PSSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Set-StrictMode.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Unregister-PSSessionConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Diagnostics/Import-Counter.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/Clear-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Get-HotFix.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/Get-Process.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/New-EventLog.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Management/Remove-PSDrive.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Format-List.md ✅Succeeded View (powershell-5.1)
reference/5.1/PSScheduledJob/New-JobTrigger.md ✅Succeeded View (powershell-5.1)
reference/5.1/PowershellGet/Find-RoleCapability.md ✅Succeeded View (powershell-5.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 7e84317 into MicrosoftDocs:main May 18, 2022
@michaeltlombardi michaeltlombardi deleted the gh-8799/main/backtick-core 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.

Fix patterns where character in parens not backticked
4 participants