Merge pull request #1592 from PowerShell/jianyunt/docs

fixed the broken links and other minor updates due to the recent learning-powershell path changes.

.github/CONTRIBUTING.md

@@ -75,14 +75,14 @@ a user simply creates a pull request in order to "request" that the changes be t
 Additional references:
 * GitHub's guide on [forking](https://guides.github.com/activities/forking/)
 * GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request)
-* GitHub's guide on [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/) 
+* GitHub's guide on [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)
 
 
 ### Lifecycle of a pull request
 
 #### Pull request submission
 
-**Always create a pull request to the `master` branch of this repository**. 
+**Always create a pull request to the `master` branch of this repository**.
 
 ![Github-PR-dev.png](Images/Github-PR-dev.png)
 
@@ -108,13 +108,13 @@ Additional references:
     ```
     Unreleased
     ----------
-    
+
     * `Update-Item` now supports `-FriendlyName`.
     ```
     Please use the present tense and imperative mood when describing your changes:
-    
+
       * Instead of "Adding support for Windows Server 2012 R2", write "Add support for Windows Server 2012 R2".
-    
+
       * Instead of "Fixed for server connection issue", write "Fix server connection issue".
 
     This form is akin to giving commands to the code base,
@@ -122,12 +122,12 @@ Additional references:
     It is also used in the [Git commit messages](#common-engineering-practices).
 
     Also, if change is related to a specific resource, please prefix the description with the resource name:
-    
+
       * Instead of "New,parameter 'ConnectionCredential' in New-SqlConnection",
         write "New-SqlConnection: added parameter 'ConnectionCredential'".
 
 #### Pull Request - Automatic Checks
-    
+
 * If this is your first contribution to PowerShell,
   you may be asked to sign a [Contribution Licensing Agreement][CLA] (CLA)
   before your changes will be accepted.
@@ -139,7 +139,7 @@ Additional references:
   our [CI system (Travis CI and AppVeyor)][ci-system]
   will run a suite of tests and automatically update the status of the pull request.
 
-#### Pull Request / Code Review
+#### Pull Request - Code Review
 
 * After a successful test pass,
   the area maintainers will do a code review,
@@ -179,7 +179,7 @@ please follow the [PowerShell Request for Comments (RFC)](https://github.com/Pow
 Common Engineering Practices
 ----------------------------
 
-Other than the guidelines for ([coding](../docs/coding-guidelines/coding-guidelines.md), 
+Other than the guidelines for ([coding](../docs/dev-process/coding-guidelines.md),
 the [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design,
 [documentation](#contributing-to-documentation) and [testing](../docs/testing-guidelines/testing-guidelines.md)) discussed above,
 we encourage contributors to follow these common engineering practices:
@@ -263,8 +263,8 @@ This a one-time requirement for the PowerShell project.
 Signing the CLA process is simple and can be done in less than a minute.
 You don't have to do this up-front.
 You can simply clone, fork, and submit your pull request as usual.
-When your pull request is created, it is classified by a CLA bot. 
-If the change is trivial, it's classified as `cla-required`. 
+When your pull request is created, it is classified by a CLA bot.
+If the change is trivial, it's classified as `cla-required`.
 Once you sign a CLA, all your existing and future pull requests will be labeled as `cla-signed`.
 
 [testing-guidelines]: ../docs/testing-guidelines/testing-guidelines.md

docs/dev-process/issue-label-descriptions.md

@@ -1,10 +1,3 @@
-author:  Jason/Andy
-
-
-> meaning of label, assignees, etc.
-> triage process
-> requirements for resolving (timing), closing... 
-
 ## Long-living issue labels
 
 ### Feature areas
@@ -21,7 +14,7 @@ These labels describe what feature area of PowerShell that an issue addresses.
 * `Area-Language`: parser, language semantics
 * `Area-OMI`: omi
 * `Area-PackageManagement`: PackageManagement related issues
-* `Area-Performance`: a performance issue 
+* `Area-Performance`: a performance issue
 * `Area-Portability`: anything affecting script portability
 * `Area-PSReadline`: PSReadLine
 * `Area-SideBySide`: Side by side support

docs/learning-powershell/README.md

@@ -52,11 +52,6 @@ Click on the following link to create your first PowerShell script.
 
 - [Using Visual Studio Code (VS Code)][use-vscode-editor]
 
-On Windows, you can also use [PowerShell Integrated Scripting Environment (ISE)][use-ise-editor] to edit PowerShell scripts.
-
-[use-vscode-editor]:./using-vscode.md#editing-with-vs-code
-[use-ise-editor]:./using-ise.md#editing-with-ise
-
 PowerShell Debugger
 ----
 
@@ -66,11 +61,16 @@ Click on the link below to learn more about debugging:
 - [Using Visual Studio Code (VS Code)][use-vscode-debugger]
 - [PowerShell Command-line Debugging][cli-debugging]
 
-On Windows, you can also use  [ISE][use-ise-debugger] to debug PowerShell scripts.
+On Windows, you can also use [PowerShell Integrated Scripting Environment (ISE)][use-ise-editor] to edit or debug PowerShell scripts.
+However it is not supported if you are using PowerShell installed from the [PowerShell package][get-powershell] or directly [built][build-powershell] from GitHub.
 
+[use-vscode-editor]:./using-vscode.md#editing-with-vs-code
+[use-ise-editor]:./using-ise.md#editing-with-ise
 [use-vscode-debugger]:./using-vscode.md#debugging-with-vs-code
 [use-ise-debugger]:./using-ise.md#debugging-with-ise
 [cli-debugging]:./debugging-from-commandline.md
+[get-powershell]:../../README.md#get-powershell
+[build-powershell]:../../README.md#building-the-repository
 
 
 PowerShell Testing

docs/learning-powershell/debugging-from-commandline.md

@@ -23,7 +23,7 @@ Write-Host "$result Celsius"
 
  **1. Setting a Breakpoint on a Line**
 
-- Open a [PowerShell editor](learning-powershell.md#powershell-editor)
+- Open a [PowerShell editor](README.md#powershell-editor)
 - Save the above code snippet to a file. For example, "test.ps1"
 - Go to your command-line PowerShell
 - Clear existing breakpoints if any
@@ -54,7 +54,7 @@ At /home/jen/debug/test.ps1:5 char:1
 [DBG]: PS /home/jen/debug>>
 ```
 
-- The PowerShell prompt now has the prefix **[DBG]:** as you may noticed. This means
+- The PowerShell prompt now has the prefix **[DBG]:** as you may have noticed. This means
  we have entered into the debug mode. To watch the variables like $celsius, simply type **$celsius** as below.
 - To exit from the debugging, type **q**
 - To get help for the debugging commands, simply type **?**. The following is an example of debugging output.

docs/learning-powershell/powershell-beginners-guide.md

@@ -7,7 +7,7 @@ We recommend that you open a PowerShell console/session and type along with the
 
 Launch PowerShell Console/Session
 ---
-First you need to launch a PowerShell session by following the [Installing PowerShell Guide](./learning-powershell.md#installing-powershell).
+First you need to launch a PowerShell session by following the [Installing PowerShell Guide](./README.md#installing-powershell).
 
 
 Getting Familiar with PowerShell Commands
@@ -20,7 +20,7 @@ In this section, you will learn how to
 - find syntax of PowerShell cmdlets
 - and more
 
-As mentioned above, PowerShell commands are designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc. 
+As mentioned above, PowerShell commands are designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc.
 Let’s exercise some of the basic PowerShell commands, also known as **cmdlets**.
 
 Please note that we will use the PowerShell prompt sign **PS />** as it appears on Linux in the following examples.
@@ -213,7 +213,7 @@ PS /> Get-Help -Name Get-Process
 
 It displays the examples how to use the Get-Process cmdlet.
 ```PowerShell
-PS />**Get-Help -Name Get-Process -Examples**
+PS />Get-Help -Name Get-Process -Examples
 ```
 
 If you use **-Full** parameter, for example, `Get-Help -Name Get-Process -Full`, it will display more technical information.

docs/learning-powershell/using-ise.md

@@ -1,6 +1,7 @@
 Using PowerShell Integrated Scripting Environment (ISE)
 ====
 The PowerShell ISE only works on Windows. If you are not using Windows, please see [Using Visual Studio Code](./using-vscode.md).
+Please note the ISE is not supported if you are using PowerShell installed from the [PowerShell package][get-powershell] or directly [built][build-powershell] from GitHub.
 
 Editing with ISE
 ---
@@ -72,3 +73,5 @@ PS C:\test>
 See [How to Debug in ISE][debug] for more information.
 
 [debug]:https://msdn.microsoft.com/en-us/powershell/scripting/core-powershell/ise/how-to-debug-scripts-in-windows-powershell-ise#bkmk_2
+[get-powershell]:../../README.md#get-powershell
+[build-powershell]:../../README.md#building-the-repository

docs/learning-powershell/using-vscode.md

@@ -1,14 +1,14 @@
 Using Visual Studio Code (VS Code)
 ====
 
-If you are working on Linux and OS X, you cannot use ISE because it is not supported on these platforms. 
-In this case, you can choose your favorite editor to write PowerShell scripts. 
+If you are working on Linux and OS X, you cannot use ISE because it is not supported on these platforms.
+In this case, you can choose your favorite editor to write PowerShell scripts.
 Here we choose VS Code as a PowerShell editor as an example.
 
 You can use VS Code on Windows with PowerShell V5 by using Windows 10 or by installing [Windows Management Framework 5.0 RTM](https://www.microsoft.com/en-us/download/details.aspx?id=50395) for down-level Windows OSs (e.g. Windows 8.1, etc.).
 
-Before starting it, please make sure PowerShell exists on your system. 
-By following the [Installing PowerShell](./learning-powershell.md#installing-powershell) instructions you can install PowerShell and launch a PowerShell session.
+Before starting it, please make sure PowerShell exists on your system.
+By following the [Installing PowerShell](./README.md#installing-powershell) instructions you can install PowerShell and launch a PowerShell session.
 
 Editing with VS Code
 ----
@@ -38,31 +38,31 @@ Editing with VS Code
 
 -	After the install, you will see the **Install** button turns to **Enable**.
 -	Click on **Enable** and **OK**
--	Now you are ready for editing. 
-For example, to create a new file, click **File->New**. 
-To save it, click **File->Save** and then provide a file name, let's say "helloworld.ps1". 
-To close the file, click on "x" next to the file name. 
+-	Now you are ready for editing.
+For example, to create a new file, click **File->New**.
+To save it, click **File->Save** and then provide a file name, let's say "helloworld.ps1".
+To close the file, click on "x" next to the file name.
 To exit VS Code, **File->Exit**.
 
 
 Debugging with VS Code
 ----
 
--	Open a file folder (**File->Open Folder**) that contains the PowerShell modules or scripts you have written already and want to debug. 
-In this example, we saved the helloworld.ps1 under a directory called "demo". 
+-	Open a file folder (**File->Open Folder**) that contains the PowerShell modules or scripts you have written already and want to debug.
+In this example, we saved the helloworld.ps1 under a directory called "demo".
 Thus we select the "demo" folder and open it in VS Code.
 
 -	Creating the Debug Configuration (launch.json)
 
-  Because some information regarding your scripts is needed for debugger to start executing your script, we need to set up the debug config first. 
-  This is one-time process to debug PowerShell scripts under your current folder. 
+  Because some information regarding your scripts is needed for debugger to start executing your script, we need to set up the debug config first.
+  This is one-time process to debug PowerShell scripts under your current folder.
   In our case, the "demo" folder.
 
   * Click on the **Debug** icon (or **Ctrl+Shift+D**)
-  * Click on the **Settings** icon that looks like a gear. 
-  VS Code will prompt you to **Select Environment**. 
-Choose **PowerShell**. 
-Then VS code will auto create a debug configuration settings file in the same folder. 
+  * Click on the **Settings** icon that looks like a gear.
+  VS Code will prompt you to **Select Environment**.
+Choose **PowerShell**.
+Then VS code will auto create a debug configuration settings file in the same folder.
 It looks like the following:
 ```json
 {
@@ -89,7 +89,7 @@ It looks like the following:
 ```
 -	Once the debug configuration is established, go to your helloworld.ps1 and set a breakpoint by pressing **F9** on a line you wish to debug.
 -	To disable the breakpoint, press **F9** again.
--	Press **F5** to run the script. 
+-	Press **F5** to run the script.
 The execution should stop on the line you put the breakpoint on.
 - Press **F5** to continue running the script.
 
@@ -109,4 +109,4 @@ There are a few blogs that may be helpful to get you started using PowerShell ex
 PowerShell Extension for VS Code
 ----
 
-PowerShell extension source code can be found [GitHub](https://github.com/PowerShell/vscode-powershell-ops)
+PowerShell extension source code can be found [GitHub](https://github.com/PowerShell/vscode-powershell-ops).