Skip to content

Merge latest staging to live #2029

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 186 commits into from
Jan 10, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
186 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)
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
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
93 changes: 84 additions & 9 deletions contributing/STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,19 +111,94 @@ to get this output:

## Links

* Avoid using bare URLs. Links should use MarkDown syntax `[friendlyname](url)`
* Links should have a a friendly name when applicable, most likely the title of the linked page
* **Exception**: Links to non-Microsoft sites can be bare URLs
* Avoid using bare URLs. Links should use MarkDown syntax `[friendlyname](url-or-path)`
* **Exception**: Links to non-Microsoft sites can be bare URLs for transparency
* Links must have a friendly name, usually the title of the linked topic
* All items in the "related links" section at the bottom should be hyperlinked.
* Use relative links when linking to other content that is hosted on **docs.microsoft.com**.

## Using relative links
### Structure of links on docs.microsoft.com

Content presented on docs.microsoft.com has the following URL structure:

```
https://docs.microsoft.com/<locale>/<product-service>/[<feature-service>]/[<subfolder>]/<topic>[?view=<view-name>]
```

Examples:

```
https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-overview
https://docs.microsoft.com/en-us/powershell/azure/overview?view=azurermps-5.1.1
```

- **\<locale>** - identifies the language of the article (example: en-us or de-de)
- **\<product-service>** - the name of the product or service being documented (example: powerShell, dotnet, or azure)
- **[\<feature-service>]** - (optional) the name of the product's feature or subservice (for example, csharp or load-balancer)
- **[\<subfolder>]** - (optional) the name of a subfolder within a feature
- \<topic> - the name of the article file for the topic (example: load-balancer-overview or overview)
- **[?view=\<view-name>]** - (optional) the view name used by the version selector for content that has multiple versions available (example: azurermps-5.1.1)

### Linking to content in the same repo

You should use relative links when linking to other content that is hosted on **docs.microsoft.com**.
When the content is in the same repo, the relative links are simple to calculate.
Note that the path to cmdlet reference is created by our publishing system.
There are special rules for linking to reference topics from conceptual topics.
The link target must be the path to the _Markdown file_ in the repo.
For example, the following markdown links to the about_Arrays topic in this repo.

```Markdown
[about_Arrays](../reference/5.1/Microsoft.PowerShell.Core/About/about_Arrays.md)
```

Here is the live link:

[about_Arrays](../reference/5.1/Microsoft.PowerShell.Core/About/about_Arrays.md)

Note that the live link works within the GitHub view of this content.

### Linking to content in a different repo

When the content is in a different repo, the relative links are more complicated.
The link target must be the URL path to the _published article_ on **docs.microsoft.com**.
The relative link starts with the **\<product-service>** portion of the URL as described above.
You should omit the **[?view=\<view-name>]** portion unless you need to link to a specific version of the content.

For example, the following markdown links to the Overview topic for Azure PowerShell.

```Markdown
[Overview of Azure PowerShell](/powershell/azure/overview)
```

Here is the live link:

[Overview of Azure PowerShell](/powershell/azure/overview)

Note that the live link does not resolve within the GitHub view of this content.
This link only works on the webpage published to **docs.microsoft.com**.

## Markdown extensions supported by Open Publishing
The following sections describe supported extensions in Open Publishing.

### Note, warning, tip, important
Use specific syntax inside a block quote to indicate that the content is a type of note.

```Markdown
> [!NOTE]
> This is a note.

> [!WARNING]
> This is a warning.

> [!TIP]
> This is a tip.

> [!IMPORTANT]
> This is important.

```

And it will be rendered like this:

\[TO DO\] - document special rules
![alert boxes](./images/alert-boxes.png)

## Next steps

Expand All @@ -137,4 +212,4 @@ See [Formatting code blocks](FORMATTING-CODE.md).
[links]: https://help.github.com/articles/relative-links-in-readmes/
[gfm-spec]: https://github.github.com/gfm/
[semantics]: http://rhodesmill.org/brandon/2012/one-sentence-per-line/
[platyPS]: https://github.com/PowerShell/platyPS
[platyPS]: https://github.com/PowerShell/platyPS
16 changes: 12 additions & 4 deletions contributing/WRITING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Writing PowerShell documentation

