new docs

.github/workflows/gh-pages.yml

@@ -0,0 +1,87 @@
+name: github pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.119.0
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+                        ${{ runner.os }}-node-
+
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v1
+
+      - name: Build with Hugo
+        run:  |
+          npm install -D autoprefixer
+          npm install -D postcss-cli
+          npm install -D postcss
+          npm install
+          hugo --gc --minify --cleanDestinationDir --baseURL https://azure.github.io/azqr/
+        working-directory: ./docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./docs/public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -19,3 +19,10 @@
 
 # Go workspace file
 go.work
+
+## Hugo & Node
+public/
+resources/
+node_modules/
+package-lock.json
+.hugo_build.lock

README.md

@@ -31,11 +31,11 @@ The **Overview** sheet provides a summary of the Azure resources scanned by the
 
 > By default, Azure Quick Review (azqr) masks the Subscription Ids in the spreadsheet, ensuring that they are not directly visible in the output. This helps protect sensitive information and maintain data privacy and security. To view the Subscription Ids, you can use the `--mask=false` flag when running the tool.
 
-To learn more about the **Recommendations**, **Services**, **Defender**, **Advisor** and **Costs** sheets, check the [Scan Results](docs/scan_results/README.md) documentation.
+To learn more about the **Recommendations**, **Services**, **Defender**, **Advisor** and **Costs** sheets, check the [Scan Results](https://azure.github.io/azqr/results) documentation.
 
 ## Azure Quick Review Rules
 
-To learn more about the rules used by **Azure Quick Review (azqr)** for generating recommendations, you can refer to the documentation available [here](docs/rules/README.md).
+To learn more about the rules used by **Azure Quick Review (azqr)** for generating recommendations, you can refer to the documentation available [here](https://azure.github.io/azqr/rules).
 
 ## Supported Azure Services
 

docs/config.yaml

@@ -0,0 +1,15 @@
+# THIS IS A TEST CONFIG ONLY!
+# FOR THE CONFIGURATION OF YOUR SITE USE hugo.yaml.
+#
+# As of Docsy 0.7.0, Hugo 0.110.0 or later must be used.
+#
+# The sole purpose of this config file is to detect Hugo-module builds that use
+# an older version of Hugo.
+#
+# DO NOT add any config parameters to this file. You can safely delete this file
+# if your project is using the required Hugo version.
+
+module:
+  hugoVersion:
+    extended: true
+    min: 0.110.0

docs/content/en/_index.md

@@ -0,0 +1,37 @@
+---
+title: Azure Quick Review
+---
+
+{{< blocks/cover title="Azure Quick Review!" image_anchor="top" height="full" >}}
+<a class="btn btn-lg btn-primary me-3 mb-4" href="/azqr/docs/">
+  Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
+</a>
+<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/azure/azqr">
+  GitHub Repo <i class="fab fa-github ms-2 "></i>
+</a>
+<p class="lead mt-5">Analyze Azure resources and identify whether they comply with Azure's best practices and recommendations.</p>
+{{< blocks/link-down color="info" >}}
+{{< /blocks/cover >}}
+
+
+{{% blocks/lead color="primary" %}}
+
+**Azure Quick Review (azqr)** is a command-line interface (CLI) tool specifically designed to analyze Azure resources and identify whether they comply with Azure's best practices and recommendations. Its primary purpose is to provide users with a detailed overview of their Azure resources, enabling them to easily identify any non-compliant configurations or potential areas for improvement.
+
+{{% /blocks/lead %}}
+
+{{% blocks/section color="dark" type="row" %}}
+
+{{% blocks/feature icon="fab fa-github" title="Read the Docs!" url="https://azure.github.io/azqr/" %}}
+Learn how to use Azure Quick Review (azqr)
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fab fa-github" title="Install azqr!" url="https://github.com/azure/azqr/" %}}
+Learn how to install Azure Quick Review (azqr)
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/azure/azqr" %}}
+We do a [Pull Request](https://github.com/azure/azqr/pulls) contributions workflow on **GitHub**. New users are always welcome!
+{{% /blocks/feature %}}
+
+{{% /blocks/section %}}

docs/content/en/docs/Contribution Guidelines/_index.md

@@ -0,0 +1,20 @@
+---
+title: Contribution Guidelines
+weight: 10
+description: How to contribute to the project
+---
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to
+agree to a Contributor License Agreement (CLA) declaring that you have the right to,
+and actually do, grant us the rights to use your contribution. For details, visit
+https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need
+to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
+instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

docs/content/en/docs/Install/_index.md

@@ -0,0 +1,23 @@
+---
+title: Install
+weight: 2
+description: Learn how to install Azure Quick Review (azqr)
+---
+
+### 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
+```

docs/content/en/docs/Overview/_index.md

@@ -0,0 +1,142 @@
+---
+title: Overview
+description: Azure Quick Review — Analyze Azure resources and identify whether they comply with Azure's best practices and recommendations."
+weight: 1
+---
+
+**Azure Quick Review (azqr)** is a command-line interface (CLI) tool specifically designed to analyze Azure resources and identify whether they comply with Azure's best practices and recommendations. Its primary purpose is to provide users with a detailed overview of their Azure resources, enabling them to easily identify any non-compliant configurations or potential areas for improvement.
+
+## Scan Results
+
+The output generated by **Azure Quick Review (azqr)** is presented in the form of an Excel file, which consists of several sheets including **Overview**, **Recommendations**, **Services**, **Defender**, **Advisor** and **Costs**. Additionally, when running the tool on a Windows system, it also generates a Power BI Desktop Template for further analysis and visualization of the Azure resource data.
+
+The **Overview** sheet provides a summary of the Azure resources scanned by the tool, including the following information:
+
+* **SubscriptionID**: This is the unique identifier for the Azure subscription under which the resource is deployed.
+* **ResourceGroup**: The resource group where the resource is deployed.
+* **Location**: The geographical region where the resource is deployed.
+* **Type**: The specific type or category of the Azure resource.
+* **Name**: The name assigned to the resource, providing a human-readable identifier for easy reference and management.
+* **SKU**: The SKU represents the specific variant or configuration of the Azure resource. It defines the characteristics and capabilities of the resource.
+* **SLA**: The Service Level Agreement (SLA) represents the agreed-upon performance and availability guarantees for the Azure service based on its current configuration.
+* **AZ**: A Boolean value indicating whether the service is "Availability Zone aware." Availability Zones are physically separate datacenters within an Azure region, providing increased resiliency and fault tolerance for critical services.
+* **PVT**: A Boolean value indicating whether the service has a private IP address. Private IP addresses are used for internal communication within Azure Virtual Networks.
+* **DS**: A Boolean value indicating whether diagnostic settings are enabled for the service. Diagnostic settings allow you to collect logs, metrics, and other monitoring data for Azure resources.
+* **CAF**: A Boolean value indicating whether the service is compliant with the [Cloud Adoption Framework](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations) (CAF) naming convention. The CAF provides best practices and guidance for organizations adopting Azure.
+
+> By default, Azure Quick Review (azqr) masks the Subscription Ids in the spreadsheet, ensuring that they are not directly visible in the output. This helps protect sensitive information and maintain data privacy and security. To view the Subscription Ids, you can use the `--mask=false` flag when running the tool.
+
+To learn more about the **Recommendations**, **Services**, **Defender**, **Advisor** and **Costs** sheets, check the [Scan Results](https://azure.github.io/azqr/results) documentation.
+
+## Azure Quick Review Rules
+
+To learn more about the rules used by **Azure Quick Review (azqr)** for generating recommendations, you can refer to the documentation available [here](https://azure.github.io/azqr/rules).
+
+## Supported Azure Services
+
+**Azure Quick Review (azqr)** currently supports the following Azure services:
+
+* Azure API Management
+* Azure App Configuration
+* Azure App Services
+* Azure Application Gateway
+* Azure Application Insights
+* Azure Cache for Redis
+* Azure Cognitive Services Account
+* Azure Container Apps
+* Azure Container Instances
+* Azure Container Registry
+* Azure Cosmos DB
+* Azure Data Explorer
+* Azure Data Factory
+* Azure Database for MariaDB
+* Azure Database for MySQL Flexible Server
+* Azure Database for MySQL Single Server
+* Azure Database for PostgreSQL Flexible Server
+* Azure Database for PostgreSQL Single Server
+* Azure Event Grid
+* Azure Event Hub
+* Azure Firewall
+* Azure Front Door
+* Azure Functions
+* Azure Key Vault
+* Azure Kubernetes Service
+* Azure Load Balancer
+* Azure Service Bus
+* Azure SignalR Service
+* Azure SQL Database
+* Azure Storage Account
+* Azure Virtual Machine
+* Azure Virtual Network
+* 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)
+
+## Trademark Notice
+
+> **Trademarks** This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

docs/content/en/docs/Reference/_index.md

@@ -0,0 +1,7 @@
+---
+title: Resources & References
+description: Check out other resources and references
+weight: 9
+---
+
+TODO