Skip to content

Commit 1e7a496

Browse files
committed
fixed the broken links and other minor updates due to the recent learning-powershell path changes.
1 parent bc4fe11 commit 1e7a496

7 files changed

Lines changed: 44 additions & 48 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,14 @@ a user simply creates a pull request in order to "request" that the changes be t
7575
Additional references:
7676
* GitHub's guide on [forking](https://guides.github.com/activities/forking/)
7777
* GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request)
78-
* GitHub's guide on [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)
78+
* GitHub's guide on [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/)
7979

8080

8181
### Lifecycle of a pull request
8282

8383
#### Pull request submission
8484

85-
**Always create a pull request to the `master` branch of this repository**.
85+
**Always create a pull request to the `master` branch of this repository**.
8686

8787
![Github-PR-dev.png](Images/Github-PR-dev.png)
8888

@@ -108,26 +108,26 @@ Additional references:
108108
```
109109
Unreleased
110110
----------
111-
111+
112112
* `Update-Item` now supports `-FriendlyName`.
113113
```
114114
Please use the present tense and imperative mood when describing your changes:
115-
115+
116116
* Instead of "Adding support for Windows Server 2012 R2", write "Add support for Windows Server 2012 R2".
117-
117+
118118
* Instead of "Fixed for server connection issue", write "Fix server connection issue".
119119
120120
This form is akin to giving commands to the code base,
121121
and is recommended by the Git SCM developers.
122122
It is also used in the [Git commit messages](#common-engineering-practices).
123123
124124
Also, if change is related to a specific resource, please prefix the description with the resource name:
125-
125+
126126
* Instead of "New,parameter 'ConnectionCredential' in New-SqlConnection",
127127
write "New-SqlConnection: added parameter 'ConnectionCredential'".
128128
129129
#### Pull Request - Automatic Checks
130-
130+
131131
* If this is your first contribution to PowerShell,
132132
you may be asked to sign a [Contribution Licensing Agreement][CLA] (CLA)
133133
before your changes will be accepted.
@@ -139,7 +139,7 @@ Additional references:
139139
our [CI system (Travis CI and AppVeyor)][ci-system]
140140
will run a suite of tests and automatically update the status of the pull request.
141141
142-
#### Pull Request / Code Review
142+
#### Pull Request - Code Review
143143
144144
* After a successful test pass,
145145
the area maintainers will do a code review,
@@ -179,7 +179,7 @@ please follow the [PowerShell Request for Comments (RFC)](https://github.com/Pow
179179
Common Engineering Practices
180180
----------------------------
181181
182-
Other than the guidelines for ([coding](../docs/coding-guidelines/coding-guidelines.md),
182+
Other than the guidelines for ([coding](../docs/coding-guidelines.md),
183183
the [RFC process](https://github.com/PowerShell/PowerShell-RFC) for design,
184184
[documentation](#contributing-to-documentation) and [testing](../docs/testing-guidelines/testing-guidelines.md)) discussed above,
185185
we encourage contributors to follow these common engineering practices:
@@ -263,8 +263,8 @@ This a one-time requirement for the PowerShell project.
263263
Signing the CLA process is simple and can be done in less than a minute.
264264
You don't have to do this up-front.
265265
You can simply clone, fork, and submit your pull request as usual.
266-
When your pull request is created, it is classified by a CLA bot.
267-
If the change is trivial, it's classified as `cla-required`.
266+
When your pull request is created, it is classified by a CLA bot.
267+
If the change is trivial, it's classified as `cla-required`.
268268
Once you sign a CLA, all your existing and future pull requests will be labeled as `cla-signed`.
269269

270270
[testing-guidelines]: ../docs/testing-guidelines/testing-guidelines.md

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
author: Jason/Andy
2-
3-
4-
> meaning of label, assignees, etc.
5-
> triage process
6-
> requirements for resolving (timing), closing...
7-
81
## Long-living issue labels
92

103
### Feature areas
@@ -21,7 +14,7 @@ These labels describe what feature area of PowerShell that an issue addresses.
2114
* `Area-Language`: parser, language semantics
2215
* `Area-OMI`: omi
2316
* `Area-PackageManagement`: PackageManagement related issues
24-
* `Area-Performance`: a performance issue
17+
* `Area-Performance`: a performance issue
2518
* `Area-Portability`: anything affecting script portability
2619
* `Area-PSReadline`: PSReadLine
2720
* `Area-SideBySide`: Side by side support

docs/learning-powershell/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,6 @@ Click on the following link to create your first PowerShell script.
5252

5353
- [Using Visual Studio Code (VS Code)][use-vscode-editor]
5454

55-
On Windows, you can also use [PowerShell Integrated Scripting Environment (ISE)][use-ise-editor] to edit PowerShell scripts.
56-
57-
[use-vscode-editor]:./using-vscode.md#editing-with-vs-code
58-
[use-ise-editor]:./using-ise.md#editing-with-ise
59-
6055
PowerShell Debugger
6156
----
6257

@@ -66,11 +61,16 @@ Click on the link below to learn more about debugging:
6661
- [Using Visual Studio Code (VS Code)][use-vscode-debugger]
6762
- [PowerShell Command-line Debugging][cli-debugging]
6863

69-
On Windows, you can also use [ISE][use-ise-debugger] to debug PowerShell scripts.
64+
On Windows, you can also use [PowerShell Integrated Scripting Environment (ISE)][use-ise-editor] to edit or debug PowerShell scripts.
65+
However it is not supported if you are using PowerShell installed from the [PowerShell package][get-powershell] or directly [built][building-the-repository] from GitHub.
7066

67+
[use-vscode-editor]:./using-vscode.md#editing-with-vs-code
68+
[use-ise-editor]:./using-ise.md#editing-with-ise
7169
[use-vscode-debugger]:./using-vscode.md#debugging-with-vs-code
7270
[use-ise-debugger]:./using-ise.md#debugging-with-ise
7371
[cli-debugging]:./debugging-from-commandline.md
72+
[get-powershell]:../../README.md#get-powershell
73+
[build-powershell]:../../README.md#building-the-repository
7474

7575

7676
PowerShell Testing

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Write-Host "$result Celsius"
2323

2424
**1. Setting a Breakpoint on a Line**
2525

26-
- Open a [PowerShell editor](learning-powershell.md#powershell-editor)
26+
- Open a [PowerShell editor](README.md#powershell-editor)
2727
- Save the above code snippet to a file. For example, "test.ps1"
2828
- Go to your command-line PowerShell
2929
- Clear existing breakpoints if any
@@ -54,7 +54,7 @@ At /home/jen/debug/test.ps1:5 char:1
5454
[DBG]: PS /home/jen/debug>>
5555
```
5656

57-
- The PowerShell prompt now has the prefix **[DBG]:** as you may noticed. This means
57+
- The PowerShell prompt now has the prefix **[DBG]:** as you may have noticed. This means
5858
we have entered into the debug mode. To watch the variables like $celsius, simply type **$celsius** as below.
5959
- To exit from the debugging, type **q**
6060
- To get help for the debugging commands, simply type **?**. The following is an example of debugging output.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ We recommend that you open a PowerShell console/session and type along with the
77

88
Launch PowerShell Console/Session
99
---
10-
First you need to launch a PowerShell session by following the [Installing PowerShell Guide](./learning-powershell.md#installing-powershell).
10+
First you need to launch a PowerShell session by following the [Installing PowerShell Guide](./README.md#installing-powershell).
1111

1212

1313
Getting Familiar with PowerShell Commands
@@ -20,7 +20,7 @@ In this section, you will learn how to
2020
- find syntax of PowerShell cmdlets
2121
- and more
2222

23-
As mentioned above, PowerShell commands are designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc.
23+
As mentioned above, PowerShell commands are designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc.
2424
Let’s exercise some of the basic PowerShell commands, also known as **cmdlets**.
2525

2626
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
213213

214214
It displays the examples how to use the Get-Process cmdlet.
215215
```PowerShell
216-
PS />**Get-Help -Name Get-Process -Examples**
216+
PS />Get-Help -Name Get-Process -Examples
217217
```
218218

219219
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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Using PowerShell Integrated Scripting Environment (ISE)
22
====
33
The PowerShell ISE only works on Windows. If you are not using Windows, please see [Using Visual Studio Code](./using-vscode.md).
4+
Please note the ISE is not supported if you are using PowerShell installed from the [PowerShell package][get-powershell] or directly [built][building-the-repository] from GitHub.
45

56
Editing with ISE
67
---
@@ -72,3 +73,5 @@ PS C:\test>
7273
See [How to Debug in ISE][debug] for more information.
7374

7475
[debug]:https://msdn.microsoft.com/en-us/powershell/scripting/core-powershell/ise/how-to-debug-scripts-in-windows-powershell-ise#bkmk_2
76+
[get-powershell]:../../README.md#get-powershell
77+
[build-powershell]:../../README.md#building-the-repository

docs/learning-powershell/using-vscode.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Using Visual Studio Code (VS Code)
22
====
33

4-
If you are working on Linux and OS X, you cannot use ISE because it is not supported on these platforms.
5-
In this case, you can choose your favorite editor to write PowerShell scripts.
4+
If you are working on Linux and OS X, you cannot use ISE because it is not supported on these platforms.
5+
In this case, you can choose your favorite editor to write PowerShell scripts.
66
Here we choose VS Code as a PowerShell editor as an example.
77

88
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.).
99

10-
Before starting it, please make sure PowerShell exists on your system.
11-
By following the [Installing PowerShell](./learning-powershell.md#installing-powershell) instructions you can install PowerShell and launch a PowerShell session.
10+
Before starting it, please make sure PowerShell exists on your system.
11+
By following the [Installing PowerShell](./README.md#installing-powershell) instructions you can install PowerShell and launch a PowerShell session.
1212

1313
Editing with VS Code
1414
----
@@ -38,31 +38,31 @@ Editing with VS Code
3838

3939
- After the install, you will see the **Install** button turns to **Enable**.
4040
- Click on **Enable** and **OK**
41-
- Now you are ready for editing.
42-
For example, to create a new file, click **File->New**.
43-
To save it, click **File->Save** and then provide a file name, let's say "helloworld.ps1".
44-
To close the file, click on "x" next to the file name.
41+
- Now you are ready for editing.
42+
For example, to create a new file, click **File->New**.
43+
To save it, click **File->Save** and then provide a file name, let's say "helloworld.ps1".
44+
To close the file, click on "x" next to the file name.
4545
To exit VS Code, **File->Exit**.
4646

4747

4848
Debugging with VS Code
4949
----
5050

51-
- Open a file folder (**File->Open Folder**) that contains the PowerShell modules or scripts you have written already and want to debug.
52-
In this example, we saved the helloworld.ps1 under a directory called "demo".
51+
- Open a file folder (**File->Open Folder**) that contains the PowerShell modules or scripts you have written already and want to debug.
52+
In this example, we saved the helloworld.ps1 under a directory called "demo".
5353
Thus we select the "demo" folder and open it in VS Code.
5454

5555
- Creating the Debug Configuration (launch.json)
5656

57-
Because some information regarding your scripts is needed for debugger to start executing your script, we need to set up the debug config first.
58-
This is one-time process to debug PowerShell scripts under your current folder.
57+
Because some information regarding your scripts is needed for debugger to start executing your script, we need to set up the debug config first.
58+
This is one-time process to debug PowerShell scripts under your current folder.
5959
In our case, the "demo" folder.
6060

6161
* Click on the **Debug** icon (or **Ctrl+Shift+D**)
62-
* Click on the **Settings** icon that looks like a gear.
63-
VS Code will prompt you to **Select Environment**.
64-
Choose **PowerShell**.
65-
Then VS code will auto create a debug configuration settings file in the same folder.
62+
* Click on the **Settings** icon that looks like a gear.
63+
VS Code will prompt you to **Select Environment**.
64+
Choose **PowerShell**.
65+
Then VS code will auto create a debug configuration settings file in the same folder.
6666
It looks like the following:
6767
```json
6868
{
@@ -89,7 +89,7 @@ It looks like the following:
8989
```
9090
- 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.
9191
- To disable the breakpoint, press **F9** again.
92-
- Press **F5** to run the script.
92+
- Press **F5** to run the script.
9393
The execution should stop on the line you put the breakpoint on.
9494
- Press **F5** to continue running the script.
9595

@@ -109,4 +109,4 @@ There are a few blogs that may be helpful to get you started using PowerShell ex
109109
PowerShell Extension for VS Code
110110
----
111111

112-
PowerShell extension source code can be found [GitHub](https://github.com/PowerShell/vscode-powershell-ops)
112+
PowerShell extension source code can be found [GitHub](https://github.com/PowerShell/vscode-powershell-ops).

0 commit comments

Comments
 (0)