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-8665) Standardize "See also" section of about_* documents for 5.1 #8666

Conversation

michaeltlombardi
Copy link
Contributor

PR Summary

This PR begins the work outlined in #8665 to align the formatting of the "See also" section of the about_* documents. This PR targets only Windows PowerShell 5.1 to make the PR more reviewable.

In particular, this PR:

  1. Ensures that the section header is sentence cased, not upper cased
  2. Uses an unordered list for each entry
  3. Arranges the entries alphabetically first by type (about_*, cmdlet, other), then noun (for cmdlets) or category (for about_*, such as the operators documents), then title.

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 staging 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 Mar 18, 2022

Docs Build status updates of commit 82c43d8:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/About.md ⚠️Warning View (powershell-5.1) Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Alias_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Aliases.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Arrays.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Assignment_Operators.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Automatic_Variables.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Calculated_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Character_Encoding.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_CimSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Classes.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Command_Precedence.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Comparison_Operators.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Continue.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Core_Commands.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Data_Sections.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_DesiredStateConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Do.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_DscLogResource.md ✅Succeeded
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Eventlogs.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Execution_Policies.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Foreach.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Methods.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Argument_Completion.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_CmdletBindingAttribute.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_OutputTypeAttribute.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Group_Policy_Settings.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Hash_Tables.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Hidden.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_History.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_If.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Job_Details.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Jobs.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Join.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Line_Editing.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Locations.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Logging.md ✅Succeeded View (powershell-5.1)

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

reference/5.1/Microsoft.PowerShell.Core/About/About.md

  • Line 76, Column 5: [Warning: file-not-found - See documentation] Invalid file link: 'about_dsclogresource.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:

@michaeltlombardi michaeltlombardi changed the title (GH-8665) Standardize "See also" section of About_* documents for 5.1 (GH-8665) Standardize "See also" section of about_* documents for 5.1 Mar 18, 2022
@opbld32
Copy link

opbld32 commented Mar 18, 2022

Docs Build status updates of commit c1ff3a2:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/About.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Alias_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Aliases.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Arrays.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Assignment_Operators.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Automatic_Variables.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Calculated_Properties.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Character_Encoding.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_CimSession.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Classes.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Command_Precedence.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Comparison_Operators.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Continue.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Core_Commands.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Data_Sections.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_DesiredStateConfiguration.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Do.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_DscLogResource.md ✅Succeeded
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Eventlogs.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Execution_Policies.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_FileSystem_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Foreach.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Methods.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Argument_Completion.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_CmdletBindingAttribute.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_OutputTypeAttribute.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Group_Policy_Settings.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Hash_Tables.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Hidden.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_History.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_If.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Job_Details.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Jobs.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Join.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Line_Editing.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Locations.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Logging.md ✅Succeeded View (powershell-5.1)

This comment lists only the first 50 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 183527a into MicrosoftDocs:staging Mar 18, 2022
@michaeltlombardi michaeltlombardi deleted the GH-8665/staging/standardize-5.1 branch March 21, 2022 18:21
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.

None yet

3 participants