diff --git a/.github/linters/mlc_config.json b/.github/linters/mlc_config.json index f9665afc1..fd92b6f67 100644 --- a/.github/linters/mlc_config.json +++ b/.github/linters/mlc_config.json @@ -7,21 +7,19 @@ "pattern": "^(https:\\/\\/)?([www.]?)+(microsoft.com\\/)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$" }, { - "pattern": "/Azure-Proactive-Resiliency-Library/" + "pattern": "img/" }, { - "pattern": "^https:\/\/aka.ms\/opensource\/.*$" + "pattern": "/shortcodes/code/" }, { - "pattern": "^https://review.learn.microsoft.com*" + "pattern": "/Azure-Proactive-Resiliency-Library-v2/" } ], "httpHeaders": [ { "comment": "Workaround as suggested here: https://github.com/tcort/markdown-link-check/issues/201", - "urls": [ - "https://docs.github.com/" - ], + "urls": ["https://docs.github.com/"], "headers": { "Accept-Encoding": "zstd, br, gzip, deflate" } @@ -31,9 +29,5 @@ "retryOn429": true, "retryCount": 5, "fallbackRetryDelay": "30s", - "aliveStatusCodes": [ - 200, - 203, - 206 - ] + "aliveStatusCodes": [200, 203, 206] } diff --git a/.vscode/settings.json b/.vscode/settings.json index de4d60b2f..f1baab8bc 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -12,11 +12,10 @@ "powershell.codeFormatting.useConstantStrings": true, "powershell.codeFormatting.useCorrectCasing": true, "powershell.codeFormatting.whitespaceBetweenParameters": true, - "[json,jsonc]": { - "editor.defaultFormatter": "esbenp.prettier-vscode" - }, "[markdown]": { - "editor.defaultFormatter": "esbenp.prettier-vscode" + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.tabSize": 2, + "editor.autoIndent": "keep", }, "[yaml]": { "editor.defaultFormatter": "esbenp.prettier-vscode", @@ -30,4 +29,4 @@ "strings": true } } -} +} \ No newline at end of file diff --git a/docs/content/contributing/create-content/create-recommendations/_index.md b/docs/content/contributing/create-content/create-recommendations/_index.md index 9788d5605..492b3870e 100644 --- a/docs/content/contributing/create-content/create-recommendations/_index.md +++ b/docs/content/contributing/create-content/create-recommendations/_index.md @@ -16,27 +16,27 @@ To contribute a new recommendation for an Azure resource, follow these steps: 1. Open the `recommendations.yaml` file and copy the following YAML template: - ```yaml - - description: Your Recommendation Title Here (less than 100 characters) - aprlGuid: Generate a Unique GUID for Your Recommendation - recommendationTypeId: null - recommendationImpact: Low/Medium/High - recommendationResourceType: Friendly name to identity resource type - recommendationControl: High Availability/Business Continuity/Disaster Recovery/Scalability/Monitoring and Alerting/Service Upgrade and Retirement/Other Best Practices/Personalized/Governance - recommendationMetadataState: Active - longDescription: | - Your Long Description Here - (less than 300 characters) - potentialBenefits: Potential Benefits of Implementing the Recommendation (less than 60 characters) - publishedToLearn: false - publishedToAdvisor: false - pgVerified: false - automationAvailable: false - tags: null - learnMoreLink: - - name: Learn More - url: "Link URL" - ``` + ```yaml + - description: Your Recommendation Title Here (less than 100 characters) + aprlGuid: Generate a Unique GUID for Your Recommendation + recommendationTypeId: null + recommendationImpact: Low/Medium/High + recommendationResourceType: Friendly name to identity resource type + recommendationControl: High Availability/Business Continuity/Disaster Recovery/Scalability/Monitoring and Alerting/Service Upgrade and Retirement/Other Best Practices/Personalized/Governance + recommendationMetadataState: Active + longDescription: | + Your Long Description Here + (less than 300 characters) + potentialBenefits: Potential Benefits of Implementing the Recommendation (less than 60 characters) + publishedToLearn: false + publishedToAdvisor: false + pgVerified: false + automationAvailable: false + tags: null + learnMoreLink: + - name: Learn More + url: "Link URL" + ``` 1. Customize the placeholders with your recommendation's specific details. See the [Recommendation Structure](#recommendation-structure) section for more information on each key-value pair. @@ -44,18 +44,18 @@ To contribute a new recommendation for an Azure resource, follow these steps: 1. To test your changes, spin up your local hugo server by running the following command within your terminal: - ```bash - hugo server --disableFastRender - ``` + ```bash + hugo server --disableFastRender + ``` - {{< hint type=note >}} + {{< hint type=note >}} - If you encounter inconsistencies on the local version of the website that do not reflect your content updates, or errors unrelated to your changes, follow these steps: + If you encounter inconsistencies on the local version of the website that do not reflect your content updates, or errors unrelated to your changes, follow these steps: - 1. Press **CTRL** **+** **C** to terminate the Hugo local web server. - 2. Restart the Hugo web server by running `hugo server --disableFastRender` from the root of the repository. + 1. Press **CTRL** **+** **C** to terminate the Hugo local web server. + 2. Restart the Hugo web server by running `hugo server --disableFastRender` from the root of the repository. - {{< /hint >}} + {{< /hint >}} 1. Submit your changes by creating a pull request in the repository. @@ -84,7 +84,7 @@ The YAML structure for adding new recommendations consists of several key-value | pgVerified | false | Boolean | true, false | Indicates whether the recommendation is verified by the relevant product group | | automationAvailable | false | Boolean | no, arg | Indicates whether automation is available for validating the recommendation | | tags | null | String | null | Generalized tags used for incorporating fields to automate | -| learnMoreLink | - name: Learn More url: "https://learn.microsoft.com/en-us/azure/reliability/reliability-batch#cross-region-disaster-recovery-and-business-continuity" | Object | Only 1 link per recommendation | Links related to the recommendation, such as announcements or documentation | +| learnMoreLink | - name: Learn More url: "" | Object | Only 1 link per recommendation | Links related to the recommendation, such as announcements or documentation | ### Recommendation Categories