Skip to content

FIXES #2341 - Updates PowerShell formatting information - #6084

Merged
Sean Wheeler (sdwheeler) merged 8 commits into
MicrosoftDocs:stagingfrom
chasewilson:chasewilson-ghi2341
Jun 8, 2020
Merged

Sean Wheeler (sdwheeler) merged 8 commits into
MicrosoftDocs:stagingfrom
chasewilson:chasewilson-ghi2341

Conversation

@chasewilson

Copy link
Copy Markdown
Contributor

PR Summary

There are multiple updates pertaining to format.ps1xml including about topics, and *-FormatData cmdlets.

PR Context

Fixes #2341

Select the type(s) of documents being changed.

Cmdlet reference & about_ topics

  • Version 7.1 preview content
  • Version 7.0 content
  • Version 6 content
  • Version 5.1 content

Conceptual content

  • Fundamental conceptual articles
  • Script sample articles
  • DSC articles
  • Gallery articles
  • JEA articles
  • WMF articles
  • SDK articles
  • Community 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.

@opbld31

opbld31 commented Jun 8, 2020

Copy link
Copy Markdown

Docs Build status updates of commit d8e3059:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-5.1)
reference/6/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-6)
reference/6/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-6)
reference/6/Microsoft.PowerShell.Utility/Get-FormatData.md ✅Succeeded View (powershell-6)
reference/6/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-6)
reference/7.0/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Get-FormatData.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Utility/Get-FormatData.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-7.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:

*
- To use any formatting file, including an exported formatting file, the execution policy for the
session must allow scripts and configuration files to run. For more information, see
about_Execution_Policies.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Link to about topic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

*
- To use any formatting file, including an exported formatting file, the execution policy for the
session must allow scripts and configuration files to run. For more information, see
about_Execution_Policies.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Link to about topic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

*
- To use any formatting file, including an exported formatting file, the execution policy for the
session must allow scripts and configuration files to run. For more information, see
about_Execution_Policies.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

link to about topic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

*
- To use any formatting file, including an exported formatting file, the execution policy for the
session must allow scripts and configuration files to run. For more information, see
about_Execution_Policies.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

link to about topic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

{Microsoft.Powershell.Utility.FileHash} {Microsoft.Powershell.Utility.FileHash}
```

> [!IMPORTANT]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure why you removed this. Can you explain?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In PowerShell 7.1, it will return all formatting by default. If i'm reading things correctly, you should be able to omit the PowerShell version now and receive all appropriate Formatting information.

PowerShell/PowerShell#4237

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OK, I was wondering if that got fixed. That makes sense.

@opbld32

opbld32 commented Jun 8, 2020

Copy link
Copy Markdown

Docs Build status updates of commit 757184b:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-5.1)
reference/6/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-6)
reference/6/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-6)
reference/6/Microsoft.PowerShell.Utility/Get-FormatData.md ✅Succeeded View (powershell-6)
reference/6/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-6)
reference/7.0/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Get-FormatData.md ✅Succeeded View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Utility/Export-FormatData.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Utility/Get-FormatData.md ✅Succeeded View (powershell-7.1)
reference/7.1/Microsoft.PowerShell.Utility/Update-FormatData.md ✅Succeeded View (powershell-7.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:

@sdwheeler
Sean Wheeler (sdwheeler) merged commit e2375d2 into MicrosoftDocs:staging Jun 8, 2020
@chasewilson
Chase Wilson (chasewilson) deleted the chasewilson-ghi2341 branch June 23, 2020 22:28
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.

Update about_Format.ps1xml with link to Export-FormatData, rewrite the authoring example to use it

4 participants