Skip to content

Commit

Permalink
Update contributing, install, reference, related, results, troublesho…
Browse files Browse the repository at this point in the history
…oting, and usage pages
  • Loading branch information
cmendible committed Jan 13, 2024
1 parent 919829d commit 26437b8
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contribution Guidelines
weight: 10
weight: 22
description: How to contribute to the project
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/Install/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Install
weight: 2
weight: 3
description: Learn how to install Azure Quick Review (azqr)
---

Expand Down
18 changes: 16 additions & 2 deletions docs/content/en/docs/Reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
---
title: Resources & References
description: Check out other resources and references
weight: 9
weight: 21
---

TODO
## Microsoft Documentation

- [Azure Well-Architected Framework](https://docs.microsoft.com/en-us/azure/architecture/framework/)
- [Azure Availability Zones](https://docs.microsoft.com/en-us/azure/availability-zones/az-overview)
- [Azure Service Level Agreements](https://azure.microsoft.com/en-us/support/legal/sla/)
- [Azure Diagnostic Settings](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/diagnostic-settings)
- [Azure Private Link](https://docs.microsoft.com/en-us/azure/private-link/private-link-overview)
- [Azure Advisor](https://docs.microsoft.com/en-us/azure/advisor/advisor-overview)
- [Microsoft Defender for Cloud](https://learn.microsoft.com/en-us/azure/defender-for-cloud/defender-for-cloud-introduction)
- [Azure Cost Management + Billing](https://docs.microsoft.com/en-us/azure/cost-management-billing/cost-management-billing-overview)

## Related Projects
- [Azure Proactive Resiliency Library (APRL)](https://azure.github.io/Azure-Proactive-Resiliency-Library/)
- [review-checklist](https://github.com/Azure/review-checklists)
- [PSRule.Rules.Azure](https://github.com/Azure/PSRule.Rules.Azure)
17 changes: 17 additions & 0 deletions docs/content/en/docs/Related/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Releated Projects
description: Azure Quick Review difference to Azure Review Checklists and PSRule.Rules.Azure
weight: 6
---

**Azure Quick Review (azqr)** was created to address a very specific need we had back in 2022. Initially, we had to run three assessments to get a clear picture of various solutions in terms of SLAs, use of Availability Zones, and Diagnostic Settings. At the time, we were not aware of the existence of the [`review-checklist`](https://github.com/Azure/review-checklists) or [`PSRule.Rules.Azure`](https://github.com/Azure/PSRule.Rules.Azure).

When some of our peers saw the assessments we were able to deliver with the early bits of **Azure Quick Review (azqr)**, they asked us to add more checks (rules) and change the output format from markdown to Excel.

Also, many of our customers work in very restrictive environments. Therefore, the ability to run a self-contained binary, in any OS, that requires just read-only permissions was very important.

Moving forward to 2023, based on great feedback from both peers and customers, we moved the original repo to the Azure organization, added support for more services, fixed some issues and even added a Power BI template.

To be open we are giving **Azure Quick Review (azqr)** a "best effort" approach, and since we learned about [`PSRule.Rules.Azure`](https://github.com/Azure/PSRule.Rules.Azure), we are slowly trying to catch up with their great set of rules, with no intention to replace Bernie White's and collaborators outstanding work.

Long Story short, given the fact that each solution is built using different technologies and have a different set of features, there is room for both.
2 changes: 1 addition & 1 deletion docs/content/en/docs/Results/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Scan Results
description: Scan Results
weight: 4
weight: 5
---

Azure Quick Review (azqr) creates an excel spreadsheet with the following sections:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/Troubleshooting/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Troubleshooting & Support
description: Troubleshooting & Support
weight: 8
weight: 20
---

If you encounter any issue while using **Azure Quick Review (azqr)**, please set the `AZURE_SDK_GO_LOGGING` environment variable to `all`, run the tool with the `--debug` flag and then share the console output with us by filing a new [issue](https://github.com/Azure/azqr/issues).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/Usage/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Usage
description: Use Azure Quick Review — to analyze Azure resources and identify whether they comply with Azure's best practices and recommendations.
weight: 1
weight: 2
---

## Authentication
Expand Down

0 comments on commit 26437b8

Please sign in to comment.