Doc updates (#2315)
This commit is contained in:
Родитель
f7dfb6a47c
Коммит
a3bd89bd73
|
@ -73,7 +73,12 @@ PSRule for Azure provides two methods for analyzing Azure resources:
|
|||
- _In-flight_ - After resources are deployed to an Azure subscription.
|
||||
|
||||
For specific use cases see [scenarios](#scenarios).
|
||||
For additional details see the [FAQ](https://azure.github.io/PSRule.Rules.Azure/faq/).
|
||||
For additional details see the [FAQ][12].
|
||||
|
||||
To get started with a sample repository, see [PSRule for Azure Quick Start][13] on GitHub.
|
||||
|
||||
[12]: https://azure.github.io/PSRule.Rules.Azure/faq/
|
||||
[13]: https://github.com/Azure/PSRule.Rules.Azure-quickstart
|
||||
|
||||
### Using with GitHub Actions
|
||||
|
||||
|
@ -357,8 +362,8 @@ PSRule for Azure included the following cmdlets:
|
|||
To find out more, look at these conceptual topics:
|
||||
|
||||
- Getting started:
|
||||
- [How to install PSRule for Azure](https://azure.github.io/PSRule.Rules.Azure/install/)
|
||||
- [Creating your pipeline](https://azure.github.io/PSRule.Rules.Azure/creating-your-pipeline/)
|
||||
- [Validating locally](https://azure.github.io/PSRule.Rules.Azure/validating-locally/)
|
||||
- Testing infrastructure as code:
|
||||
- [Expanding source files](https://azure.github.io/PSRule.Rules.Azure/expanding-source-files/)
|
||||
- [Using templates](https://azure.github.io/PSRule.Rules.Azure/using-templates/)
|
||||
|
|
|
@ -21,6 +21,11 @@ PSRule for Azure uses the principles of the Azure Well-Architected Framework (WA
|
|||
If you want to write your own tests, you can do that too in your choice of YAML, JSON, or PowerShell.
|
||||
However with over 390 tests already built, you can identify and fix issues day one.
|
||||
|
||||
!!! Learn "Get started with a sample repository"
|
||||
To get started with a sample repository, see [PSRule for Azure Quick Start][1] on GitHub.
|
||||
|
||||
[1]: https://github.com/Azure/PSRule.Rules.Azure-quickstart
|
||||
|
||||
## Introducing PSRule for Azure
|
||||
|
||||
An introduction to PSRule for Azure and how it relates to the Azure Well-Architected Framework.
|
||||
|
|
|
@ -83,14 +83,14 @@ If neither property exists, PSRule will use the object type.
|
|||
|
||||
## Testing locally
|
||||
|
||||
To test the custom rule within Visual Studio Code, see [validating locally][4].
|
||||
To test the custom rule within Visual Studio Code, see [How to install PSRule for Azure][4].
|
||||
Alternatively you can test the rule manually by running the following from a PowerShell terminal.
|
||||
|
||||
```powershell
|
||||
Assert-PSRule -Path '.ps-rule/' -Module 'PSRule.Rules.Azure' -InputPath . -Format File
|
||||
```
|
||||
|
||||
[4]: ../validating-locally.md
|
||||
[4]: ../install.md#with-visual-studio-code
|
||||
|
||||
## Sample code
|
||||
|
||||
|
|
|
@ -165,14 +165,14 @@ If neither property exists, PSRule will use the object type.
|
|||
|
||||
## Testing locally
|
||||
|
||||
To test the custom rule within Visual Studio Code, see [validating locally][3].
|
||||
To test the custom rule within Visual Studio Code, see [How to install PSRule for Azure][3].
|
||||
Alternatively you can test the rule manually by running the following from a PowerShell terminal.
|
||||
|
||||
```powershell
|
||||
Assert-PSRule -Path '.ps-rule/' -Module 'PSRule.Rules.Azure' -InputPath . -Format File
|
||||
```
|
||||
|
||||
[3]: ../validating-locally.md
|
||||
[3]: ../install.md#with-visual-studio-code
|
||||
|
||||
## Sample code
|
||||
|
||||
|
|
|
@ -118,14 +118,13 @@ No. You can start using built-in rules and CI with Azure Pipelines or GitHub Act
|
|||
If we didn't tell you, you might not even know that PowerShell runs under the covers.
|
||||
|
||||
To perform local validation, some PowerShell setup is required but we step you through that.
|
||||
See [installation][7] and [validating locally][8] for details.
|
||||
See [How to install PSRule for Azure][7] for details.
|
||||
|
||||
To start writing your own custom rules you can use YAML, JSON, or PowerShell.
|
||||
PowerShell experience is required for some scenarios.
|
||||
We have a walk through scenario [Enforcing custom tags][9] to get you started.
|
||||
|
||||
[7]: install.md
|
||||
[8]: validating-locally.md
|
||||
[9]: customization/enforce-custom-tags.md
|
||||
|
||||
## What permissions do I need to export rule data?
|
||||
|
|
Загрузка…
Ссылка в новой задаче