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-8706) Clarify about_Environment_Variables #8710

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Mar 31, 2022

PR Summary

Prior to this PR, the about_Environment_Variables topic included misleading examples that would error if run in sequence. Additionally, the organization and content of the document hid some useful information in later sections, was difficult to follow, and lacked output examples.

This PR is a rewrite and restructuring of the document. The documents new flow explains, in order:

  1. The most important information about environment variables in the long description
  2. How to use/change environment variables
  3. How to persist changes to environment variables
  4. What environment variables PowerShell adds and uses

This PR resolves #8706.

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 31, 2022

Docs Build status updates of commit c8b4182:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-5.1)

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:

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.

LGTM - copy the changes across the versions

Prior to this commit, the `about_Environment_Variables` topic included
misleading examples that would error if run in sequence. Additionally,
the organization and content of the document hid some useful information
in later sections, was difficult to follow, and lacked output examples.

This commit is a rewrite and restructuring of the document. The
documents new flow explains, in order:

1. The most important information about environment variables in the
   long description
2. How to use/change environment variables
3. How to persist changes to environment variables
4. What environment variables PowerShell adds and uses
@michaeltlombardi michaeltlombardi force-pushed the GH-8706/staging/clarify-about_Environment_Variables branch from c8b4182 to 87e6633 Compare April 1, 2022 17:02
@opbld32
Copy link

opbld32 commented Apr 1, 2022

Docs Build status updates of commit 87e6633:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.3)

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 changed the title WIP: (GH-8706) Clarify about_Environment_Variables (GH-8706) Clarify about_Environment_Variables Apr 1, 2022
@michaeltlombardi michaeltlombardi marked this pull request as ready for review April 1, 2022 17:06
@sdwheeler sdwheeler merged commit cf4611e into MicrosoftDocs:staging Apr 1, 2022
@michaeltlombardi michaeltlombardi deleted the GH-8706/staging/clarify-about_Environment_Variables branch May 5, 2022 17:32
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.

Clarify and correct examples in about_Environment_Variables
3 participants