From 0197624d3913b391fe7aac7f08d734f8ac01086c Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 27 Jun 2022 22:35:05 +0200 Subject: [PATCH 1/2] Reset some of the feedback from Mate's wiki walkthrough --- docs/wiki/Solution creation.md | 4 ++-- .../The CI environment - GitHub ReadMe module table update.md | 2 +- docs/wiki/The CI environment - Pipeline design.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/wiki/Solution creation.md b/docs/wiki/Solution creation.md index 21437dd74f..d5c8221c23 100644 --- a/docs/wiki/Solution creation.md +++ b/docs/wiki/Solution creation.md @@ -57,8 +57,8 @@ Once you start building a solution using this library, you may wonder how best t - Use the [VS-Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) for Bicep to enable DSL-native features such as auto-complete. Metadata implemented in the modules are automatically loaded through the extension. - Use the readme - - If you don't know how to use an object/array parameter you can check if the module's ReadMe file specifies any 'Parameter Usage' block for set parameter ([example](https://github.com/Azure/ResourceModules/blob/main/modules/Microsoft.AnalysisServices/servers/readme.md#parameter-usage-tags)) - or - check the module's `Deployment Examples` ([example](https://github.com/Azure/ResourceModules/blob/main/modules/Microsoft.AnalysisServices/servers/readme.md#deployment-examples)). - - In general, take note of the `Deployment Examples` specified in each module's ReadMe file as they provide you with rich & tested examples of how set module can be deployed ([example](https://github.com/Azure/ResourceModules/blob/main/modules/Microsoft.AnalysisServices/servers/readme.md#deployment-examples)). An easy way to get started is to copy one of the examples and then adjust to it your needs. + - If you don't know how to use an object/array parameter, you can check if the module's ReadMe file specifies any 'Parameter Usage' block for the given parameter ([example](https://github.com/Azure/ResourceModules/blob/main/modules/Microsoft.AnalysisServices/servers/readme.md#parameter-usage-tags)) - or - check the module's `Deployment Examples` ([example](https://github.com/Azure/ResourceModules/blob/main/modules/Microsoft.AnalysisServices/servers/readme.md#deployment-examples)). + - In general, take note of the `Deployment Examples` specified in each module's ReadMe file, as they provide you with rich & tested examples of how a given module can be deployed ([example](https://github.com/Azure/ResourceModules/blob/main/modules/Microsoft.AnalysisServices/servers/readme.md#deployment-examples)). An easy way to get started is to copy one of the examples and then adjust it to your needs. - Note the outputs that are returned by each module. - If an output you need isn't available, you have 2 choices: 1. Add the missing output to the module diff --git a/docs/wiki/The CI environment - GitHub ReadMe module table update.md b/docs/wiki/The CI environment - GitHub ReadMe module table update.md index a280f5bbd8..a534139d2b 100644 --- a/docs/wiki/The CI environment - GitHub ReadMe module table update.md +++ b/docs/wiki/The CI environment - GitHub ReadMe module table update.md @@ -1,5 +1,5 @@ Use this script to update a given ReadMe's module table in its 'Available Resource Modules' section. -In the platform's pipeline `platform.updateReadMe.yml`, this script is invoked each time anything in the `modules` path changes to keep the table in sync. It updates both the root ReadMe (`/readme.md`) and `modules` folder ReadMe (`/modules/readme.md`) with a different set of required columns +In the platform's pipeline `platform.updateReadMe.yml`, this script is invoked each time anything in the `modules` path changes to keep the table in sync. It updates both the root ReadMe ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README)) and `modules` folder ReadMe ([`/modules/readme.md`](https://github.com/Azure/ResourceModules/blob/main/modules/readme)) with a different set of required columns. --- diff --git a/docs/wiki/The CI environment - Pipeline design.md b/docs/wiki/The CI environment - Pipeline design.md index 32dfff6557..4b0ce5b177 100644 --- a/docs/wiki/The CI environment - Pipeline design.md +++ b/docs/wiki/The CI environment - Pipeline design.md @@ -258,7 +258,7 @@ The repository includes two major ReadMe files that should stay in sync with the The first can be found in the repository root (`README.md`) and the second in the modules folder (`modules/README.md`). -The ReadMe pipeline is triggered each time changes are pushed to the `main` branch and only if a template in the `modules` folder is being altered. The pipeline leverages the script documented in the [GitHub ReadMe module table update](./The%20CI%20environment%20-%20GitHub%20ReadMe%20module%20table%20update) page. +The ReadMe pipeline is triggered each time changes are pushed to the `main` branch and only if a template in the `modules` folder is being altered. The pipeline leverages the script documented on the [GitHub ReadMe module table update](./The%20CI%20environment%20-%20GitHub%20ReadMe%20module%20table%20update) page. Once triggered, the pipeline crawls through the library and updates the tables in each corresponding ReadMe file, creating links to the corresponding pipeline runs and updating the list of entries. From dd1dc4fa91228376da7f25dfa744ed79e6b90ce9 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 27 Jun 2022 22:48:19 +0200 Subject: [PATCH 2/2] Update docs/wiki/The CI environment - GitHub ReadMe module table update.md Co-authored-by: Alexander Sehr --- .../The CI environment - GitHub ReadMe module table update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wiki/The CI environment - GitHub ReadMe module table update.md b/docs/wiki/The CI environment - GitHub ReadMe module table update.md index a534139d2b..091fb6b713 100644 --- a/docs/wiki/The CI environment - GitHub ReadMe module table update.md +++ b/docs/wiki/The CI environment - GitHub ReadMe module table update.md @@ -1,5 +1,5 @@ Use this script to update a given ReadMe's module table in its 'Available Resource Modules' section. -In the platform's pipeline `platform.updateReadMe.yml`, this script is invoked each time anything in the `modules` path changes to keep the table in sync. It updates both the root ReadMe ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README)) and `modules` folder ReadMe ([`/modules/readme.md`](https://github.com/Azure/ResourceModules/blob/main/modules/readme)) with a different set of required columns. +In the platform's pipeline `platform.updateReadMe.yml`, this script is invoked each time anything in the `modules` path changes to keep the table in sync. It updates both the root ReadMe ([`/readme.md`](https://github.com/Azure/ResourceModules/blob/main/README.md)) and `modules` folder ReadMe ([`/modules/readme.md`](https://github.com/Azure/ResourceModules/blob/main/modules/README.md)) with a different set of required columns. ---