Merge branch 'main' into bryanzab/UpdateReferences

config/_default/hugo.toml

@@ -63,6 +63,9 @@ enableRobotsTXT = true
   tag = "tags"
 
 [params]
+
+  ambaDevMode = false
+
   # (Optional, default 6) Set how many table of contents levels to be showed on page.
   # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
   # You can also specify this parameter per page in front matter.

config/test/hugo.toml

@@ -0,0 +1,163 @@
+baseURL = "https://azure.github.io/azure-monitor-baseline-alerts"
+title = "Azure Monitor Baseline Alerts"
+theme = "hugo-geekdoc"
+themesDir = "docs/themes"
+
+# Required to get well formatted code blocks
+pygmentsUseClasses = true
+pygmentsCodeFences = true
+disablePathToLower = true
+enableGitInfo = true
+
+# Required if you want to render robots.txt template
+enableRobotsTXT = true
+
+[module]
+  [[module.mounts]]
+    source = 'docs/content'
+    target = 'content'
+  [[module.mounts]]
+    source = 'docs/static'
+    target = 'static'
+  [[module.mounts]]
+    source = 'docs/layouts'
+    target = 'layouts'
+  [[module.mounts]]
+    source = 'docs/data'
+    target = 'data'
+  [[module.mounts]]
+    source = 'docs/assets'
+    target = 'assets'
+  [[module.mounts]]
+    source = 'docs/i18n'
+    target = 'i18n'
+  [[module.mounts]]
+    source = 'docs/archetypes'
+    target = 'archetypes'
+  [[module.mounts]]
+    source = 'services'
+    target = 'static/services'
+    excludeFiles = ['**/_index.json']
+  [[module.mounts]]
+    source = 'services'
+    target = 'content/services'
+    excludeFiles = ['**/*.json', '**/README.md']
+  [[module.mounts]]
+    source = 'services'
+    target = 'data'
+    includeFiles = ['**/alerts.yaml']
+  [[module.mounts]]
+    source = 'services'
+    target = 'static'
+    includeFiles = ['amba-alerts.*']
+
+[markup]
+  [markup.goldmark.renderer]
+    # Needed for mermaid shortcode
+    unsafe = true
+  [markup.tableOfContents]
+    startLevel = 1
+    endLevel = 6
+
+[taxonomies]
+  tag = "tags"
+
+[params]
+
+  ambaDevMode = true
+
+  # (Optional, default 6) Set how many table of contents levels to be showed on page.
+  # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
+  # You can also specify this parameter per page in front matter.
+  geekdocToC = 3
+
+  # (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
+  # relative to your 'static/' folder.
+  geekdocLogo = "img/amba_logo_thumb.png"
+
+  # (Optional, default false) Render menu from data file in 'data/menu/main.yaml'.
+  # See also https://geekdocs.de/usage/menus/#bundle-menu.
+  geekdocMenuBundle = false
+
+  # (Optional, default false) Collapse all menu entries, can not be overwritten
+  # per page if enabled. Can be enabled per page via 'geekdocCollapseSection'.
+  geekdocCollapseAllSections = false
+
+  # (Optional, default true) Show page navigation links at the bottom of each
+  # docs page (bundle menu only).
+  geekdocNextPrev = false
+
+  # (Optional, default true) Show a breadcrumb navigation bar at the top of each docs page.
+  # You can also specify this parameter per page in front matter.
+  geekdocBreadcrumb = false
+
+  # (Optional, default none) Set source repository location. Used for 'Edit page' links.
+  # You can also specify this parameter per page in front matter.
+  geekdocRepo = "https://github.com/Azure/azure-monitor-baseline-alerts"
+
+  # (Optional, default none) Enable 'Edit page' links. Requires 'geekdocRepo' param
+  # and the path must point to the parent directory of the 'content' folder.
+  # You can also specify this parameter per page in front matter.
+  geekdocEditPath = ""
+
+  # (Optional, default true) Enables search function with flexsearch.
+  # Index is built on the fly and might slow down your website.
+  geekdocSearch = true
+
+  # (Optional, default false) Display search results with the parent folder as prefix. This
+  # option allows you to distinguish between files with the same name in different folders.
+  # NOTE: This parameter only applies when 'geekdocSearch = true'.
+  geekdocSearchShowParent = true
+
+  # (Optional, default none) Add a link to your Legal Notice page to the site footer.
+  # It can be either a remote url or a local file path relative to your content directory.
+  # geekdocLegalNotice = "https://blog.example.com/legal"
+
+  # (Optional, default none) Add a link to your Privacy Policy page to the site footer.
+  # It can be either a remote url or a local file path relative to your content directory.
+  # geekdocPrivacyPolicy = "/privacy"
+
+  # (Optional, default true) Add an anchor link to headlines.
+  geekdocAnchor = true
+
+  # (Optional, default true) Copy anchor url to clipboard on click.
+  geekdocAnchorCopy = true
+
+  # (Optional, default true) Enable or disable image lazy loading for images rendered
+  # by the 'img' shortcode.
+  geekdocImageLazyLoading = true
+
+  # (Optional, default false) Set HTMl <base> to .Site.BaseURL if enabled. It might be required
+  # if a subdirectory is used within Hugos BaseURL.
+  # See https://developer.mozilla.org/de/docs/Web/HTML/Element/base.
+  geekdocOverwriteHTMLBase = false
+
+  # (Optional, default true) Enable or disable the JavaScript based color theme toggle switch. The CSS based
+  # user preference mode still works.
+  geekdocDarkModeToggle = true
+
+  # (Optional, default false) Auto-decrease brightness of images and add a slightly grayscale to avoid
+  # bright spots while using the dark mode.
+  geekdocDarkModeDim = false
+
+  # (Optional, default false) Enforce code blocks to always use the dark color theme.
+  geekdocDarkModeCode = false
+
+  # (Optional, default true) Display a "Back to top" link in the site footer.
+  geekdocBackToTop = true
+
+  # (Optional, default false) Enable or disable adding tags for post pages automatically to the navigation sidebar.
+  geekdocTagsToMenu = true
+
+  # (Optional, default 'title') Configure how to sort file-tree menu entries. Possible options are 'title', 'linktitle',
+  # 'date', 'publishdate', 'expirydate' or 'lastmod'. Every option can be used with a reverse modifier as well
+  # e.g. 'title_reverse'.
+  geekdocFileTreeSortBy = "title"
+
+  # (Optional, default none) Adds a "Content licensed under <license>" line to the footer.
+  # Could be used if you want to define a default license for your content.
+  # [params.geekdocContentLicense]
+  #   name = "CC BY-SA 4.0"
+  #   link = "https://creativecommons.org/licenses/by-sa/4.0/"
+
+

