Skip to content

Merge latest changes into live #2092

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

Merged
merged 235 commits into from
Feb 2, 2018
Merged
Changes from all commits
Commits
Show all changes
235 commits
Select commit Hold shift + click to select a range
2a3ccf3
Update the example of `Where-Object -IsNot` (#1841)
matt9ucci Nov 7, 2017
f778a37
Update Example 5 in Group-Object.md (#1845)
matt9ucci Nov 8, 2017
1357977
removing @{Text=} tags
Nov 7, 2017
efba651
fixing UTF8 characters
Nov 7, 2017
b93a6ba
removed empty H3
Nov 7, 2017
ec505bf
added H3 for input and output types
Nov 7, 2017
c2abb44
removed mangled UTF8 character
Nov 8, 2017
bbffd77
updating Out-* commands with -NoNewLine per Issue 1739
Nov 9, 2017
2bdb9e6
Fix the example of `Format-Table -DisplayError` (#1848)
matt9ucci Nov 9, 2017
61cb77d
Fix the example of `Format-Wide -DisplayError` (#1850)
matt9ucci Nov 10, 2017
882b0e8
Fix the example of `Format-Custom -DisplayError` (#1849)
matt9ucci Nov 10, 2017
67db02a
updating set-acl docs per PR#901
Nov 7, 2017
9799c2b
using semantic link breaks
Nov 10, 2017
a5f21c5
Fix the example of `Format-Wide -ShowError` (#1851)
matt9ucci Nov 13, 2017
9467262
Fixed Test-ScriptFileInfo example (#1852)
alan-null Nov 13, 2017
b5d12a3
fixing issue 1768
Nov 7, 2017
b04197f
Formatting, example fix for Body parameter (#1847)
ebrucucen Nov 13, 2017
b6b156a
fixing style consistency across articles
Nov 13, 2017
e03a354
fixing conflicts
Nov 13, 2017
07b21b0
Fix example numbers in Resume-Job.md (#1857)
matt9ucci Nov 14, 2017
348ed70
Fixes typo $WebSiteName in separatingEnvData.md (#1856)
DexterPOSH Nov 14, 2017
b04a75a
Updates configurations.md (#1855)
DexterPOSH Nov 14, 2017
484d598
Fix typo in comment (#1854)
ciriarte Nov 14, 2017
e46d3a1
Merge pull request #1846 from sdwheeler/sdw-issue1739
zjalexander Nov 14, 2017
f42a62f
Updating the help content for v6. (#1853)
adityapatwardhan Nov 15, 2017
eade8e4
Fix example numbers in about_Transactions.md (#1859)
matt9ucci Nov 15, 2017
518fde2
Update Alias-Provider.md (#1831)
doctordns Nov 15, 2017
248e283
Add documentation of new -AsHashtable switch for ConvertFrom-Json int…
bergmeister Nov 15, 2017
bcedaf0
Fix example numbers in Invoke-WebRequest.md (#1862)
matt9ucci Nov 16, 2017
8e4ac81
Merge branch 'live' into staging
Nov 16, 2017
1f54577
reformatting and integrating changes from PR#1831 (#1860)
Nov 16, 2017
aeeb091
Fix example numbers in Get-Help.md (#1869)
matt9ucci Nov 17, 2017
83b1241
Fix example numbers in Import-Module.md (#1868)
matt9ucci Nov 17, 2017
99be9ad
Fix example number in ConvertTo-Html.html (#1867)
matt9ucci Nov 17, 2017
919d940
Update dscCiCd.md (#1865)
tomlarse Nov 17, 2017
cb00730
Web Cmdlets 6.0.0 Documentation Refresh (#1870)
markekraus Nov 18, 2017
6e31c85
Merge Example 4 and 5 in Get-Member.md (#1874)
matt9ucci Nov 18, 2017
cc018bf
Remove hash algorithms unsupported in v6.0 (#1873)
matt9ucci Nov 19, 2017
b98aa67
Update outputs of Get-Verb (#1872)
matt9ucci Nov 19, 2017
1b2889e
Fix typo in ConvertTo-Html.md (UTF-x) (#1879)
matt9ucci Nov 20, 2017
4fec39b
Fix "Accept wildcard characters" in Get-Service.md v6 (#1878)
matt9ucci Nov 20, 2017
061245d
Fixed Get-WindowsFeature cmdlet HyperLink (#1877)
keeratsingh Nov 20, 2017
496832f
Update Get-WinEvent.md (#1876)
doctordns Nov 20, 2017
c644c38
Update Example 8 in Get-Process.md (find the owner of a process) (#1875)
matt9ucci Nov 20, 2017
58b15dd
updated localmachine\Root to LocalMachine\My (#1880)
rchaganti Nov 20, 2017
69c037d
Update Group property example in Get-Verb.md (#1881)
matt9ucci Nov 21, 2017
d69465e
adding missing space (#1885)
mairaw Nov 21, 2017
a066c77
removing stray character (#1886)
mairaw Nov 21, 2017
bf70ac9
Update Example 9 in Get-Process.md (#1888)
matt9ucci Nov 22, 2017
6687a84
Remove "About ISE" files of v6.0 (#1891)
matt9ucci Nov 27, 2017
23afc78
Update Get-Process.md (#1890)
doctordns Nov 27, 2017
5a8d5f4
Update productincompat.md (#1892)
Cloud-Writer Nov 27, 2017
46d7c99
Update unapproved verbs examples in Get-Verb.md (#1896)
matt9ucci Nov 28, 2017
a88c947
Removing extra space in the Example 5A script (#1894)
vrnithinkumar Nov 28, 2017
a2d0e9b
fixing merge conflict
Nov 28, 2017
f0f0da0
resolving conflict
Nov 28, 2017
d395d0e
updates to style and contrib
Nov 16, 2017
d4d446d
tweak format
Nov 16, 2017
67ad296
tweak format 2
Nov 16, 2017
7883844
fix typo
Nov 16, 2017
b4877f3
fix number list example
Nov 16, 2017
9e6ebd0
adding review feedback
Nov 22, 2017
323e325
fix broken links
Nov 22, 2017
e6b4a53
incorporating feedback from zach
Nov 27, 2017
7514fcf
reformatting About_* for 80 columns - part 1
Nov 27, 2017
66ecafd
reformat about_*
Nov 28, 2017
56dc2df
reformatting About_* topics - Part 2
Nov 28, 2017
d310e14
fixing broken links
Nov 28, 2017
e084dc5
fixing more broken links
Nov 28, 2017
05ff294
more broken links fixed
Nov 28, 2017
a935671
Fix parameter's position in Get-Random.md (#1901)
matt9ucci Nov 29, 2017
9040d65
Fix parameter's position in Measure-Command.md (#1905)
matt9ucci Nov 30, 2017
c715ab2
Fix parameter's position in Trace-Command.md (#1904)
matt9ucci Nov 30, 2017
6824d85
Actually call the configuration in the example (#1906)
charlesbihis Nov 30, 2017
cece485
reformatting About_* for 80 columns - part 3 (#1902)
Nov 30, 2017
877c2cc
reformatting About_* for 80 columns - part 4
Nov 30, 2017
1e0c256
Adding PreRelease versioning info for PSGallery & PSGet (#1903)
Dec 1, 2017
38d64d4
Style tweaks in STYLE.md (#1913)
SamB Dec 2, 2017
c6f3f13
Fix YAML metadata on "Understanding Concepts" (#1911)
SamB Dec 2, 2017
92e1b1b
Fix parameter's position in Join-Path.md (#1909)
matt9ucci Dec 2, 2017
b71d428
typo correction on line 85 (#1916)
J0F3 Dec 4, 2017
4e6505f
Fix parameter's position in Get-TraceSource.md (#1917)
matt9ucci Dec 4, 2017
a935850
Changed required PSGet version to 1.6.0 (#1920)
Dec 4, 2017
96504e3
Update Example 5 in Get-Process.md (#1923)
matt9ucci Dec 5, 2017
f586a98
fixing backlashes reported in PR1921 (#1924)
Dec 5, 2017
a08dbd5
Merge branch 'live' into staging
Dec 5, 2017
66349ff
reformatting About_* for 80 columns - part 5
Dec 1, 2017
6424e0d
reformatting About_* for 80 columns - part 6
Dec 1, 2017
03211c6
incorporating review feedback
Dec 4, 2017
a0b952c
reformatting About_* for 80 columns - part 7
Dec 2, 2017
bbe8f07
Fixed formatting of output per issue #808
Dec 4, 2017
eb2a12b
Merge branch 'live' into staging
Dec 5, 2017
6976ff4
Fix typo in syntax description (#1931)
TheSecretSquad Dec 6, 2017
6712f85
Fix parameter's position in ConvertTo-Xml.md (#1929)
matt9ucci Dec 6, 2017
6686c23
Remove descriptions about ComputerName parameter in Get-Process.md v6…
matt9ucci Dec 6, 2017
a0b2502
Line 192 Single Quote Breaks Example (#1930)
YuriySamorodov Dec 6, 2017
00a2675
Update Example 2 in Get-Alias.md (ineffective Exclude) (#1935)
matt9ucci Dec 7, 2017
010d9e5
Fix formatting: DESCRIPTION section in ConvertTo-Xml.md (#1934)
matt9ucci Dec 7, 2017
89de813
Fix typo in Unregister-ScheduledJob (#1932)
wemyss Dec 7, 2017
59ff97e
Fix parameter's position in ConvertFrom-Csv.md (#1937)
matt9ucci Dec 8, 2017
d428986
fix typo on metaConfig.md (#1936)
DaniSQL Dec 8, 2017
c070f79
Quick edits (#1938)
Dec 8, 2017
5119bda
Update Get-Item.md (#1942)
skycommand Dec 11, 2017
54a3de4
Add description about Format-Hex -InputObject (#1939)
matt9ucci Dec 11, 2017
4e663d6
Fix parameter's position in Add-Member.md (#1946)
matt9ucci Dec 12, 2017
2342a7e
Fix parameter's position in Select-Object.md (#1945)
matt9ucci Dec 12, 2017
7e23ff9
Correcting add to hash table example (#1944)
Koshersalt Dec 12, 2017
7009825
Merge branch 'live' into staging
Dec 12, 2017
4e99941
Fix Set-TraceSource -ListenerOption parameter (#1949)
matt9ucci Dec 13, 2017
85a3adb
Fix Trace-Command -ListenerOption parameter (#1948)
matt9ucci Dec 13, 2017
ba3ae32
Fix parameter's position in Select-Xml.md (#1953)
matt9ucci Dec 14, 2017
e9721d2
Fix Get-Alias -Name parameter (#1952)
matt9ucci Dec 14, 2017
41dc145
Wmf 5.1 cleanup (#1950)
Dec 14, 2017
c11cc97
Typo fix ("you will are not" -> "you will not"). (#1951)
relsqui Dec 14, 2017
8be92ec
added article about formatting code samples
Dec 14, 2017
52c3d1d
fixing typos
Dec 14, 2017
da136b5
fixed typos and incorporated feedback
Dec 14, 2017
7f1bfb6
updating metadata tags in docfx.json
Dec 14, 2017
4a0e687
Merge pull request #1954 from sdwheeler/sdw-codestyle
joeyaiello Dec 14, 2017
f190e9d
Merge pull request #1955 from sdwheeler/sdw-metafix
joeyaiello Dec 14, 2017
ff9fc52
Merge branch 'live' into staging
Dec 14, 2017
d0b75bb
fixing filename spelling
Dec 14, 2017
8c303f1
Fix parameter's position in Get-Content.md (#1959)
matt9ucci Dec 15, 2017
2dffaff
Fix parameter's position in Get-Member.md (#1958)
matt9ucci Dec 15, 2017
fa5064b
Update PSGallery "Items Tab" (for the new prerelease feature) (#1957)
matt9ucci Dec 15, 2017
8190bfc
Fix link for about_WorkflowCommonParameters in New-PSWorkflowExecutio…
matt9ucci Dec 18, 2017
9cfd38a
Fix link for about_Types.ps1xml in Update-TypeData.md (#1961)
matt9ucci Dec 18, 2017
219e848
Fix parameter's position in Group-Object.md (#1966)
matt9ucci Dec 19, 2017
91a778c
Fix hex values in about_Arithmetic_Operators.md (#1965)
matt9ucci Dec 19, 2017
7569a34
Indent headers as subheaders (#1967)
lavahot Dec 19, 2017
a6c39a2
Update minor typo in Limit-EventLog.md (#1968)
DannyMeister Dec 19, 2017
4dfa90f
Update Example 3 in Get-FileHash.md (#1969)
matt9ucci Dec 20, 2017
9603e0f
Fix parameter's position in Tee-Object.md (#1970)
matt9ucci Dec 20, 2017
45517f9
fixing output example per issue 1933
Dec 20, 2017
4c8ad5c
fix -Path metadata to reflect wildcard support
Dec 20, 2017
7f07ed2
fixing issue 1640
Dec 20, 2017
e3d2746
fixing issue 1651
Dec 20, 2017
83a1f36
Merge pull request #1974 from sdwheeler/sdw-issue1651
joeyaiello Dec 20, 2017
9fea401
Merge pull request #1973 from sdwheeler/sdw-issue1640
joeyaiello Dec 20, 2017
703bce7
Merge pull request #1972 from sdwheeler/sdw-issue1672
joeyaiello Dec 20, 2017
700455e
Merge pull request #1971 from sdwheeler/sdw-issue1933
joeyaiello Dec 20, 2017
2247085
Fix link for about_Remote_Requirements (#1976)
matt9ucci Dec 21, 2017
2f7bd31
Split parameter set in Sort-Object.md v6.0 (#1975)
matt9ucci Dec 21, 2017
bfb1184
Merge branch 'live' into staging
Dec 21, 2017
1854c4d
Fix link for about_Preference_Variables (#1982)
matt9ucci Dec 22, 2017
34e0059
Fix broken headers in Get-CimSession.md v6.0 (#1981)
matt9ucci Dec 22, 2017
bd76183
Update Example 1 in Import-Counter.md (#1980)
matt9ucci Dec 22, 2017
ce0b7c1
move $OFS to prefs article added note about read-only (#1978)
Dec 22, 2017
4ff282e
Merge branch 'live' into staging
Dec 22, 2017
62d8b8a
Update decisionMaker.md (#1984)
rockygiglio Dec 30, 2017
6a1218a
Update configurations.md (#1985)
bradh Dec 30, 2017
ccb1710
Fix parameter's position in Restart-Service.md (#1993)
matt9ucci Jan 2, 2018
8eca7bc
Fix link for logical operators in about_Operator_Precedence.md (#1992)
matt9ucci Jan 2, 2018
272aa18
Update scriptResource.md (#1986)
bradh Jan 2, 2018
c454e5d
Bad link (#1988)
fullenw1 Jan 2, 2018
cb095ea
Update Example 1 of Protect-CmsMessage (#1987)
BladeFireLight Jan 2, 2018
8d405c1
Small edits for mispellings (#1989)
hintbw Jan 2, 2018
e777b83
Corrected command (#1990)
Jan 2, 2018
d0b6eb8
removing module ref for modules that do not ship in v6-rc2 (#1996)
Jan 2, 2018
160ba5e
Fix parameter's position in Resume-Service.md (#1998)
matt9ucci Jan 3, 2018
0e1efd4
Fix link for about_Providers (#1999)
matt9ucci Jan 3, 2018
ea3e851
Merge branch 'live' into staging
Jan 3, 2018
b1a95ce
Help doc enhancement for ConvertFrom-StringData cmdlet (#2002)
kvprasoon Jan 3, 2018
fa96dbb
PowerShell 6 logging on Windows, Linux, and MacOS (#1922)
dantraMSFT Jan 3, 2018
1ed352f
Adding calling the ComputerName parameter to the example (#1964)
mbreakey3 Jan 3, 2018
43ba68f
Removed unused variable in Example 1 (#2004)
Jan 4, 2018
308c233
Made surrounding text agree with sample code. (#2003)
regexaurus Jan 4, 2018
a2607ed
Reformatting v4 About_ topics missed in first pass (#2006)
Jan 4, 2018
e740350
Reformatting v3 About_ topics missed in first pass (#2005)
Jan 4, 2018
98f2b8a
Reformatting v5 About_ topics missed in first pass (#2008)
Jan 4, 2018
95d4005
v5.1 about scrub missed files (#2009)
Jan 4, 2018
c4bc861
Reformatting v6 About_ topics missed in first pass (#2010)
Jan 4, 2018
6c34220
final pass on About_ topic reformat (#2011)
Jan 5, 2018
27973f4
Merge branch 'live' into staging
Jan 5, 2018
11244d2
Corrected Example 3 (#2014)
Jan 5, 2018
f2f819f
Enable running pandoc on about topic files (#2012)
adityapatwardhan Jan 5, 2018
e7835e3
Creates output directory as pandoc needs it (#2018)
adityapatwardhan Jan 6, 2018
9a59fc6
Merge branch 'live' into staging
Jan 6, 2018
607b9f4
remove alias `sc` to match PSCore6 (#2021)
SteveL-MSFT Jan 9, 2018
3fceb89
Cmdlet help for ConvertFrom-Clixml and ConvertTo-Clixml (#2022)
charlieschmidt Jan 9, 2018
d9aa756
fix broken link (#2024)
Jan 9, 2018
38d2060
Adding more info to Contributor Guide (#2023)
Jan 10, 2018
7298a9d
Support lifecycle doc (#1994)
joeyaiello Jan 10, 2018
d05c00e
Move setup/install and remoting docs into PowerShell-Docs (#2026)
joeyaiello Jan 10, 2018
76160fe
PowerShell Core 6.0 release notes (#2020)
joeyaiello Jan 10, 2018
c4734c8
Merge branch 'live' into staging
Jan 10, 2018
4e8ebb8
update TOC and change title of setup mac/linux article (#2030)
Jan 10, 2018
d2b1b89
Merge branch 'live' into staging
Jan 10, 2018
436a35a
attempt to fix images (#2033)
Jan 11, 2018
debdacf
Merge branch 'live' into staging
Jan 11, 2018
491970b
Update docfx to add image support (#2040)
Jan 11, 2018
7eb9814
Update Installing-PowerShell-Core-on-Windows.md (#2042)
doctordns Jan 11, 2018
18fedf7
Fix $PSVersionTable.OS in What's New 6.0 (#2039)
matt9ucci Jan 11, 2018
6026e8d
Update WSMan-Remoting-in-PowerShell-Core.md (#2038)
Jan 11, 2018
2947472
Update Get-FormatData.md (#2034)
MSAdministrator Jan 11, 2018
b507330
Update Get-FormatData Markdown (#2035)
MSAdministrator Jan 11, 2018
c2ffb26
Updated Get-Runspace Help (#2032)
MSAdministrator Jan 11, 2018
cebcd52
updated docfx to try to fix images (#2043)
Jan 11, 2018
81a2dda
Add resource per version in docfx.json (#2046)
qinezh Jan 12, 2018
69e1113
Merge branch 'live' into staging
Jan 12, 2018
a98db07
Change 'PowerShellProperties.json' to 'powershell.config.json' in abo…
daxian-dbw Jan 12, 2018
e0f0486
OPS Build config changes and minor article edits (#2051)
Jan 12, 2018
cf5f956
Update New-PSSessionOption.md (#2052)
berberich Jan 12, 2018
78a132d
Update Add-Member.md example layouts (#2055)
shanehoey Jan 16, 2018
8f3410a
Removes unnecessary description about the RunAsAdministrator paramete…
exchange12rocks Jan 16, 2018
a443952
Fix Example 2 in Set-PSReadlineKeyHandler.md (#2058)
matt9ucci Jan 16, 2018
8fd856c
Fix Example 1 in Remove-PSReadlineKeyHandler.md (#2059)
matt9ucci Jan 16, 2018
2de1cc3
Fix minor Markdown syntax error (#2060)
0xfeeddeadbeef Jan 16, 2018
8d53e25
Update secureMOF.md (#2061)
egor-yudkin Jan 16, 2018
a75c405
remove eric and jp from metadata
Jan 16, 2018
db54ddf
update docs to reflect change by https://github.com/PowerShell/PowerS…
SteveL-MSFT Jan 17, 2018
3c4b867
Merge branch 'live' into staging
Jan 17, 2018
ed50087
Fix release links/names (6.0.0) (#2056)
Velocet Jan 17, 2018
c11fbe3
Removes unexistent RunAsAdministrator parameter from the Syntax secti…
exchange12rocks Jan 17, 2018
ba0642f
Fixed path inconsistencies in Set-ItemProperty Example 2 (#2072)
davidhaymond Jan 19, 2018
4ebb0df
Updated About documentation links to relative paths (#2071)
jmlane Jan 19, 2018
523b837
Gallery ui manifest (#2073)
Jan 19, 2018
e4bcd0a
Escapes angle brackets in about_Requires (#2075)
exchange12rocks Jan 19, 2018
88860d1
add links for topics
Jan 17, 2018
67fb9db
About_Windows_PowerShell_5.1 #1171
Jan 17, 2018
4804699
fix typo
Jan 17, 2018
c437575
about_Type_Operators issues #1915
Jan 17, 2018
1d3e524
fix typos
Jan 18, 2018
4342e06
add note about reboot (#2076)
Jan 20, 2018
c9ab8c8
Removed empty bullet point below notes. (#2078)
doctordns Jan 31, 2018
6943d03
change PowerShellProperties.json to powershell.config.json (#2079)
stknohg Jan 31, 2018
860e2a6
Update metaConfig.md (#2081)
jpalo Jan 31, 2018
cf184e9
Fix typo in code example (#2082)
johlju Jan 31, 2018
ae4ffe4
Fix example VB code (#2084)
diev Jan 31, 2018
d77f685
Adds missing SslProtocol parameter from Invoke-WebRequest cmdlet. (#2…
thezim Jan 31, 2018
a9aab29
Import-Csv Update examples, and UseCulture (#2086)
wsmelton Jan 31, 2018
942a355
Use a working URL in Clipboard examples (#2087)
simon04 Jan 31, 2018
4ec3c46
Fixed bad link in about_Hash_Tables.md docs (#2090)
jmlane Feb 1, 2018
494fe71
restoring changes made in PR#1870 (#2089)
Feb 1, 2018
99a464c
Merge branch 'live' into staging
Feb 1, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ Each folder in this repo publishes to [MSDN](https://msdn.microsoft.com/en-us/po
* [/dsc/](https://msdn.microsoft.com/en-us/powershell/dsc/) is for the Desired State Configuration feature
* [/gallery/](https://msdn.microsoft.com/powershell/gallery) is for the [PowerShell Gallery](https://www.powershellgallery.com/)
* [/jea/](https://msdn.microsoft.com/powershell/jea/) is for the Just Enough Administration feature
* [/reference/](https://msdn.microsoft.com/powershell/reference/) is for PowerShell module reference across versions 2.0, 3.0, 4.0, 5.0, 5.1, and 6.0
* [/reference/](https://msdn.microsoft.com/powershell/reference/) is for PowerShell module reference across versions 3.0, 4.0, 5.0, 5.1, and 6.0
* This content will be retrieved by the `Get-Help` cmdlet in the future
* [/scripting/](https://msdn.microsoft.com/en-us/powershell/scripting/) is general PowerShell reference content
* [/wmf](https://msdn.microsoft.com/en-us/powershell/wmf/readme) contains release notes for the Windows Management Framework, the package used to distribute new versions of PowerShell to previous versions of Windows.
2 changes: 1 addition & 1 deletion dsc/authoringResourceComposite.md
Original file line number Diff line number Diff line change
@@ -197,7 +197,7 @@ To access the user context from within a custom resource, you can use the automa
For example the following code would write the user context under which the resource is running to the verbose output stream:

```powershell
if (PsDscContext.RunAsUser) {
if ($PsDscContext.RunAsUser) {
Write-Verbose "User: $PsDscContext.RunAsUser";
}
```
2 changes: 1 addition & 1 deletion dsc/metaConfig.md
Original file line number Diff line number Diff line change
@@ -81,7 +81,7 @@ The following properties are available in a **Settings** block.
| CertificateID| string| The thumbprint of a certificate used to secure credentials passed in a configuration. For more information see [Want to secure credentials in Windows PowerShell Desired State Configuration](http://blogs.msdn.com/b/powershell/archive/2014/01/31/want-to-secure-credentials-in-windows-powershell-desired-state-configuration.aspx)?. <br> __Note:__ this is managed automatically if using Azure Automation DSC pull service.|
| ConfigurationDownloadManagers| CimInstance[]| Obsolete. Use __ConfigurationRepositoryWeb__ and __ConfigurationRepositoryShare__ blocks to define configuration pull service endpoints.|
| ConfigurationID| string| For backwards compatibility with older pull service versions. A GUID that identifies the configuration file to get from a pull service. The node will pull configurations on the pull service if the name of the configuration MOF is named ConfigurationID.mof.<br> __Note:__ If you set this property, registering the node with a pull service by using __RegistrationKey__ does not work. For more information, see [Setting up a pull client with configuration names](pullClientConfigNames.md).|
| ConfigurationMode| string | Specifies how the LCM actually applies the configuration to the target nodes. Possible values are __"ApplyOnly"__,__"ApplyandMonitior"__, and __"ApplyandAutoCorrect"__. <ul><li>__ApplyOnly__: DSC applies the configuration and does nothing further unless a new configuration is pushed to the target node or when a new configuration is pulled from a service. After initial application of a new configuration, DSC does not check for drift from a previously configured state. Note that DSC will attempt to apply the configuration until it is successful before __ApplyOnly__ takes effect. </li><li> __ApplyAndMonitor__: This is the default value. The LCM applies any new configurations. After initial application of a new configuration, if the target node drifts from the desired state, DSC reports the discrepancy in logs. Note that DSC will attempt to apply the configuration until it is successful before __ApplyAndMonitor__ takes effect.</li><li>__ApplyAndAutoCorrect__: DSC applies any new configurations. After initial application of a new configuration, if the target node drifts from the desired state, DSC reports the discrepancy in logs, and then re-applies the current configuration.</li></ul>|
| ConfigurationMode| string | Specifies how the LCM actually applies the configuration to the target nodes. Possible values are __"ApplyOnly"__,__"ApplyAndMonitor"__, and __"ApplyAndAutoCorrect"__. <ul><li>__ApplyOnly__: DSC applies the configuration and does nothing further unless a new configuration is pushed to the target node or when a new configuration is pulled from a service. After initial application of a new configuration, DSC does not check for drift from a previously configured state. Note that DSC will attempt to apply the configuration until it is successful before __ApplyOnly__ takes effect. </li><li> __ApplyAndMonitor__: This is the default value. The LCM applies any new configurations. After initial application of a new configuration, if the target node drifts from the desired state, DSC reports the discrepancy in logs. Note that DSC will attempt to apply the configuration until it is successful before __ApplyAndMonitor__ takes effect.</li><li>__ApplyAndAutoCorrect__: DSC applies any new configurations. After initial application of a new configuration, if the target node drifts from the desired state, DSC reports the discrepancy in logs, and then re-applies the current configuration.</li></ul>|
| ConfigurationModeFrequencyMins| UInt32| How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15.|
| DebugMode| string| Possible values are __None__, __ForceModuleImport__, and __All__. <ul><li>Set to __None__ to use cached resources. This is the default and should be used in production scenarios.</li><li>Setting to __ForceModuleImport__, causes the LCM to reload any DSC resource modules, even if they have been previously loaded and cached. This impacts the performance of DSC operations as each module is reloaded on use. Typically you would use this value while debugging a resource</li><li>In this release, __All__ is same as __ForceModuleImport__</li></ul> |
| RebootNodeIfNeeded| bool| Set this to __$true__ to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is __$false__. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the [xPendingReboot](https://github.com/powershell/xpendingreboot) module.|
1 change: 1 addition & 0 deletions gallery/TOC.md
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@
### [Creating a PowerShellGallery Account](psgallery/psgallery_creating_an_account.md)
### [Creating and publishing items](psgallery/Creating-and-Publishing-an-item.md)
### [Publishing guidelines and best practices](psgallery/psgallery-PublishingGuidelines.md)
### [Item manifest and Gallery UI](psgallery/psgallery_ItemManifestAffectingUI.md)
### [Unlisting items](psgallery/psgallery_unlist_items.md)
### [Deleting items](psgallery/Deleting-Items.md)
### [Managing item owners](psgallery/Managing-Item-Owners.md)
139 changes: 139 additions & 0 deletions gallery/psgallery/psgallery_ItemManifestAffectingUI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# Item manifest values that impact the PowerShell Gallery UI

This topic provides publishers with summary information on how to modify the manifest for their PowerShell Gallery publications so that features of PowerShellGet cmdlets and the PowerShell Gallery UI will be affected.
This content is organized by where the change will appear, starting with the center section, then the navigation area on the left. There is a detail section covering tags, which identifies important tags, as well as some of the more commonly used tags.
There are two topics that provide manifest examples:

* For modules, see [Update Module Manifest](https://docs.microsoft.com/en-us/powershell/gallery/psget/module/psget_update-modulemanifest)
* For scripts, see [Create Script File with Metadata](https://docs.microsoft.com/en-us/powershell/gallery/psget/script/psget_new-scriptfileinfo)

## PowerShell Gallery Feature Elements Controlled by the Manifest

The table below shows the elements of the PowerShell Gallery item page UI that are controlled by the publisher.
Each item indicates if it may be controlled by the module or script manifest.

| UI Element | Description | Module | Script |
| --- | --- | --- | --- |
| **Title** | This is the name of the item that is published to the Gallery | No | No |
| **Version** | The version displayed is the version string in the metadata, and a prerelease if is specified. The primary portion of the version in a Module manifest is the ModuleVersion. For a script, it is identified as .VERSION. If a prerelease version string is specified, it will be appended to the ModuleVersion for modules, or specified as part of .VERSION for scripts. There is documentation for specifying prerelease strings in [modules](https://docs.microsoft.com/en-us/powershell/gallery/psget/module/prereleasemodule), and in [scripts](https://docs.microsoft.com/en-us/powershell/gallery/psget/script/prereleasescript) | Yes | Yes |
| **Description** | This is the Description in the module manifest, and in a script file manifest it is .DESCRIPTION | Yes | Yes |
| **Require license acceptance** | A module can require that the user accept a license, by modifying the module manifest with RequireLicenseAcceptance = $true, supplying a LicenseURI, and providing a license.txt file in the root of the module folder. Additional information is available in the [Require License Acceptance](https://docs.microsoft.com/en-us/powershell/gallery/psgallery/psgallery_requires_license_acceptance) topic. | Yes | No |
| **Release notes** | For modules, this information is drawn from the ReleaseNotes section, under PSData\PrivateData. In script manifests, it is the .RELEASENOTES element. | Yes | Yes |
| **Owners** | Owners are the list of users in the PowerShell Gallery who can update an item. The owner list is not included in the item manifest. Additional documentation describes how to [manage item owners](https://docs.microsoft.com/en-us/powershell/gallery/psgallery/managing-item-owners). | No | No |
| **Author** | This is included in the module manifest as the Author, and in a script manifest as .AUTHOR. The Author field is often used to specify a company or organization associated with an item. | Yes | Yes |
| **Copyright** | This is the Copyright field in the module manifest, and .COPYRIGHT in a script manifest. | Yes | Yes |
| **FileList** | The file list is drawn from the package when it is published to the PowerShell Gallery. It is not controllable by the manifest information. Note: there is an additional .nuspec file listed with each item in the PowerShell Gallery that is not present after installing the item on a system. This is the Nuget package manifest for the item, and may be ignored. | No | No |
| **Tags** | For modules, Tags are included under PSData\PrivateData. For scripts, the section is labelled .TAGS. Note that tags cannot contain spaces, even when they are in quotes. Tags have additional requirements and meanings, which are described later in this topic in the Tag Details section. | Yes | Yes |
| **Cmdlets** | This is provided in the module manifest using CmdletsToExport. Note that the best practice is to explicitly list the items, rather than using the wildcard “*”, as that will improve the load-module performance for users. | Yes | No |
| **Functions** | This is provided in the module manifest using FunctionsToExport. Note that the best practice is to explicitly list the items, rather than using the wildcard “*”, as that will improve the load-module performance for users. | Yes | No |
| **DSC Resources** | For modules that will be used on PowerShell version 5.0 and above, this is provided in the manifest using DscResourcesToExport. If the module is to be used in PowerShell 4, the DSCResourcesToExport should not be used as it is not a supported manifest key. (DSC was not available prior to PowerShell 4.) | Yes | No |
| **Workflows** | Workflows are published to the PowerShell Gallery as scripts, and identified as workflows (see [Connect-AzureVM](https://www.powershellgallery.com/packages/Connect-AzureVM/1.0/Content/Connect-AzureVM.ps1) for an example) in the code. This is not controlled by the manifest. | No | No |
| **Role capabilities** | This will be listed when the module published to the PowerShell Gallery contains one or more role capability (.psrc) files, which are used by JEA. See the JEA documentation for more details on [role capabilities](https://docs.microsoft.com/en-us/powershell/jea/role-capabilities). | Yes | No |
| **PowerShell Editions** | This is specified in a script or module manifest. For modules designed to be used with PowerShell 5.0 and below, this is controlled using Tags. For Desktop, use the tag PSEdition_Desktop, and for core, use the tag PSEdition_Core. For modules that will be used only on PowerShell 5.1 and above, there is a CompatiblePSEditions key in the main manifest. For additional detail, review the PS Edition feature in [the PowerShell Get documentation](https://docs.microsoft.com/en-us/powershell/gallery/psget/module/modulewithpseditionsupport). | Yes | Yes |
| **Dependencies** | Dependencies are the modules in the PowerShell Gallery that are declared in either the module as RequiredModules, or in the script manifest as #Requires –Module (name). | Yes | Yes |
| **Minimum Powershell version** | This can be specified in a module manifest as PowerShellVersion | Yes | No |
| **Version History** | The version history reflects the updates made to a module in the PowerShell Gallery. If a version of an item is hidden using the Delete feature, it will not be displayed in the version history, except to the item owners. | No | No |
| **Project Site** | The project site is provided for modules in the Privatedata\PSData section of the module manifest by specifying a ProjectURI. In the script manifest, it is controlled by specifying .PROJECTURI. | Yes | Yes |
| **License** | A license link is provided for modules in the Privatedata\PSData section of the module manifest by specifying a LicenseURI. In the script manifest, it is controlled by specifying .LICENSEURI. It is important to note that if a license is not provided via the LicenseURI, or within a module, then the terms of use for the PowerShell Gallery specify the terms of use for the item. See the terms of use for details. | Yes | Yes |

## Editing item details

The PowerShell Gallery Edit item page allows publishers to change several of the fields displayed for an item, specifically:

* Title
* Description
* Summary
* Icon URL
* Project home page URL
* Authors
* Copyright
* Tags
* Release notes
* Require license

This approach is not generally recommended, except when needed to correct what is displayed for an older version of a module.
Users who acquire the module will see the metadata does not match what is displayed in the PowerShell Gallery, which raises concerns about the item.
This will frequently result in inquiries going to to the item owners to confirm the change.
It is strongly recommended that any time this approach is used, a new version of the item should be published with the same changes.

## Tag Details

Tags are simple strings consumers use to find items.
Tags are most valuable when they are used consistently across many items related to the same topic. Using multiple flavors of the same word (for example database and databases, or test and testing) typically provides little benefit.
Tags are single-word case-insensitive strings and cannot include blanks. If there is a phrase you believe users will search for, add that to the item description and it will be found in the search results. Use Pascal casing, hyphen, underscore, or period if you are trying to improve readability. Be cautious about creating long, complex, and unusual tags, as they are often misspelled.

There are tags that are important to note, as the PowerShell Gallery and PowerShellGet cmdlets treat them uniquely. PSEdition_Desktop and PSEdition_Core are the specific examples, and are described above.

As noted above, tags provide the most value when they are specific, and used consistently across many items.
As a publisher trying to locate the best tags to use, the easiest approach is to search the PowerShell Gallery for tags you are considering.
Ideally, there will be many items returned, and the item descriptions will align with your use of that key word.

For reference, here are some most commonly used tags as of 12/14/2017.
In some cases, there are similar but perhaps less ideal options listed beside the tag.
It is a best practice to use the Preferred Tag, as that will result in less noise, and better search results for consumers.


| **Preferred tag** | **Alternatives and notes** |
| --- | --- |
| **Azure** | |
| **DSC** | DesiredStateConfiguration is less desirable, it’s too long |
| **ResourceManager** | ARM is used to describe group of processors, and should not be used for Azure Resource Manager | **DSCResourceKit** | |
| **SQL** | |
| **AWS** | |
| **DSCResource** | |
| **Automation** | |
| **REST** | |
| **ActiveDirectory** | AD is not currently used by itself |
| **SQLServer** | |
| **DBA** | |
| **Security** | Defense is less precise |
| **Database** | Databases (plural) is less desirable |
| **DevOps** | |
| **Windows** | |
| **Build** | |
| **Deployment** | Deploy is used somewhat less often |
| **Cloud** | |
| **GIT** | |
| **Test** | Testing is less desirable |
| **VersionControl** | Version is less precise, although used more frequently |
| **Logging** | Preferred use of logging as an action |
| **Log** | Preferred use of Log as a thing |
| **Backup** | |
| **IaaS** | |
| **Linux** | |
| **IIS** | |
| **AzureAutomation** | |
| **Storage** | |
| **GitHub** | |
| **Json** | |
| **Exchange** | |
| **Network** | Networking is similar, less often used |
| **SharePoint** | |
| **Reporting** | Reporting is an action, report is a thing |
| **Report** | Report is a thing |
| **WinRM** | |
| **Monitoring** | |
| **VSTS** | |
| **Excel** | |
| **Google** | |
| **Color** | |
| **DNS** | |
| **Office365** | Spelling out Office is preferable. O365 is less commonly used, although shorter | **Gitlab** | |
| **Pester** | |
| **AzureAD** | |
| **HTML** | |
| **Hyper-V** | HyperV is less common as a tag |
| **Configuration** | |
| **ChatOps** | |
| **PackageManagement** | |
| **WMI** | |
| **Firewall** | |
| **Docker** | |
| **Appveyor** | |
| **AzureRm** | Used primarily for the AzureRM modules |
| **Zip** | |
| **MSI** | |
| **Mac** | |
| **PoshBot** | |


Original file line number Diff line number Diff line change
@@ -441,7 +441,7 @@ This method works only for classes that have a null constructor, that is, a
constructor that has no parameters. The object properties must be public and
settable.

For more information, see [about_Object_Creation(about_Object_Creation.md)].
For more information, see [about_Object_Creation](about_Object_Creation.md).

### ConvertFrom-StringData

Original file line number Diff line number Diff line change
@@ -29,7 +29,6 @@ functions, cmdlets, or snap-ins.
#Requires -PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
#Requires -Modules { <Module-Name> | <Hashtable> }
#Requires -ShellId <ShellId>
#Requires -RunAsAdministrator
```

### RULES FOR USE
@@ -40,7 +39,7 @@ functions, cmdlets, or snap-ins.

### PARAMETERS

-Version <N>[.<n>]
-Version \<N\>[.\<n\>]

Specifies the minimum version of Windows PowerShell that the script requires.
Enter a major version number and optional minor version number.
@@ -51,7 +50,7 @@ For example:
#Requires -Version 3.0
```

-PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
-PSSnapin \<PSSnapin-Name\> [-Version \<N\>[.\<n\>]]

Specifies a Windows PowerShell snap-in that the script requires. Enter the
snap-in name and an optional version number.
@@ -62,7 +61,7 @@ For example:
#Requires -PSSnapin DiskSnapin -Version 1.2
```

-Modules <Module-Name> &#124; <Hashtable>
-Modules \<Module-Name\> &#124; \<Hashtable\>

Specifies Windows PowerShell modules that the script requires. Enter the
module name and an optional version number. The Modules parameter is
Loading