Skip to content

Commit

Permalink
Fixes for documentation links including #2557 (#2558)
Browse files Browse the repository at this point in the history
  • Loading branch information
BernieWhite authored Nov 28, 2023
1 parent 578f65a commit 1a8fbb3
Show file tree
Hide file tree
Showing 12 changed files with 30 additions and 30 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Use a reaction in place of a "+1" comment:
* 👍 - upvote
* 👎 - downvote

[3]: https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments
[3]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/

## Improving documentation

Expand Down Expand Up @@ -70,9 +70,9 @@ Rule documentation requires the following annotations for use with PSRule for Az
*NB* - the severity ratings reflect a productionised implementation, consideration should be applied for pre-production environments.

Available severities are:
- `Critical` - A 'must have' if the solution is to be considered 'fit for purpose', secure, well governed and managed inline with the Microsoft Azure [Well-Architected Framework](https://learn.microsoft.com/en-us/azure/well-architected/).
- `Critical` - A 'must have' if the solution is to be considered 'fit for purpose', secure, well governed and managed inline with the Microsoft Azure [Well-Architected Framework](https://learn.microsoft.com/azure/well-architected/).
- `Important` - A 'to be considered' within the context of the solution and domain. In some cases, can introduce cost or complexity that should be considered as a trade off and explicity documented as a [Key Design Decision](https://learn.microsoft.com/azure/cloud-adoption-framework/decision-guides/).
- `Awareness` - A 'good to have' feature, normally reserved for solutions with the highest [non-functional requirements](https://learn.microsoft.com/azure/well-architected/resiliency/design-requirements).
- `Awareness` - A 'good to have' feature, normally reserved for solutions with the highest [non-functional requirements](https://learn.microsoft.com/azure/well-architected/reliability/checklist).

- `pillar` - A Azure Well-Architected Framework pillar.
Either `Cost Optimization`, `Operational Excellence`, `Performance Efficiency`, `Reliability`, `Security`.
Expand Down Expand Up @@ -244,12 +244,12 @@ or contact [[email protected]](mailto:[email protected]) with any addi
Your contributions to open source, large or small, make great projects like this possible.
Thank you for taking the time to contribute.

[learn-git]: https://help.github.com/articles/git-and-github-learning-resources
[github-flow]: https://guides.github.com/introduction/flow/
[learn-git]: https://docs.github.com/get-started/quickstart/git-and-github-learning-resources
[github-flow]: https://docs.github.com/get-started/quickstart/github-flow
[github-signup]: https://github.com/signup/free
[github-fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
[github-pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
[github-pr-create]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
[github-fork]: https://docs.github.com/get-started/quickstart/fork-a-repo
[github-pr]: https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
[github-pr-create]: https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[build]: docs/install.md#building-from-source
[vscode]: https://code.visualstudio.com/
[issues]: https://github.com/Azure/PSRule.Rules.Azure/issues
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Features of PSRule for Azure include:
- Rules can be directly adopted and additional enterprise specific rules can be layed on.
- Provide regular baselines to allow progressive adoption.

[5]: https://docs.microsoft.com/en-gb/azure/architecture/framework/
[5]: https://learn.microsoft.com/azure/well-architected/

## Support

Expand All @@ -45,7 +45,7 @@ Please search the existing issues before filing new issues to avoid duplicates.
- For new issues, file your bug or feature request as a new [issue].
- For help, discussion, and support questions about using this project, join or start a [discussion].

If you have any problems with the [PSRule][engine] engine, please check the project GitHub [issues](https://github.com/Microsoft/PSRule/issues) page instead.
If you have any problems with the [PSRule][engine] engine, please check the project GitHub [issues](https://github.com/microsoft/PSRule/issues) page instead.

Support for this project/ product is limited to the resources listed above.

Expand Down Expand Up @@ -418,6 +418,6 @@ Any use of third-party trademarks or logos are subject to those third-party's po
[issue]: https://github.com/Azure/PSRule.Rules.Azure/issues
[discussion]: https://github.com/Azure/PSRule.Rules.Azure/discussions
[engine]: https://github.com/microsoft/PSRule
[create-workflow]: https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file
[create-workflow]: https://docs.github.com/actions/using-workflows#creating-a-workflow-file
[extension]: https://marketplace.visualstudio.com/items?itemName=bewhite.ps-rule
[troubleshooting guide]: https://azure.github.io/PSRule.Rules.Azure/troubleshooting/
4 changes: 2 additions & 2 deletions docs/customization/enforce-codeowners.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ In these cases, it may be important that specific paths are used for Infrastruct
The following scenario shows how to create a custom rule to validate the file path of code artifacts.
The scenario walks you through the process so that you can apply the same concepts for similar requirements.

[1]: https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners
[2]: https://docs.microsoft.com/azure/devops/repos/git/branch-policies?view=azure-devops#automatically-include-code-reviewers
[1]: https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
[2]: https://learn.microsoft.com/azure/devops/repos/git/branch-policies#automatically-include-code-reviewers

## Creating a new rule

Expand Down
2 changes: 1 addition & 1 deletion docs/customization/enforce-custom-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,5 +181,5 @@ Grab the full sample code for each of these files from:
- [Org.Azure.Rule.ps1](https://github.com/Azure/PSRule.Rules.Azure/blob/main/docs/customization/enforce-custom-tags/.ps-rule/Org.Azure.Rule.ps1)
- [ps-rule.yaml](https://github.com/Azure/PSRule.Rules.Azure/blob/main/docs/customization/enforce-custom-tags/ps-rule.yaml)

[AWAF]: https://learn.microsoft.com/azure/architecture/framework/
[AWAF]: https://learn.microsoft.com/azure/well-architected/
[assertions]: https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Assert-PSRule/
4 changes: 2 additions & 2 deletions docs/customization/storing-custom-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For example:
PSRule allows custom rules to be layered on.
These custom rules work side-by-side with PSRule for Azure.

[1]: https://docs.microsoft.com/en-gb/azure/architecture/framework/
[1]: https://learn.microsoft.com/azure/well-architected/

## Using a standard file path

Expand All @@ -39,7 +39,7 @@ To store standalone rules we recommend that you:
Build pipelines are often case-sensitive or run on Linux-based systems.
Using the casing rule above reduces confusion latter when you configure continuous integration (CI).

[2]: https://github.com/microsoft/PSRule/blob/main/docs/scenarios/rule-module/rule-module.md
[2]: https://microsoft.github.io/PSRule/stable/authoring/packaging-rules/

## Naming rules

Expand Down
2 changes: 1 addition & 1 deletion docs/en/mcsb-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Controls from the MCSB are also mapped to industry frameworks, such as CIS, PCI-
If you are new to MCSB or are looking for guidance on how to use it,
please see the [Introduction to the Microsoft cloud security benchmark][1].

[1]: https://docs.microsoft.com/security/benchmark/azure/introduction
[1]: https://learn.microsoft.com/security/benchmark/azure/introduction

## Microsoft cloud security benchmark v1

Expand Down
6 changes: 3 additions & 3 deletions docs/en/rules/Azure.ACR.ContainerScan.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,6 @@ This rule applies when analyzing resources deployed (in-flight) to Azure.
## LINKS

- [Monitor Azure resources in Microsoft Defender for Cloud](https://learn.microsoft.com/azure/architecture/framework/security/monitor-resources#containers)
- [Introduction to Microsoft Defender for container registries](https://docs.microsoft.com/azure/defender-for-cloud/defender-for-container-registries-introduction)
- [Container security in Microsoft Defender for Cloud](https://docs.microsoft.com/azure/defender-for-cloud/container-security)
- [Secure the images and run time](https://docs.microsoft.com/azure/aks/operator-best-practices-container-image-management#secure-the-images-and-run-time)
- [Introduction to Microsoft Defender for container registries](https://learn.microsoft.com/azure/defender-for-cloud/defender-for-container-registries-introduction)
- [Container security in Microsoft Defender for Cloud](https://learn.microsoft.com/azure/defender-for-cloud/defender-for-containers-introduction)
- [Secure the images and run time](https://learn.microsoft.com/azure/aks/operator-best-practices-container-image-management#secure-the-images-and-run-time)
2 changes: 1 addition & 1 deletion docs/expanding-source-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ When using PSRule for Azure, these functions have a default meaning that can be
When configuring scope functions, only the properties you want to override has to be specified.
Unspecified properties will inherit from the defaults.

[4]: https://docs.microsoft.com/azure/azure-resource-manager/templates/template-functions-scope
[4]: https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-scope

### Subscription

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ PSRule and PSRule for Azure currently do not collect any telemetry during instal
PowerShell (used by PSRule for Azure) does collect basic telemetry by default.
Collection of telemetry in PowerShell and how to opt-out is explained in [about_Telemetry][12].

[12]: https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_telemetry
[12]: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_telemetry

*[ARM]: Azure Resource Manager
*[WAF]: Well-Architected Framework
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/configuring-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ configuration:

:octicons-milestone-24: v1.30.0

> Applies to [Azure.Resource.AllowedRegions](../en/rules/Resource.AllowedRegions.md).
> Applies to [Azure.Resource.AllowedRegions](../en/rules/Azure.Resource.AllowedRegions.md).

This configuration option specifies a list of allowed locations that resources can be deployed to.
Rules that check the location of Azure resources fail when a resource or resource group is created in a different region.
Expand Down
10 changes: 5 additions & 5 deletions docs/using-bicep.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ To specify required parameters for a module, create a deployment or test that re
}
```

[2]: https://docs.microsoft.com/azure/azure-resource-manager/bicep/modules
[2]: https://learn.microsoft.com/azure/azure-resource-manager/bicep/modules

### Configuring path exclusions

Expand Down Expand Up @@ -365,10 +365,10 @@ Typically, the following three environment variables should be set:
To keep `BICEPREGISTRYCLIENTSECRET` secure, use a [variable group][6] linked to an Azure Key Vault.

[3]: https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-config-modules#configure-profiles-and-credentials
[4]: https://docs.microsoft.com/dotnet/api/azure.identity.environmentcredential
[5]: https://docs.github.com/actions/reference/encrypted-secrets
[6]: https://docs.microsoft.com/azure/devops/pipelines/library/variable-groups
[11]: https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
[4]: https://learn.microsoft.com/dotnet/api/azure.identity.environmentcredential
[5]: https://docs.github.com/actions/security-guides/using-secrets-in-github-actions
[6]: https://learn.microsoft.com/azure/devops/pipelines/library/variable-groups
[11]: https://learn.microsoft.com/entra/identity-platform/howto-create-service-principal-portal

## Recommended content

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ markdown_extensions:
- mdx_truly_sane_lists
- pymdownx.tasklist
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc:
permalink: '#'
separator: '-'
Expand Down

0 comments on commit 1a8fbb3

Please sign in to comment.