From f14f4d0392d0f3535380fb110e042615d160bc6e Mon Sep 17 00:00:00 2001 From: Jack Tracey <41163455+jtracey93@users.noreply.github.com> Date: Tue, 24 May 2022 10:15:58 +0100 Subject: [PATCH] Add v1.x.x Q&A to FAQ (#238) * add faq question * Update docs/wiki/FAQ.md Co-authored-by: Jan Faurskov <22591930+jfaurskov@users.noreply.github.com> Co-authored-by: Jan Faurskov <22591930+jfaurskov@users.noreply.github.com> --- docs/wiki/FAQ.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/wiki/FAQ.md b/docs/wiki/FAQ.md index 011baf7d7..9c75df114 100644 --- a/docs/wiki/FAQ.md +++ b/docs/wiki/FAQ.md @@ -16,6 +16,16 @@ Some FAQ questions that relate more to the architecture are based over in the CA ## Questions & Answers +## Why isn't `ALZ-Bicep` v1.x.x yet? + +Great question! Put simply this is because Bicep itself is not on a v1.X.X release yet which means there is a possibility for larger breaking changes still to occur in Bicep itself (upstream) which will in turn mean that these changes will have to be integrated into `ALZ-Bicep`. + +This however, does not mean you shouldn't use ALZ-Bicep or Bicep as they are fully supported and ready for production usage. + +As we use GitHub releases and tags you can clone and pin to a specific version in your codebase and upgrade when you are ready and willing to do so 👍 + +In summary, `ALZ-Bicep` will go v1.x.x when Bicep itself goes v1.x.x, give or take a few weeks for us to make any changes required in `ALZ-Bicep` upon the release of Bicep v1.x.x 👍 + ## Why are some linter rules disabled via the `#disable-next-line` Bicep function? In some of the ALZ-Bicep modules some of linter rules are disabled using the `#disable-next-line` Bicep feature. Today, this is primarily for disabling the [no-loc-expr-outside-params linter rule](https://docs.microsoft.com/azure/azure-resource-manager/bicep/linter-rule-no-loc-expr-outside-params) for the, optional, telemetry module as we want to ensure this telemetry deployment is stored in the same location as specified by the `location` input when deploying the Bicep module, instead of in the same location as specified by `parLocation` as this may be different from the region targeted by the deployment to ARM.