Skip to content

Commit ce68236

Browse files
committed
Update docs in repository
1 parent 4b0c96d commit ce68236

19 files changed

+1755
-1742
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 118 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Try it out in Azure Cloud Shell!
1111
## Modules
1212
Below is a table containing our Azure PowerShell rollup module.
1313

14-
Description | Module Name | PowerShell Gallery Link
15-
------------------------------------- | --------------------------------------- | -----------------------
16-
Azure PowerShell | `Az` | [![Az]][AzGallery]
14+
Description | Module Name | PowerShell Gallery Link
15+
----------------- | ------------ | -----------------------
16+
Azure PowerShell | `Az` | [![Az]][AzGallery]
1717

1818
For a full list of modules found in this repository, please see the [Azure PowerShell Modules][AzurePowerShelModules] document.
1919

@@ -27,7 +27,7 @@ Run the following command in an elevated PowerShell session to install the rollu
2727
Install-Module -Name Az
2828
```
2929

30-
This module runs on Windows PowerShell with [.NET Framework 4.7.2][DotNetFramework] or greater, or [PowerShell Core][PowerShellCore]. The Az module replaces AzureRM. You should not install Az side-by-side with AzureRM.
30+
This module runs on Windows PowerShell with [.NET Framework 4.7.2][DotNetFramework] or greater, or [PowerShell Core][PowerShellCore]. The `Az` module replaces `AzureRM`. You should not install `Az` side-by-side with `AzureRM`.
3131

3232
If you have an earlier version of the Azure PowerShell modules installed from the PowerShell Gallery and would like to update to the latest version, run the following commands in an elevated PowerShell session:
3333

@@ -43,7 +43,7 @@ For detailed instructions on installing Azure PowerShell, please refer to the [i
4343

4444
### Log into Azure
4545

46-
To connect to Azure, use the [Connect-AzAccount][ConnectAzAccount] cmdlet:
46+
To connect to Azure, use the [`Connect-AzAccount`][ConnectAzAccount] cmdlet:
4747

4848
```powershell
4949
# Device Code login - Provides a link to sign into Azure via your web browser
@@ -53,7 +53,7 @@ Connect-AzAccount
5353
Connect-AzAccount -ServicePrincipal -ApplicationId 'http://my-app' -Credential $PSCredential -TenantId $TenantId
5454
```
5555

56-
To log into a specific cloud (_AzureChinaCloud_, _AzureCloud_, _AzureGermanCloud_, _AzureUSGovernment_), use the `Environment` parameter:
56+
To log into a specific cloud (_AzureChinaCloud_, _AzureCloud_, _AzureGermanCloud_, _AzureUSGovernment_), use the `-Environment` parameter:
5757

5858
```powershell
5959
# Specific cloud login - Logs into the Azure China cloud
@@ -62,7 +62,7 @@ Connect-AzAccount -Environment AzureChinaCloud
6262

6363
### Getting and setting your Azure PowerShell session context
6464

65-
A session context persists login information across Azure PowerShell modules and PowerShell instances. To view the context you are using in the current session, which contains the subscription and tenant, use the [Get-AzContext][GetAzContext] cmdlet:
65+
A session context persists login information across Azure PowerShell modules and PowerShell instances. To view the context you are using in the current session, which contains the subscription and tenant, use the [`Get-AzContext`][GetAzContext] cmdlet:
6666

6767
```powershell
6868
# Gets the Azure PowerShell context for the current PowerShell session
@@ -72,7 +72,7 @@ Get-AzContext
7272
Get-AzContext -ListAvailable
7373
```
7474

75-
To get the subscriptions in a tenant, use the [Get-AzSubscription][GetAzSubscription] cmdlet:
75+
To get the subscriptions in a tenant, use the [`Get-AzSubscription`][GetAzSubscription] cmdlet:
7676

7777
```powershell
7878
# Get all of the Azure subscriptions in your current Azure tenant
@@ -82,7 +82,7 @@ Get-AzSubscription
8282
Get-AzSubscription -TenantId $TenantId
8383
```
8484

85-
To change the subscription that you are using for your current context, use the [Set-AzContext][SetAzContext] cmdlet:
85+
To change the subscription that you are using for your current context, use the [`Set-AzContext`][SetAzContext] cmdlet:
8686

8787
```powershell
8888
# Set the Azure PowerShell context to a specific Azure subscription
@@ -139,13 +139,13 @@ Alternatively, be sure to check out the [Azure Community Support](https://azure.
139139

140140
### Feedback
141141

142-
If there is a feature you would like to see in Azure PowerShell, please use the [Send-Feedback][SendFeedback] cmdlet, or file an issue in our [GitHub issues][GitHubIssues] page to provide the Azure PowerShell team direct feedback.
142+
If there is a feature you would like to see in Azure PowerShell, please use the [`Send-Feedback`][SendFeedback] cmdlet, or file an issue in our [GitHub issues][GitHubIssues] page to provide the Azure PowerShell team direct feedback.
143143

144144
## Contribute Code
145145

146146
If you would like to become an active contributor to this project, please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines][ContributionGuidelines].
147147

148-
Additional information about contributing to this repository can be found in the [Contributing][Contributing] document and the [Azure PowerShell Developer Guide][DeveloperGuide] document.
148+
Additional information about contributing to this repository can be found in the [`CONTRIBUTING.md`][Contributing] document and the [_Azure PowerShell Developer Guide_][DeveloperGuide] document.
149149

150150
## Learn More
151151

documentation/Debugging-StaticAnalysis-Errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ _Note_: Sometimes the error listed in the .csv file can be a false positive (for
4242
We take breaking changes very seriously, so please be mindful about the violations that you suppress in our repo.
4343

4444
### Signature Issues
45-
Signature issues occur when your cmdlets do not follow PowerShell standards. Please check [this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/azure-powershell-design-guidelines.md) to ensure you are following PowerShell guidelines. Issues with severity 0 or 1 must be addressed, while issues with severity 2 are advisory. If you have an issue with severity 0 or 1 that has been approved by the Azure PowerShell team, you can suppress them following these steps:
45+
Signature issues occur when your cmdlets do not follow PowerShell standards. Please check the [_Cmdlet Best Practices_](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/design-guidelines/cmdlet-best-practices.md) and the [_Parameter Best Practices_](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/design-guidelines/parameter-best-practices.md) documents to ensure you are following PowerShell guidelines. Issues with severity 0 or 1 must be addressed, while issues with severity 2 are advisory. If you have an issue with severity 0 or 1 that has been approved by the Azure PowerShell team, you can suppress them following these steps:
4646

4747
- Download the `SignatureIssues.csv` file from the Jenkins build
4848
- Open the file using a text editor (such as VS Code) and copy each of the errors you'd like to suppress

0 commit comments

Comments
 (0)