Usage section

Azure · Oct 13, 2023 · fe7d908 · fe7d908
1 parent d21b0f0
commit fe7d908
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 69 deletions.
diff --git a/docs/content/en/docs/Install/_index.md b/docs/content/en/docs/Install/_index.md
@@ -4,20 +4,20 @@ weight: 2
 description: Learn how to install Azure Quick Review (azqr)
 ---
 
-### Install on Linux or Azure Cloud Shell
+## Install on Linux or Azure Cloud Shell
 
 ```bash
 latest_azqr=$(curl -sL https://api.github.com/repos/Azure/azqr/releases/latest | jq -r ".tag_name" | cut -c1-)
 wget https://github.com/Azure/azqr/releases/download/$latest_azqr/azqr-ubuntu-latest-amd64 -O azqr
 chmod +x azqr
 ```
 
-### Install on Mac
-
-Download the latest release from [here](https://github.com/Azure/azqr/releases).
-
-### Install on Windows
+## Install on Windows
 
 ```console
 winget install azqr
-```
+```
+
+## Install on Mac
+
+Download the latest release from [here](https://github.com/Azure/azqr/releases).
diff --git a/docs/content/en/docs/Overview/_index.md b/docs/content/en/docs/Overview/_index.md
@@ -71,68 +71,6 @@ To learn more about the rules used by **Azure Quick Review (azqr)** for generati
 * Azure Virtual WAN
 * Azure Web PubSub
 
-## Usage
-
-### Install on Linux or Azure Cloud Shell
-
-```bash
-latest_azqr=$(curl -sL https://api.github.com/repos/Azure/azqr/releases/latest | jq -r ".tag_name" | cut -c1-)
-wget https://github.com/Azure/azqr/releases/download/$latest_azqr/azqr-ubuntu-latest-amd64 -O azqr
-chmod +x azqr
-```
-
-### Install on Mac
-
-Download the latest release from [here](https://github.com/Azure/azqr/releases).
-
-### Install on Windows
-
-```console
-winget install azqr
-```
-
-### Authentication
-
-**Azure Quick Review (azqr)** supports the following authentication methods:
-
-* Azure CLI
-* Service Principal. You'll need to set the following environment variables:
-  * AZURE_CLIENT_ID
-  * AZURE_CLIENT_SECRET
-  * AZURE_TENANT_ID
-
-### Authorization
-
-**Azure Quick Review (azqr)** requires the following permissions:
-
-* Subscription Reader
-
-### Running the Scan
-
-To scan all resource groups in all subscription run:
-
-```bash
-./azqr scan
-```
-
-To scan all resource groups in a specific subscription run:
-
-```bash
-./azqr scan -s <subscription_id>
-```
-
-To scan a specific resource group in a specific subscription run:
-
-```bash
-./azqr scan -s <subscription_id> -g <resource_group_name>
-```
-
-For information on available commands and help run:
-
-```bash
-./azqr -h
-```
-
 ## Code of Conduct
 
 This project has adopted the [Microsoft Open Source Code of Conduct](CODE_OF_CONDUCT.md)

diff --git a/docs/content/en/docs/Usage/_index.md b/docs/content/en/docs/Usage/_index.md
@@ -0,0 +1,47 @@
+---
+title: Usage
+description: Use Azure Quick Review &mdash; to analyze Azure resources and identify whether they comply with Azure's best practices and recommendations.
+weight: 1
+---
+
+## Authentication
+
+**Azure Quick Review (azqr)** supports the following authentication methods:
+
+* Azure CLI
+* Service Principal. You'll need to set the following environment variables:
+  * AZURE_CLIENT_ID
+  * AZURE_CLIENT_SECRET
+  * AZURE_TENANT_ID
+
+## Authorization
+
+**Azure Quick Review (azqr)** requires the following permissions:
+
+* Subscription Reader
+
+## Running the Scan
+
+To scan all resource groups in all subscription run:
+
+```bash
+./azqr scan
+```
+
+To scan all resource groups in a specific subscription run:
+
+```bash
+./azqr scan -s <subscription_id>
+```
+
+To scan a specific resource group in a specific subscription run:
+
+```bash
+./azqr scan -s <subscription_id> -g <resource_group_name>
+```
+
+For information on available commands and help run:
+
+```bash
+./azqr -h
+```