Skip to content

Commit

Permalink
Merge pull request #27 from Azure/JoeyBarnes-patch-1
Browse files Browse the repository at this point in the history
Joey barnes patch 1
  • Loading branch information
JoeyBarnes authored Oct 5, 2023
2 parents 34a2832 + bfd432e commit ec3b5e5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/content/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Please note the following settings in the alert definition:
## Auto-Generated Alert Rules
A script was run to auto-generate alert rules based on top usage and settings trends. These rules have been added the 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 importantance of including that alert in the repo. Once an auto-generated alert has been verified and updated with reference documenation, the *visible* tag should be updated to true. This will make the alert alert visible on the site. Resoruce categories and types that do not have visible alerts are currently hidden from the table of contents. To make those resource categries 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 the 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 documenation, the *visible* property should be set to *true*. This will make the alert rule visible on the site. Resoruce 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.
## Context/Background
Expand Down Expand Up @@ -194,5 +194,5 @@ Once you have committed changes to your fork of the AMBA repo, you create a pull
## Top Tips

1. Sometimes the local version of the website may show some inconsistencies that don't reflect the content you have created.
- If this happens, simply kill the Hugo local web server by pressing <kbd>CTRL</kbd>+<kbd>C</kbd> and then restart the Hugo web server by running `hugo server -D` from the root of the repo.
- If this happens, simply kill the Hugo local web server by pressing <kbd>CTRL</kbd>+<kbd>C</kbd> and then restart the Hugo web server by running `hugo server -D` from the root of the repo.

0 comments on commit ec3b5e5

Please sign in to comment.