From 1a8fbb3dbcc6cdb1c6a00b619f44ca6368e5e20f Mon Sep 17 00:00:00 2001 From: Bernie White Date: Wed, 29 Nov 2023 01:56:40 +1000 Subject: [PATCH] Fixes for documentation links including #2557 (#2558) --- CONTRIBUTING.md | 16 ++++++++-------- README.md | 6 +++--- docs/customization/enforce-codeowners.md | 4 ++-- docs/customization/enforce-custom-tags.md | 2 +- docs/customization/storing-custom-rules.md | 4 ++-- docs/en/mcsb-v1.md | 2 +- docs/en/rules/Azure.ACR.ContainerScan.md | 6 +++--- docs/expanding-source-files.md | 2 +- docs/faq.md | 2 +- docs/setup/configuring-rules.md | 2 +- docs/using-bicep.md | 10 +++++----- mkdocs.yml | 4 ++-- 12 files changed, 30 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f995cddd28..394c0aaa012 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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`. @@ -244,12 +244,12 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) 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 diff --git a/README.md b/README.md index e37b411f1e3..13fe57916ef 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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/ diff --git a/docs/customization/enforce-codeowners.md b/docs/customization/enforce-codeowners.md index 5609ce61395..df2caa67d40 100644 --- a/docs/customization/enforce-codeowners.md +++ b/docs/customization/enforce-codeowners.md @@ -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 diff --git a/docs/customization/enforce-custom-tags.md b/docs/customization/enforce-custom-tags.md index b1f2599d46b..f23a1d5ae49 100644 --- a/docs/customization/enforce-custom-tags.md +++ b/docs/customization/enforce-custom-tags.md @@ -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/ diff --git a/docs/customization/storing-custom-rules.md b/docs/customization/storing-custom-rules.md index 7dcfc556004..8af737a61a7 100644 --- a/docs/customization/storing-custom-rules.md +++ b/docs/customization/storing-custom-rules.md @@ -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 @@ -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 diff --git a/docs/en/mcsb-v1.md b/docs/en/mcsb-v1.md index d425c3bb877..8012173ae79 100644 --- a/docs/en/mcsb-v1.md +++ b/docs/en/mcsb-v1.md @@ -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 diff --git a/docs/en/rules/Azure.ACR.ContainerScan.md b/docs/en/rules/Azure.ACR.ContainerScan.md index a728fa50245..2aeb2f45b1e 100644 --- a/docs/en/rules/Azure.ACR.ContainerScan.md +++ b/docs/en/rules/Azure.ACR.ContainerScan.md @@ -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) diff --git a/docs/expanding-source-files.md b/docs/expanding-source-files.md index de4d0842214..01dc14d6923 100644 --- a/docs/expanding-source-files.md +++ b/docs/expanding-source-files.md @@ -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 diff --git a/docs/faq.md b/docs/faq.md index 7f5b2586c73..3d3a9f3b94e 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -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 diff --git a/docs/setup/configuring-rules.md b/docs/setup/configuring-rules.md index e61d95cbe8e..881597b6b67 100644 --- a/docs/setup/configuring-rules.md +++ b/docs/setup/configuring-rules.md @@ -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. diff --git a/docs/using-bicep.md b/docs/using-bicep.md index b8af9050249..5e34cc8141b 100644 --- a/docs/using-bicep.md +++ b/docs/using-bicep.md @@ -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 @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 0bbc83c132f..cf4f0c2ebb5 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: '-'