Skip to content
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

Updated documentation links #178

Merged
merged 1 commit into from
May 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Due to the spected amount of parallel changes to the **config.json** file, entri

The topics in this section provide development guidelines that you can use to produce well-formed cmdlets. By leveraging the common functionality provided by the Windows PowerShell runtime and by following these guidelines, you can develop robust cmdlets with minimal effort and provide the user with a consistent experience. Additionally, you will reduce the test burden because common functionality does not require retesting.

[Cmdlet Development Guidelines (by Microsoft)](https://msdn.microsoft.com/en-us/library/ms714657(v=vs.85).aspx):
[Cmdlet Development Guidelines (by Microsoft)](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/cmdlet-development-guidelines?view=powershell-7.2):

* [Required Development Guidelines](https://msdn.microsoft.com/en-us/library/dd878238(v=vs.85).aspx)
* [Strongly Encouraged Development Guidelines](https://msdn.microsoft.com/en-us/library/dd878270(v=vs.85).aspx)
* [Advisory Development Guidelines](https://msdn.microsoft.com/en-us/library/dd878291(v=vs.85).aspx)
- [Required Development Guidelines](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/required-development-guidelines?view=powershell-7.2)
- [Strongly Encouraged Development Guidelines](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/strongly-encouraged-development-guidelines?view=powershell-7.2)
- [Advisory Development Guidelines](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/advisory-development-guidelines?view=powershell-7.2)

!!! [Approved Verbs for Windows PowerShell Commands](https://msdn.microsoft.com/en-us/library/ms714428(v=vs.85).aspx)
!!! [Approved Verbs for Windows PowerShell Commands](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands?view=powershell-7.2)
19 changes: 10 additions & 9 deletions docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
# Learning PowerShell

A great place to start learning PowerShell is at the PowerShell Github repository where it has a [learning section](https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell). This has a huge amount of information and links to a wide range of PowerShell topics.
A great place to start learning PowerShell is at the PowerShell Github repository where it has a [learning section](https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell). This has a huge amount of information and links to a wide range of PowerShell topics.

PowerShell also has a very complete self documenting help system. You can explore much of what PowerShell offers using the `Get-Help` cmdlet. From within PowerShell, try:
PowerShell also has a very complete self documenting help system. You can explore much of what PowerShell offers using the `Get-Help` cmdlet. From within PowerShell, try:

``` PowerShell
```PowerShell
Get-Help about
```

You will see about 3 pages of topics that can be explored.

Two further functions that will be of great use are:

* Get-Command
* Get-Member
- Get-Command
- Get-Member

Wanting to know what these do? Try `Get-Help Get-Command` and `Get-Help Get-Member` of course.

## PowerShell Verbs and Nouns

PowerShell follows quite a strict Verb-Noun for the naming of its cmdlets. Initially this can be a jarring experience to seasoned programmers. Whilst you can name your functions anything you like, becoming familiar with and adopting the standard verbs will improve your PowerShell coding.
PowerShell follows quite a strict Verb-Noun for the naming of its cmdlets. Initially this can be a jarring experience to seasoned programmers. Whilst you can name your functions anything you like, becoming familiar with and adopting the standard verbs will improve your PowerShell coding.

To see a list of all the approved verbs, simply run:

``` PowerShell
```PowerShell
Get-Verb
```

## More Topics
https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/?view=powershell-6
## More Topics

https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/?view=powershell-7.2