One of the easiest ways to contribute to PowerShell is by helping to write and edit documentation.
All of our documentation hosted on GitHub is written using GitHub Flavored Markdown (GFM).
All of our documentation hosted on GitHub is written using *Markdown*.
Markdown is a lightweight markup language with plain text formatting syntax.
Markdown forms the basis of our documentation's conceptual authoring language.
Creating new articles is as easy as writing a simple text file by using your favorite text editor.

## Markdown editors

Expand All @@ -12,16 +15,20 @@ Here are some Markdown editors you can try out:
* [Atom](https://atom.io/)
* [Sublime Text](http://www.sublimetext.com/)

## Using GitHub Flavored Markdown
## Get started using Markdown

To get started using GFM, see GitHub's Help topics for [Writing on GitHub][gfm-help].
To get started using Markdown, see GitHub's Help topics for [Writing on GitHub][gfm-help].

**NOTE:** GitHub recently adopted the CommonMark specification (with GFM extensions) for its Markdown syntax.
In the new specification, many spacing rules have changed.
Spaces are significant in GFM.
Do not use hard tabs in Markdown.
For more detailed information about the Markdown specification, see the [GitHub Flavored Markdown Spec][gfm-spec].

DocFX, used by OPS, supports DocFX Flavored Markdown (DFM).
DFM is highly compatible with GitHub Flavored Markdown (GFM) and adds some functionality, including cross-reference and file inclusion.
There are [differences between DFM and GFM][dfm-diffs] that can affect content preview in GitHub or your editor.

## Creating new topics

If you want to contribute new documentation, first check for [issues tagged as "in progress"][labels]
Expand Down Expand Up @@ -53,4 +60,5 @@ Read the [Style Guide](STYLE.md).
[gfm-help]: https://help.github.com/categories/writing-on-github/
[gfm-spec]: https://github.github.com/gfm/
[labels]: https://github.com/PowerShell/PowerShell-Docs/labels/in%20progress
[gfm-task]: https://github.github.com/gfm/#task-list-items-extension-
[gfm-task]: https://github.github.com/gfm/#task-list-items-extension-
[dfm-diffs]: http://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html#differences-between-dfm-and-gfm
Binary file added contributing/images/alert-boxes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ function Get-SmallFiles {
```

For more information about the PSDefaultValue attribute class, see
[PSDefaultValue Attribute Members](http://msdn.microsoft.com/library/windows/desktop/system.management.automation.psdefaultvalueattribute_members(v=vs.85).asp) on MSDN.
[PSDefaultValue Attribute Members](https://msdn.microsoft.com/library/system.management.automation.psdefaultvalueattribute_members(v=vs.85).aspx) on MSDN.


### Positional Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ function Get-SmallFiles {
```

For more information about the PSDefaultValue attribute class, see
[PSDefaultValue Attribute Members](http://msdn.microsoft.com/library/windows/desktop/system.management.automation.psdefaultvalueattribute_members(v=vs.85).asp) on MSDN.
[PSDefaultValue Attribute Members](https://msdn.microsoft.com/library/system.management.automation.psdefaultvalueattribute_members(v=vs.85).aspx) on MSDN.


### Positional Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ function Get-SmallFiles {
```

For more information about the PSDefaultValue attribute class, see
[PSDefaultValue Attribute Members](http://msdn.microsoft.com/library/windows/desktop/system.management.automation.psdefaultvalueattribute_members(v=vs.85).asp) on MSDN.
[PSDefaultValue Attribute Members](https://msdn.microsoft.com/library/system.management.automation.psdefaultvalueattribute_members(v=vs.85).aspx) on MSDN.


### Positional Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ function Get-SmallFiles {
```

For more information about the PSDefaultValue attribute class, see
[PSDefaultValue Attribute Members](http://msdn.microsoft.com/library/windows/desktop/system.management.automation.psdefaultvalueattribute_members(v=vs.85).asp) on MSDN.
[PSDefaultValue Attribute Members](https://msdn.microsoft.com/library/system.management.automation.psdefaultvalueattribute_members(v=vs.85).aspx) on MSDN.


### Positional Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ function Get-SmallFiles {
```

For more information about the PSDefaultValue attribute class, see
[PSDefaultValue Attribute Members](http://msdn.microsoft.com/library/windows/desktop/system.management.automation.psdefaultvalueattribute_members(v=vs.85).asp) on MSDN.
[PSDefaultValue Attribute Members](https://msdn.microsoft.com/library/system.management.automation.psdefaultvalueattribute_members(v=vs.85).aspx) on MSDN.


### Positional Parameters
Expand Down
2 changes: 0 additions & 2 deletions reference/6/Microsoft.PowerShell.Management/Set-Content.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,8 +402,6 @@ Otherwise, this cmdlet does not generate any output.

## NOTES

You can also refer to Set-Content by its built-in alias, "sc". For more information, see [about_Aliases](../Microsoft.PowerShell.Core/About/about_Aliases.md).

Set-Content is designed for string processing.
If you pipe non-string objects to Set-Content, it converts the object to a string before writing it.
To write objects to files, use Out-File.
Expand Down
154 changes: 154 additions & 0 deletions reference/6/Microsoft.PowerShell.Utility/ConvertFrom-Clixml.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
ms.date: 2017-06-09
schema: 2.0.0
locale: en-us
keywords: powershell,cmdlet
online version:
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
title: ConvertFrom-Clixml
---

# ConvertFrom-Clixml

## SYNOPSIS
Converts an CLIXML string into new corresponding object in Windows PowerShell.

## SYNTAX

```
ConvertFrom-Clixml -InputObject <string> [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
```

## DESCRIPTION
The **ConvertFrom-CliXml** cmdlet converts a CLIXML string with data that represents Microsoft .NET Framework objects and creates the objects in Windows PowerShell.

A valuable use of **ConvertFrom-CliXml** is to deserialize credentials and secure strings that have been serialized as secure XML by running the ConvertTo-Clixml cmdlet.
For an example of how to do this, see Example 2.

## EXAMPLES

### Example 1: Import a serialized file and recreate an object

```powershell
$clixml = Get-Process | ConvertTo-Clixml
$Processes = ConvertFrom-Clixml $clixml
```

This command uses the ConvertTo-Clixml cmdlet to create a serialized copy of the process information returned by Get-Process.
It then uses **ConvertFrom-Clixml** to retrieve the contents of the serialized string and re-create an object that is stored in the $Processes variable.

### Example 2: Convert an encrypted credential object

```powershell
$CredXml = $Credential | ConvertTo-Clixml
$Credential = ConvertFrom-CliXml $CredXml
```

The **ConvertTo-CliXml** cmdlet encrypts credential objects by using the
[Windows Data Protection API](http://msdn.microsoft.com/library/windows/apps/xaml/hh464970.aspx).
This ensures that only your user account can decrypt the contents of the credential object.

In this example, given a credential that you've stored in the $Credential variable by running the Get-Credential cmdlet, you can run the **ConvertTo-CliXml** cmdlet to serialize the credential to a string.

To deserialize the credential later, run the second command.
This time, you are running ConvertFrom-Clixml to import the secured credential object into your script.
This eliminates the risk of exposing plain-text passwords in your script.

## PARAMETERS

### -InputObject
Specifies the CLIXML string to be converted to objects.
You can also pipe the CLIXML string to **ConvertFrom-Clixml**.

```yaml
Type: string
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```

### -First
Gets only the specified number of objects.
Enter the number of objects to get.

```yaml
Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -Skip
Ignores the specified number of objects and then gets the remaining objects.
Enter the number of objects to skip.

```yaml
Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -IncludeTotalCount
Reports the total number of objects in the data set (an integer) followed by the selected objects.
If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value.
The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](../../Microsoft.PowerShell.Core/About/about_CommonParameters.md).

## INPUTS

### System.String
You can pipe a string that contains a path to **ConvertFrom-Clixml**.

## OUTPUTS

### PSObject
**ConvertFrom-Clixml** returns objects that have been deserialized from the stored XML files.

## NOTES
* When specifying multiple values for a parameter, use commas to separate the values. For example, "\<parameter-name\> \<value1\>, \<value2\>".

*

## RELATED LINKS

[Use PowerShell to Pass Credentials to Legacy Systems](http://blogs.technet.com/b/heyscriptingguy/archive/2011/06/05/use-powershell-to-pass-credentials-to-legacy-systems.aspx)

[Securely Store Credentials on Disk](http://powershellcookbook.com/recipe/PukO/securely-store-credentials-on-disk)

[Export-Clixml](Export-Clixml.md)

[Import-Clixml](Import-Clixml.md)

[ConvertTo-Clixml](ConvertTo-Clixml.md)


Loading