Skip to content

Commit

Permalink
Updated welcome pages and contribution guide to reflect name change
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeyBarnes committed Mar 8, 2024
1 parent 439fe57 commit ade570c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions docs/content/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ The example folder structure below highlights all of the key assets that define
└── Deploy-VM-DataDiskReadLatency-Alert.json
```

**patterns:** *This folder contains assets for pattern/scenario specific guidance that leverages the baseline alerts in this repo. This contribute does not cover contributions to the patterns/services section. There will be specific guides within each pattern/service section.*
**patterns:** *This folder contains assets for pattern/scenario specific guidance that leverages the baseline alerts in this repo. This guide does not cover contributions to the patterns/scenarios section. There will be specific guides within each pattern/scenarios section.*

**services:** *This folder contains the baseline alert definitions, guidance, and example deployment scripts. It is grouped by resource category (e.g. Compute), and then by resource type (e.g. virtualMachines).*
**services:** *This folder contains the baseline alert definitions, guidance, and example deployment scripts. It is grouped by resource provider (e.g. Compute), and then by resource type (e.g. virtualMachines).*

{{< hint type=note >}}
You may need to add new resource category and/or resource type folders as you define new baseline alerts. These folders are case-sensitive and follow the naming conventions defined by the [Azure Resource Reference](https://learn.microsoft.com/azure/templates/) documentation. For example: Alert guidance for Microsoft.Compute/virtualMachines would go under 'services/Compute/virtualMachines'
You may need to add new resource provider and/or resource type folders as you define new baseline alerts. These folders are case-sensitive and follow the naming conventions defined by the [Azure Resource Reference](https://learn.microsoft.com/azure/templates/) documentation. For example: Alert guidance for Microsoft.Compute/virtualMachines would go under 'services/Compute/virtualMachines'
{{< /hint >}}

**_index.md:** *These files control the menu structure and the content layout for GitHub Pages site. There are only two versions of these files, one for the resource categories, which just controls the friendly name in the menu and title. The other version is at the resource type level and it controls the layout of the GitHub Pages site. As you create new folders, just copy the respective versions and change the title in the metadata section at the top of the file.*
**_index.md:** *These files control the menu structure and the content layout for GitHub Pages site. There are only two versions of these files, one for the resource providers, which just controls the friendly name in the menu and title. The other version is at the resource type level and it controls the layout of the GitHub Pages site. As you create new folders, just copy the respective versions and change the title in the metadata section at the top of the file.*

**alerts.yaml:** *This YAML-based file contains the detailed definition and guidance for the baseline alerts within each resource category/type folder. Below is the general structure of the file.*
**alerts.yaml:** *This YAML-based file contains the detailed definition and guidance for the baseline alerts within each resource provider/type folder. Below is the general structure of the file.*

```yaml
- name: <alert name>
Expand Down Expand Up @@ -96,7 +96,7 @@ Please note the following settings in the alert definition:
## Auto-Generated Alert Rules
A script was run to automatically generate alert rules based on top usage and settings trends. These rules have been added to their respective *alerts.yaml* files and have two tags associated with them: *auto-generated* and *agc-xxxx*. The *agc-xxxx* tag indicates the number of results found for that alert rule in the query used to analyze the top trends. This number should be used to evaluate the importance of including that alert rule as guidance in the repo. Once an auto-generated alert rule has been verified and updated with reference documentation, the *visible* property should be set to *true*. This will make the alert rule visible on the site. Resource categories and types that do not have visible alerts are currently hidden from the table of contents. To make those resource categories and types visible, edit their respective *_index.md* files and remove the *geekdocHidden: true* metadata from the top of the file.
A script was run to automatically generate alert rules based on top usage and settings trends. These rules have been added to their respective *alerts.yaml* files and have two tags associated with them: *auto-generated* and *agc-xxxx*. The *agc-xxxx* tag indicates the number of results found for that alert rule in the query used to analyze the top trends. This number should be used to evaluate the importance of including that alert rule as guidance in the repo. Once an auto-generated alert rule has been verified and updated with reference documentation, the *visible* property should be set to *true*. This will make the alert rule visible on the site. Resource providers and types that do not have visible alerts are currently hidden from the table of contents. To make those resource providers and types visible, edit their respective *_index.md* files and remove the *geekdocHidden: true* metadata from the top of the file.
## Context/Background
Expand Down
2 changes: 1 addition & 1 deletion docs/content/welcome/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 0
Welcome to the Azure Monitor Baseline Alerts (AMBA) site! The purpose of this site is to provide best practice guidance around key alerts metrics and their thresholds.

This sites is broken down into two main sections:
1. **Services:** This section provides guidance for individual Azure services. For each service, there is a list of key alert metrics and the recommended thresholds.
1. **Azure Resources:** This section provides guidance for individual Azure resources. For each service, there is a list of key alert metrics and the recommended thresholds.

2. **Patterns / Scenarios:** This section provides guidance for common patterns / scenarios (like Azure Landing Zones), as well as policy definition and initiatives for deploying the alerts in your environment.

Expand Down

0 comments on commit ade570c

Please sign in to comment.