Skip to content

Commit

Permalink
Merging TOC fixes to Live (#2031)
Browse files Browse the repository at this point in the history
* Update the example of `Where-Object -IsNot` (#1841)

* Update Example 5 in Group-Object.md (#1845)

* removing @{Text=} tags

* fixing UTF8 characters

* removed empty H3

* added H3 for input and output types

* removed mangled UTF8 character

* updating Out-* commands with -NoNewLine per Issue 1739

* Fix the example of `Format-Table -DisplayError` (#1848)

The example is a `-DisplayError` parameter example. But it uses `-ShowError` parameter.

* Fix the example of `Format-Wide -DisplayError` (#1850)

* Fix the example of `Format-Custom -DisplayError` (#1849)

The example is a -DisplayError parameter example. But it uses -ShowError parameter.

* updating set-acl docs per PR#901

* using semantic link breaks

* Fix the example of `Format-Wide -ShowError` (#1851)

* Fixed Test-ScriptFileInfo example (#1852)

* fixing issue 1768

* Formatting, example fix for Body parameter (#1847)

1. Replaced variable names with PascalCase convention and for consistency
2. Removed directory information [c:\] in the examples
3. Put powershell keyword for formatting examples
4. Replaced Invoke-RestMethod with Invoke-WebRequest in the Body example, added method Post
5. Removed InformationAction and InformationVariable parameters, which were mistakenly a copy of Body, included already in CommonVariables part

* fixing style consistency across articles

* Fix example numbers in Resume-Job.md (#1857)

Example 4 is duplicated.

* Fixes typo $WebSiteName in separatingEnvData.md (#1856)

- Adds the website name to common node property inside configuration data.
- Also, it is now referenced (e.g. $Node.WebSiteName) in the DSC configuration document in MyWebApp.ps1.

* Updates configurations.md (#1855)

Two set of changes made.
- Example scripts e.g. MyDscConfiguration.ps1 define the configuration inside them and call the configuration at the end line. Removed the call to the configuration at the end. Since the article demonstrates dot-sourcing the file and calling the configuration explicitly.
- Fixed typo in the file name (TEST-PC1.mof  to localhost.mof ), since the ComputerName was not specified it should default to using 'localhost' as the default argument for it.

P.S. - There is a comment on the web-page regarding the fixes made

* Fix typo in comment (#1854)

* Updating the help content for v6. (#1853)

* Updating the help content for v6.

* Address code review comments

* Fix broken links

* Fix example numbers in about_Transactions.md (#1859)

Example number '7' is duplicated.

* Update Alias-Provider.md (#1831)

1. Removed statement that an alias is to an executable, the definition cotnains the path. It may - but does not need to be. For example:
Try Set-Alias np Notepad then look at the definition.
2. Clarified that an alias can also be to a powershell script (ps1 file).
3. Tidied up the language removing multiple 'And,' clauses to improve readability.

* Add documentation of new -AsHashtable switch for ConvertFrom-Json introduced by PR #5043 (#1858)

* add documentation of new -AsHashTable switch for ConvertFrom-Json and also document the behaviour in case of duplicate strings.

* correct casing of -AsHashtable switch.

* Address PR comments about -AsHashtable switch for ConvertFrom-Json.md

* Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md

* Revert "Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md"
Accidentally change the wrong field.
This reverts commit 6e76191.

* Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md

* Fix example numbers in Invoke-WebRequest.md (#1862)

Example number '4' is duplicated.

* reformatting and integrating changes from PR#1831 (#1860)

* Fix example numbers in Get-Help.md (#1869)

Example number 12 and 13 are missing.

* Fix example numbers in Import-Module.md (#1868)

Example number '10' is duplicated.

* Fix example number in ConvertTo-Html.html (#1867)

Example number '10' is duplicated.

* Update dscCiCd.md (#1865)

Missing a period on line 378. Should be `$(Build.ArtifactStagingDirectory)\` not `$(BuildArtifactStagingDirectory)\`.

* Web Cmdlets 6.0.0 Documentation Refresh (#1870)

* Web Cmdlets 6.0.0 Documentation Refresh

* Address PR Feedback

* Merge Example 4 and 5 in Get-Member.md (#1874)

Example 4 and 5 in Get-Member.md v3.0 and v4.0 are almost the same. They should be merged as with v5.0.

* Remove hash algorithms unsupported in v6.0 (#1873)

MACTripleDES and RIPEMD160 are no longer supported in v6.0.

* Update outputs of Get-Verb (#1872)

Since v6.0, `Get-Verb` returns  not MemberDefinition but VerbInfo that has Verb and Group properties.

* Fix typo in ConvertTo-Html.md (UTF-x) (#1879)

* Fix "Accept wildcard characters" in Get-Service.md v6 (#1878)

* Fixed "False" -> "True" (`DisplayName`, `Exclude`, `Include`, and `Name`)
* Removed `InformationAction` and `InformationVariable`

* Fixed Get-WindowsFeature cmdlet HyperLink (#1877)

* Fixed Get-WindowsFeature cmdlet HyperLink

Minor edit.  Update Get-WindowsFeature cmdlet HyperLink to https://technet.microsoft.com/library/jj205469(v=wps.630).aspx

* Changed URL to new docs.microsoft.com location

The TechNet URL did not work. TechNet and MSDN are being retired.

* Update Get-WinEvent.md (#1876)

Removed future tense in a couple of places to improve readability. Minor edit.

* Update Example 8 in Get-Process.md (find the owner of a process) (#1875)

* Update Example 8 in Get-Process.md (Find the owner of a process)

* Update to attempt to avoid build errors

It seems that the build system does not accept multiple script blocks per one Example header.

* updated localmachine\Root to LocalMachine\My (#1880)

The example where we import the PFX on the target node should import the cert into Personal store and not root.

* Update Group property example in Get-Verb.md (#1881)

* adding missing space (#1885)

* removing stray character (#1886)

* Update Example 9 in Get-Process.md (#1888)

* powershell -> pwsh (only v6.0)
* Windows PowerShell -> PowerShell

* Remove "About ISE" files of v6.0 (#1891)

* Remove "About ISE" files of v6.0

ISE is no longer bundled with PowerShell 6.0.

* Remove links for "About ISE" files of v6.0

* Update Get-Process.md (#1890)

Fixed name parameter details to show it accepts wildcards in the name

* Update productincompat.md (#1892)

The list of compatible systems should include Skype For Business Server 2015 and Lync Server 2013.

* Update unapproved verbs examples in Get-Verb.md (#1896)

* Updated Example 4
* Removed Example 5

* Removing extra space in the Example 5A script (#1894)

It was highlighting as string in the documentation, I was trying to remove all the extra space.

* fixing merge conflict

* updates to style and contrib

* tweak format

* tweak format 2

* fix typo

* fix number list example

* adding review feedback

* fix broken links

* incorporating feedback from zach

* reformatting About_* for 80 columns - part 1

* reformat about_*

* reformatting About_* topics - Part 2

* fixing broken links

* fixing more broken links

* more broken links fixed

* Fix parameter's position in Get-Random.md (#1901)

* Fix parameter's position in Measure-Command.md (#1905)

* Fix parameter's position in Trace-Command.md (#1904)

* Actually call the configuration in the example (#1906)

On line 74, it says...

"The last line of the example containing only the name of the configuration, calls the configuration."

This change actually makes that call.

* reformatting About_* for 80 columns - part 3 (#1902)

* reformatting About_*

* reformatting About_* part 3

* fixing broken links

* fixing more broken links

* one more time with the links

* reformatting About_* for 80 columns - part 4

* Adding PreRelease versioning info for PSGallery & PSGet (#1903)

* PowerShellGet PreRelease Support

Adding descriptive doc for pre-release versioning support

* Correcting typos in pre-release doc

Minor typos and case issues fixed

* Updated prerelease info based on feedback

Mostly cosmetic updates. Functional change: added line 28, stating we only support 3-segment module versions.

* Adding prerelease to module install update find save commands

* Updating PSGet -Script commands for Prerelease support

* Hyphen listed as optional rather than preferred in Prereleasestring

* Minor corrections from Rebro review

* Addressing @sdwheeler feedback on links and double slashes

* Fixing broken link

* Update PreReleaseScript.md

* Style tweaks in STYLE.md (#1913)

* Fix YAML metadata on "Understanding Concepts" (#1911)

I'm not quite sure what this means, but it certainly looks terrible on docs.microsoft.com when it's malformed.

(To be perfectly honest, I only managed to even figure out it's called "YAML metadata" by peeking at the DOM of github's HTML.)

* Fix parameter's position in Join-Path.md (#1909)

* typo correction on line 85 (#1916)

E:\Windows\Sytem32 sould be E:\Windows\System32

* Fix parameter's position in Get-TraceSource.md (#1917)

* Changed required PSGet version to 1.6.0 (#1920)

* Update Example 5 in Get-Process.md (#1923)

* fixing backlashes reported in PR1921 (#1924)

* fixing backlashes reported in PR1921

* found more backslashes

* reformatting About_* for 80 columns - part 5

* reformatting About_* for 80 columns - part 6

* incorporating review feedback

* reformatting About_* for 80 columns - part 7

* Fixed formatting of output per issue #808

* Fix typo in syntax description (#1931)

* Fix parameter's position in ConvertTo-Xml.md (#1929)

* Remove descriptions about ComputerName parameter in Get-Process.md v6.0 (#1928)

* Line 192  Single Quote Breaks Example (#1930)

* Line 192  Single Quote Breaks Example

* clarified the example for -Regex

* Update Example 2 in Get-Alias.md (ineffective Exclude) (#1935)

`-Exclude Get-*` is ineffective because there are no aliases that begin with `Get-`.

* Fix formatting: DESCRIPTION section in ConvertTo-Xml.md (#1934)

* Fix typo in Unregister-ScheduledJob (#1932)

* Update Unregister-ScheduledJob.md

* Update Unregister-ScheduledJob.md

* Update Unregister-ScheduledJob.md

* Update Unregister-ScheduledJob.md

* Fix parameter's position in ConvertFrom-Csv.md (#1937)

* fix typo on metaConfig.md (#1936)

fixed typo

* Quick edits (#1938)

* Changed required PSGet version to 1.6.0

* Fixes to PSGet TOC and WMF 5.1 compat page

* Update Get-Item.md (#1942)

Proof-read some of the examples. The first two were wrong entirely: The user must be in the ps-test folder for the result shown to happen.

* Add description about Format-Hex -InputObject (#1939)

* Fix parameter's position in Add-Member.md (#1946)

* Fix parameter's position in Select-Object.md (#1945)

* Correcting add to hash table example (#1944)

* Update about_Hash_Tables.md

corrected add to hash table example in 3.0

* Update about_Hash_Tables.md

corrected add to hash table examples in 4.0

* Update about_Hash_Tables.md

corrected add to hash table example in 5.0

* Update about_Hash_Tables.md

corrected add to hash table example in 5.1

* Update about_Hash_Tables.md

corrected add to hash table example in 6

* Fix Set-TraceSource -ListenerOption parameter (#1949)

* Fixed the value of "Accepted values:"
* Fixed minor differences in formatting and wording

* Fix Trace-Command -ListenerOption parameter (#1948)

* Fixed the value of "Accepted values:"
* Fixed minor differences in formatting and wording

* Fix parameter's position in Select-Xml.md (#1953)

* Fix Get-Alias -Name parameter (#1952)

* Position: 0
* Default value: All aliases
* Accept wildcard characters: True
* Fixed minor differences in formatting and wording

And also removed InformationAction/InformationVariable in v6.0.

* Wmf 5.1 cleanup (#1950)

* Changed required PSGet version to 1.6.0

* Fixes to PSGet TOC and WMF 5.1 compat page

* Add note explaining WMF does not ship in Windows

* Typo fix ("you will are not" -> "you will not"). (#1951)

* Typo fix ("you will are not" -> "you will not").

* Changed from passive voice to active voice

* added article about formatting code samples

* fixing typos

* fixed typos and incorporated feedback

* updating metadata tags in docfx.json

* fixing filename spelling

* Fix parameter's position in Get-Content.md (#1959)

* Fix parameter's position in Get-Member.md (#1958)

* Update PSGallery "Items Tab" (for the new prerelease feature) (#1957)

* Fix link for about_WorkflowCommonParameters in New-PSWorkflowExecutionOption.md (#1962)

* Fix link for about_Types.ps1xml in Update-TypeData.md (#1961)

* Fix parameter's position in Group-Object.md (#1966)

* Fix hex values in about_Arithmetic_Operators.md (#1965)

* Indent headers as subheaders (#1967)

* Update minor typo in Limit-EventLog.md (#1968)

* Update Example 3 in Get-FileHash.md (#1969)

* Fix parameter's position in Tee-Object.md (#1970)

* fixing output example per issue 1933

* fix -Path metadata to reflect wildcard support

* fixing issue 1640

* fixing issue 1651

* Fix link for about_Remote_Requirements (#1976)

* Split parameter set in Sort-Object.md v6.0 (#1975)

Since v6.0, Sort-Object cmdlet has two parameter sets, "Default" and "Bottom".

* Fix link for about_Preference_Variables (#1982)

http://... -> relative path

* Fix broken headers in Get-CimSession.md v6.0 (#1981)

* Update Example 1 in Import-Counter.md (#1980)

* move $OFS to prefs article added note about read-only (#1978)

* Update decisionMaker.md (#1984)

Slight, but critical corrections to the definition of DevOps.

* Update configurations.md (#1985)

* Fix parameter's position in Restart-Service.md (#1993)

* Fix link for logical operators in about_Operator_Precedence.md (#1992)

* Update scriptResource.md (#1986)

Match specified GetScript rule

* Bad link (#1988)

The link "http://go.microsoft.com/fwlink/?LinkId=119096" is supposed to point to a page or a document about "Code-Signing Best Practices".
However, it points to a video about "Understanding Extension INFs and Component INFs".
I watched the whole video and there is nothing inside about "Code-Signing Best Practices".
The best match I have found is the following one: http://download.microsoft.com/download/a/f/7/af7777e5-7dcd-4800-8a0a-b18336565f5b/best_practices.doc
It would be a very good idea to make a web page from this document. Pieces of advice it contains are still accurate.

* Update Example 1 of Protect-CmsMessage (#1987)

The existing example did not specify you needed to create the INF. This not only says so but does so using a script block piped to out-file

* Small edits for mispellings (#1989)

* Corrected command (#1990)

The CanPauseAndContinue property is a boolean so the correct comparison to use is $true rather than "True".

* removing module ref for modules that do not ship in v6-rc2 (#1996)

* Fix parameter's position in Resume-Service.md (#1998)

* Fix link for about_Providers (#1999)

* Help doc enhancement for ConvertFrom-StringData cmdlet (#2002)

* Help doc correction

Removed an unwanted * from Notes section

Corrected intenting for last example

Removed unwanted ... from example 2

* Help doc wnhancements in all versions for ConvertFrom-StringData

Removed an unwanted * from Notes section

Corrected intenting for last example

Removed unwanted ... from example 2

* PowerShell 6 logging on Windows, Linux, and MacOS (#1922)

* First draft of PowerShell 6 logging

* Fix style guideline issues.

* Document logging settings in PowerShellProperties.json

* Address PR Feedback
Limit lines to 80 columns, when possible
Insert <br> in selected locations to improve readability of rendered markdown.

* Reformatted tables

Reformatted tables to work with new processing of About_* topics

* Adding calling the ComputerName parameter to the example (#1964)

* Adding calling the ComputerName parameter to the example

* Changing quotes to brackets

* Removed unused variable in Example 1 (#2004)

The variable was declared but not used.  It also appears in the same place in Example 2 but is used later on.

* Made surrounding text agree with sample code. (#2003)

* Reformatting v4 About_ topics missed in first pass (#2006)

* v4 about scrub missed files

* fixing broken links

* fix broken link

* Reformatting v3 About_ topics missed in first pass (#2005)

* v3 about scrub missed files

* fixing broken links

* fix broken link

* Reformatting v5 About_ topics missed in first pass (#2008)

* v5 about scrub missed files

* fixing broken links

* v5.1 about scrub missed files (#2009)

* Reformatting v6 About_ topics missed in first pass (#2010)

* v6 about scrub missed files

* fixing broken links and removing non-v6 content

* final pass on About_ topic reformat (#2011)

* Corrected Example 3 (#2014)

* Corrected Example 3

Example 3 is an example to remove the user from the group but instead it was removing the group completely.  This change adds the correct syntax to perform what was intended.

See #2001

* minor edits for spacing and metadata

* Enable running pandoc on about topic files (#2012)

* Enable running pandoc on about topic files

* Remove extra line

* Removed --ascii parameter from pandoc as it is not required

* Creates output directory as pandoc needs it (#2018)

* remove alias `sc` to match PSCore6 (#2021)

* Cmdlet help for ConvertFrom-Clixml and ConvertTo-Clixml  (#2022)

* Cmdlet help for ConvertFrom-Clixml and ConvertTo-Clixml for Powershell#3898

* minor edits

- Removed -information* common parameters
- reformat code blocks
- renumbered example

* minor updates

- reformatted examples
- removed common paramters

* update link to about topic

* minor edits

- removed common parameters
- formatted code blocks

* minor edits

- reformatted code blocks
- removed common parameters

* fix broken link (#2024)

* Adding more info to Contributor Guide (#2023)

* adding notes about OPS extensions

* added notes about OPS extensions and linking

* fix typo

* fix typo

* Support lifecycle doc (#1994)

* first pass of support lifecycle doc

* add notes on MIT license

* address slee's comments on support lifecycle

* respond to lifecycle feedback from Sean

* add lifecycle image

* Fixed spelling typo

* add lifecycle to TOC

* respond to feedback on lifecycle

* Removed en-us from URLs

You need to remove locale paths from URLs. Including en-us forces the reader to English rather than being redirected to the localized version of the article that matches their locale.

* add note on 12 months, fix en-us

* Fixed typo

* Move setup/install and remoting docs into PowerShell-Docs (#2026)

This creates a couple new topics around WSMan remoting, SSH remoting, and installing/configuring PowerShell Core. It also adds a topic on using VS Code with PowerShell.

* PowerShell Core 6.0 release notes (#2020)

What's New in PowerShell Core 6.0

* update TOC and change title of setup mac/linux article (#2030)

* update TOC and change title of setup mac/linux article

* fix typos
  • Loading branch information
Sean Wheeler authored Jan 10, 2018
1 parent 6aed37d commit 9ba385d
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 14 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Package installation instructions
# Installing PowerShell Core on macOS and Linux

Supports [Ubuntu 14.04][u14], [Ubuntu 16.04][u16], [Ubuntu 17.04][u17], [Debian 8][deb8], [Debian 9][deb9],
[CentOS 7][cos], [Red Hat Enterprise Linux (RHEL) 7][rhel7], [OpenSUSE 42.2][opensuse], [Fedora 25][fed25],
Expand Down
41 changes: 28 additions & 13 deletions reference/docs-conceptual/toc.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- name: Conceptual
- name: Conceptual
href: PowerShell-Scripting.md
items:
- name: Core PowerShell
Expand Down Expand Up @@ -72,8 +72,17 @@
href: core-powershell/ise/windows-powershell-ise-object-model-reference.md
- name: ISE Guide
href: core-powershell/ise-guide.md
- name: Visual Studio Code
items:
- name: Using Visual Studio Code
href: core-powershell/vscode/using-vscode.md
- name: Running Remote Commands
href: core-powershell/running-remote-commands.md
items:
- name: PowerShell Remoting Over SSH
href: core-powershell/SSH-Remoting-in-PowerShell-Core.md
- name: WS-Management (WSMan) Remoting in PowerShell Core
href: core-powershell/WSMan-Remoting-in-PowerShell-Core.md
- name: Web Access
href: core-powershell/web-access.md
items:
Expand Down Expand Up @@ -105,13 +114,13 @@
href: getting-started/cookbooks/changing-computer-state.md
- name: Collecting Information About Computers
href: getting-started/cookbooks/collecting-information-about-computers.md
- name: Creating .NET and COM Objects New Object
- name: Creating .NET and COM Objects New Object
href: getting-started/cookbooks/creating-.net-and-com-objects--new-object-.md
- name: Creating a Custom Input Box
href: getting-started/cookbooks/creating-a-custom-input-box.md
- name: Creating a Graphical Date Picker
href: getting-started/cookbooks/creating-a-graphical-date-picker.md
- name: Getting WMI Objects Get WmiObject
- name: Getting WMI Objects Get WmiObject
href: getting-started/cookbooks/getting-wmi-objects--get-wmiobject-.md
- name: Managing Current Location
href: getting-started/cookbooks/managing-current-location.md
Expand All @@ -131,21 +140,21 @@
href: getting-started/cookbooks/performing-networking-tasks.md
- name: Redirecting Data with Out Cmdlets
href: getting-started/cookbooks/redirecting-data-with-out---cmdlets.md
- name: Removing Objects from the Pipeline Where Object
- name: Removing Objects from the Pipeline Where Object
href: getting-started/cookbooks/removing-objects-from-the-pipeline--where-object-.md
- name: Repeating a Task for Multiple Objects ForEach Object
- name: Repeating a Task for Multiple Objects ForEach Object
href: getting-started/cookbooks/repeating-a-task-for-multiple-objects--foreach-object-.md
- name: Selecting Items from a List Box
href: getting-started/cookbooks/selecting-items-from-a-list-box.md
- name: Selecting Parts of Objects Select Object
- name: Selecting Parts of Objects Select Object
href: getting-started/cookbooks/selecting-parts-of-objects--select-object-.md
- name: Sorting Objects
href: getting-started/cookbooks/sorting-objects.md
- name: Using Format Commands to Change Output View
href: getting-started/cookbooks/using-format-commands-to-change-output-view.md
- name: Using Static Classes and Methods
href: getting-started/cookbooks/using-static-classes-and-methods.md
- name: Viewing Object Structure Get Member
- name: Viewing Object Structure Get Member
href: getting-started/cookbooks/viewing-object-structure--get-member-.md
- name: Working with Files and Folders
href: getting-started/cookbooks/working-with-files-and-folders.md
Expand Down Expand Up @@ -192,7 +201,7 @@
href: getting-started/fundamental/using-windows-powershell-for-administration.md
- name: Windows PowerShell Basics
href: getting-started/fundamental/windows-powershell-basics.md
- name: Windows PowerShell Integrated Scripting Environment ISE
- name: Windows PowerShell Integrated Scripting Environment ISE
href: getting-started/fundamental/windows-powershell-integrated-scripting-environment--ise-.md
- name: Fundamental Concepts
href: getting-started/fundamental-concepts.md
Expand All @@ -207,6 +216,10 @@
- name: Setup
href: ''
items:
- name: Installing PowerShell Core on Windows
href: setup/Installing-PowerShell-Core-on-Windows.md
- name: Installing PowerShell Core on macOS and Linux
href: setup/Installing-PowerShell-Core-on-macOS-and-Linux.md
- name: Accessibility in Windows PowerShell ISE
href: setup/accessibility-in-windows-powershell-ise.md
- name: Installing the Windows PowerShell 2.0 Engine
Expand Down Expand Up @@ -234,12 +247,14 @@
- name: What's New
href: ''
items:
- name: What's New in the PowerShell 50 ISE
href: whats-new/what-s-new-in-the-powershell-50-ise.md
- name: What's New in Windows PowerShell 50
href: whats-new/what-s-new-in-windows-powershell-50.md
- name: What's New With PowerShell
- name: What's new with PowerShell
href: whats-new/what-s-new-with-powershell.md
- name: What's new in Windows PowerShell 5.0
href: whats-new/what-s-new-in-windows-powershell-50.md
- name: What's new in the PowerShell 5.0 ISE
href: whats-new/what-s-new-in-the-powershell-50-ise.md
- name: What's new in PowerShell Core 6.0
href: whats-new/what-s-new-in-powershell-core-60.md
- name: PowerShell Core Support Lifecycle
href: PowerShell-Core-Support.md
- name: Glossary
Expand Down

0 comments on commit 9ba385d

Please sign in to comment.