docs/content/patterns/alz/deploy/Introduction-to-deploying-the-ALZ-Pattern.md

@@ -34,9 +34,9 @@ Alerts, action groups and alert processing rules are created as follows:
 
 7. For leveraging the log alerts for Virtual Machines, ensure that VM Insights is enabled for the Virtual Machines to be monitored. For more details on VM Insights deployment see [here](https://learn.microsoft.com/en-us/azure/azure-monitor/vm/vminsights-enable-overview) . Please note only the performance collection of the VM insights solution is required  for the current alerts to deploy.
 
-    {{< hint type=note >}}
-    While it´s recommended to implement the alert policies and initiatives to an ALZ Management Group hierarchy, it is not a technical requirement. These policies and initiatives can be implemented in existing brownfield scenarios that don´t adhere to the ALZ Management Group hierarchy. For example, in hierarchies where there is a single management group, or where the structure does not align to ALZ. At least one management group is required. In case you haven't implemented management groups, we included guidance on how to get started.
-    {{< /hint >}}
+{{< hint type=note >}}
+While it´s recommended to implement the alert policies and initiatives to an ALZ Management Group hierarchy, it is not a technical requirement. These policies and initiatives can be implemented in existing brownfield scenarios that don´t adhere to the ALZ Management Group hierarchy. For example, in hierarchies where there is a single management group, or where the structure does not align to ALZ. At least one management group is required. In case you haven't implemented management groups, we included guidance on how to get started.
+{{< /hint >}}
 
 ## Getting started
 

docs/layouts/partials/menu-filetree.html

@@ -0,0 +1,98 @@
+{{ $current := . }}
+{{ template "tree-nav" dict "sect" .Site.Home.Sections "current" $current }}
+
+
+<!-- templates -->
+{{ define "tree-nav" }}
+  {{ $current := .current }}
+
+
+  <ul class="gdoc-nav__list">
+    {{ $sortBy := (default "title" .current.Site.Params.geekdocFileTreeSortBy | lower) }}
+    {{ range .sect.GroupBy "Weight" }}
+      {{ $rangeBy := .ByTitle }}
+
+      {{ if eq $sortBy "title" }}
+        {{ $rangeBy = .ByTitle }}
+      {{ else if eq $sortBy "linktitle" }}
+        {{ $rangeBy = .ByLinkTitle }}
+      {{ else if eq $sortBy "date" }}
+        {{ $rangeBy = .ByDate }}
+      {{ else if eq $sortBy "publishdate" }}
+        {{ $rangeBy = .ByPublishDate }}
+      {{ else if eq $sortBy "expirydate" }}
+        {{ $rangeBy = .ByExpiryDate }}
+      {{ else if eq $sortBy "lastmod" }}
+        {{ $rangeBy = .ByLastmod }}
+      {{ else if eq $sortBy "title_reverse" }}
+        {{ $rangeBy = .ByTitle.Reverse }}
+      {{ else if eq $sortBy "linktitle_reverse" }}
+        {{ $rangeBy = .ByLinkTitle.Reverse }}
+      {{ else if eq $sortBy "date_reverse" }}
+        {{ $rangeBy = .ByDate.Reverse }}
+      {{ else if eq $sortBy "publishdate_reverse" }}
+        {{ $rangeBy = .ByPublishDate.Reverse }}
+      {{ else if eq $sortBy "expirydate_reverse" }}
+        {{ $rangeBy = .ByExpiryDate.Reverse }}
+      {{ else if eq $sortBy "lastmod_reverse" }}
+        {{ $rangeBy = .ByLastmod.Reverse }}
+      {{ end }}
+
+      {{ range $rangeBy }}
+        {{ if or (not .Params.geekdocHidden) (.Site.Params.ambaDevMode) }}
+          {{ $numberOfPages := (add (len .Pages) (len .Sections)) }}
+          {{ $isParent := and (ne $numberOfPages 0) (not .Params.geekdocFlatSection) }}
+          {{ $isCurrent := eq $current . }}
+          {{ $isAncestor := .IsAncestor $current }}
+          {{ $id := substr (sha1 .Permalink) 0 8 }}
+          {{ $doCollapse := and $isParent (or .Params.geekdocCollapseSection (default false .Site.Params.geekdocCollapseAllSections)) }}
+
+
+          <li>
+            <input
+              type="checkbox"
+              {{ if $doCollapse }}
+                class="gdoc-nav__toggle" id="{{ printf "navtree-%s" $id }}"
+                {{ if or $isCurrent $isAncestor }}checked{{ end }}
+              {{ else }}
+                class="hidden"
+              {{ end }}
+            />
+            <label
+              {{ if $doCollapse }}
+                for="{{ printf "navtree-%s" $id }}" class="flex justify-between align-center"
+              {{ end }}
+            >
+              {{ if or .Content .Params.geekdocFlatSection }}
+                <span class="flex">
+                  <a
+                    href="{{ .RelPermalink }}"
+                    class="gdoc-nav__entry{{- if eq $current . }}
+                      {{- printf " is-active" }}
+                    {{- end }}"
+                  >
+                    {{ partial "utils/title" . }}
+                  </a>
+                </span>
+              {{ else }}
+                <span class="flex">{{ partial "utils/title" . }}</span>
+              {{ end }}
+              {{ if $doCollapse }}
+                <svg class="gdoc-icon toggle gdoc_keyboard_arrow_left">
+                  <use xlink:href="#gdoc_keyboard_arrow_left"></use>
+                </svg>
+                <svg class="gdoc-icon toggle gdoc_keyboard_arrow_down">
+                  <use xlink:href="#gdoc_keyboard_arrow_down"></use>
+                </svg>
+              {{ end }}
+            </label>
+
+            {{ if $isParent }}
+              {{ template "tree-nav" dict "sect" .Pages "current" $current }}
+            {{ end }}
+          </li>
+        {{ end }}
+      {{ end }}
+    {{ end }}
+  </ul>
+{{ end }}

docs/layouts/partials/metricAlertProperties.html

@@ -1,33 +1,26 @@
 
 <div><table>
   <tr>
-    <th>Criterion Type</th>
-    {{ if isset . "dimensions" }}
-      <th>Dimensions</th>
-    {{ end }}
+    <th>Operator</th>
+    <th>Aggregation</th>
     {{ if eq .criterionType "DynamicThresholdCriterion" }}
       <th>Alert Sensitivity</th>
       <th>Failing Periods</th>
+    {{ else }}
+      <th>Threshold</th>
     {{ end }}
-    <th>Aggregation</th>
-    <th>Operator</th>
-    <th>Threshold</th>
     <th>Window</th>
     <th>Frequency</th>
     <th>Severity</th>
+    {{ if isset . "dimensions" }}
+      <th>Dimensions</th>
+    {{ end }}
+    <th>Criterion Type</th>
   </tr>
 
   <tr>
-    <td>{{ .criterionType }}</td>
-    {{ if isset . "dimensions" }}
-      <td>
-        {{ if or (reflect.IsMap .dimensions) (reflect.IsSlice .dimensions) }}
-          {{ transform.Highlight (encoding.Jsonify (dict "indent" "  ") .dimensions) "json" }}
-        {{ else }}
-          {{ .dimensions }}
-        {{ end }}
-      </td>
-    {{ end }}
+    <td>{{ .operator }}</td>
+    <td>{{ .timeAggregation }}</td>
     {{ if eq .criterionType "DynamicThresholdCriterion" }}
       <td>{{ .alertSensitivity }}</td>
       <td>
@@ -37,12 +30,21 @@
           {{ .failingPeriods }}
         {{ end }}
       </td>
+    {{ else }}
+      <td>{{  cast.ToString .threshold }}</td>
     {{ end }}
-    <td>{{ .timeAggregation }}</td>
-    <td>{{ .operator }}</td>
-    <td>{{ .threshold }}</td>
     <td>{{ .windowSize }}</td>
     <td>{{ .evaluationFrequency }}</td>
     <td>{{ .severity }}</td>
+    {{ if isset . "dimensions" }}
+      <td>
+        {{ if or (reflect.IsMap .dimensions) (reflect.IsSlice .dimensions) }}
+          {{ transform.Highlight (encoding.Jsonify (dict "indent" "  ") .dimensions) "json" }}
+        {{ else }}
+          {{ .dimensions }}
+        {{ end }}
+      </td>
+    {{ end }}
+    <td>{{ .criterionType }}</td>
   </tr>
 </table></div>