diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 00000000..29820b85 --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 3b735ec4..922d11fd 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,10 @@ # Go workspace file go.work + +## Hugo & Node +public/ +resources/ +node_modules/ +package-lock.json +.hugo_build.lock \ No newline at end of file diff --git a/README.md b/README.md index bd416d0a..3971ff72 100644 --- a/README.md +++ b/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 diff --git a/docs/config.yaml b/docs/config.yaml new file mode 100644 index 00000000..9070e384 --- /dev/null +++ b/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 diff --git a/docs/content/en/_index.md b/docs/content/en/_index.md new file mode 100644 index 00000000..9664e81e --- /dev/null +++ b/docs/content/en/_index.md @@ -0,0 +1,37 @@ +--- +title: Azure Quick Review +--- + +{{< blocks/cover title="Azure Quick Review!" image_anchor="top" height="full" >}} + + Learn More + + + GitHub Repo + +

Analyze Azure resources and identify whether they comply with Azure's best practices and recommendations.

+{{< 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 %}} diff --git a/docs/content/en/docs/Contribution Guidelines/_index.md b/docs/content/en/docs/Contribution Guidelines/_index.md new file mode 100644 index 00000000..2db80897 --- /dev/null +++ b/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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file diff --git a/docs/content/en/docs/Install/_index.md b/docs/content/en/docs/Install/_index.md new file mode 100644 index 00000000..f0a7d15b --- /dev/null +++ b/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 +``` \ No newline at end of file diff --git a/docs/content/en/docs/Overview/_index.md b/docs/content/en/docs/Overview/_index.md new file mode 100644 index 00000000..b119a2b6 --- /dev/null +++ b/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 +``` + +To scan a specific resource group in a specific subscription run: + +```bash +./azqr scan -s -g +``` + +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. diff --git a/docs/content/en/docs/Reference/_index.md b/docs/content/en/docs/Reference/_index.md new file mode 100644 index 00000000..0dd134f4 --- /dev/null +++ b/docs/content/en/docs/Reference/_index.md @@ -0,0 +1,7 @@ +--- +title: Resources & References +description: Check out other resources and references +weight: 9 +--- + +TODO \ No newline at end of file diff --git a/docs/scan_results/README.md b/docs/content/en/docs/Results/_index.md similarity index 95% rename from docs/scan_results/README.md rename to docs/content/en/docs/Results/_index.md index 8117cfda..73919502 100644 --- a/docs/scan_results/README.md +++ b/docs/content/en/docs/Results/_index.md @@ -1,4 +1,8 @@ -# Azure Quick Review Scan Results +--- +title: Scan Results +description: Scan Results +weight: 4 +--- Azure Quick Review (azqr) creates an excel spreadsheet with the following sections: @@ -25,7 +29,7 @@ The overview section contains the following information: * **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. -![overview](img/overview.png) +![overview](/img/overview.png) ## Recommendations @@ -38,7 +42,7 @@ The recommendations section contains a summary of the recommendations for the sc * **Severity**: The severity of the rule (High, Medium, Low). * **Learn**: Link to relevant documentation. -![recommendations](img/recommendations.png) +![recommendations](/img/recommendations.png) ## Services @@ -57,7 +61,7 @@ The services section contains the following information: * **Broken**: True if the rule is broken. * **Learn**: Link to relevant documentation. -![services](img/services.png) +![services](/img/services.png) ## Defender @@ -67,7 +71,7 @@ The defender section contains the following information: * **Tier**: The tier of the plan. * **Deprecated**: True if the plan is deprecated. -![defender](img/defender.png) +![defender](/img/defender.png) ## Advisor diff --git a/docs/rules/README.md b/docs/content/en/docs/Rules/_index.md similarity index 99% rename from docs/rules/README.md rename to docs/content/en/docs/Rules/_index.md index 8091295f..c4eaa138 100644 --- a/docs/rules/README.md +++ b/docs/content/en/docs/Rules/_index.md @@ -1,4 +1,8 @@ -# Azure Quick Review Rules +--- +title: Rules +description: Rules +weight: 3 +--- Azure Quick Review uses the following rules to identify Azure resources that may be or not be compliant with Azure best practices and recommendations: diff --git a/docs/content/en/docs/Troubleshooting/_index.md b/docs/content/en/docs/Troubleshooting/_index.md new file mode 100644 index 00000000..d32d04af --- /dev/null +++ b/docs/content/en/docs/Troubleshooting/_index.md @@ -0,0 +1,19 @@ +--- +title: Troubleshooting & Support +description: Troubleshooting & Support +weight: 8 +--- + +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). + +## Support + +This project uses GitHub Issues to track bugs and feature requests. +Before logging an issue please check our [troubleshooting](#troubleshooting) guide. + +Please search the existing issues before filing new issues to avoid duplicates. + +- For new issues, file your bug or feature request as a new [issue](https://github.com/Azure/azqr/issues). +- For help, discussion, and support questions about using this project, join or start a [discussion](https://github.com/Azure/azqr/discussions). + +Support for this project / product is limited to the resources listed above. diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md new file mode 100644 index 00000000..cda0c5ba --- /dev/null +++ b/docs/content/en/docs/_index.md @@ -0,0 +1,12 @@ +--- +title: Azure Quick Review +linkTitle: Documentation +menu: {main: {weight: 20}} +weight: 20 +--- + +{{% pageinfo %}} +**Azure Quick Review!** — Analyze Azure resources and identify whether they comply with Azure's best practices and recommendations. +{{% /pageinfo %}} + +**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. diff --git a/docs/content/en/search.md b/docs/content/en/search.md new file mode 100644 index 00000000..394feea5 --- /dev/null +++ b/docs/content/en/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- diff --git a/docs/go.mod b/docs/go.mod new file mode 100644 index 00000000..ec0974f5 --- /dev/null +++ b/docs/go.mod @@ -0,0 +1,9 @@ +module github.com/google/docsy-example + +go 1.12 + +require ( + github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 // indirect + github.com/google/docsy v0.7.1 // indirect + github.com/twbs/bootstrap v5.2.3+incompatible // indirect +) diff --git a/docs/go.sum b/docs/go.sum new file mode 100644 index 00000000..e1d4ad4d --- /dev/null +++ b/docs/go.sum @@ -0,0 +1,22 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f h1:bvkUptSRPZBr3Kxuk+bnWCEmQ5MtEJX5fjezyV0bC3g= +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4 h1:xfr9SidRCMEh4A8fdkLhFPcHAVbrdv3Ua0Jp/nSmhhQ= +github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 h1:Uv1z5EqCfmiK4IHUwT0m3h/u/WCk+kpRfxvAZhpC7Gc= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.5.1 h1:D/ZdFKiE29xM/gwPwQzmkyXhcbQGkReRS6aGrF7lnYk= +github.com/google/docsy v0.5.1/go.mod h1:maoUAQU5H/d+FrZIB4xg1EVWAx7RyFMGSDJyWghm31E= +github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= +github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= +github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY= +github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE= +github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY= +github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc= +github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o= +github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.2.3+incompatible h1:lOmsJx587qfF7/gE7Vv4FxEofegyJlEACeVV+Mt7cgc= +github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/docs/hugo.toml b/docs/hugo.toml new file mode 100644 index 00000000..52add978 --- /dev/null +++ b/docs/hugo.toml @@ -0,0 +1,188 @@ +baseURL = "/" +title = "Azure Quick Review" + +# Language settings +contentDir = "content/en" +defaultContentLanguage = "en" +defaultContentLanguageInSubdir = false +# Useful when translating. +enableMissingTranslationPlaceholders = true + +enableRobotsTXT = true + +# Will give values to .Lastmod etc. +enableGitInfo = true + +# Comment out to enable taxonomies in Docsy +# disableKinds = ["taxonomy", "taxonomyTerm"] + +# You can add your own taxonomies +[taxonomies] +tag = "tags" +category = "categories" + +[params.taxonomy] +# set taxonomyCloud = [] to hide taxonomy clouds +taxonomyCloud = ["tags", "categories"] + +# If used, must have same length as taxonomyCloud +taxonomyCloudTitle = ["Tag Cloud", "Categories"] + +# set taxonomyPageHeader = [] to hide taxonomies on the page headers +taxonomyPageHeader = ["tags", "categories"] + +# Highlighting config +pygmentsCodeFences = true +pygmentsUseClasses = false +# Use the new Chroma Go highlighter in Hugo. +pygmentsUseClassic = false +#pygmentsOptions = "linenos=table" +# See https://help.farbox.com/pygments.html +pygmentsStyle = "tango" + +# Configure how URLs look like per section. +[permalinks] +blog = "/:section/:year/:month/:day/:slug/" + +# Image processing configuration. +[imaging] +resampleFilter = "CatmullRom" +quality = 75 +anchor = "smart" + +[services] +[services.googleAnalytics] +# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. +id = "UA-00000000-0" + +# Language configuration + +[languages] +[languages.en] +languageName ="English" +# Weight used for sorting. +weight = 1 +[languages.en.params] +title = "Azure Quick Review" +description = "Azure Quick Review" + +[markup] + [markup.goldmark] + [markup.goldmark.parser.attribute] + block = true + [markup.goldmark.renderer] + unsafe = true + [markup.highlight] + # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html + style = "tango" + # Uncomment if you want your chosen highlight style used for code blocks without a specified language + # guessSyntax = "true" + +# Everything below this are Site Params + +# Comment out if you don't want the "print entire section" link enabled. +[outputs] +section = ["HTML", "print", "RSS"] + +[params] +copyright = "The Azure Quick Review" +# privacy_policy = "https://github.com/azure/azqr/SECURITY.md" + +# First one is picked as the Twitter card image if not set on page. +# images = ["images/project-illustration.png"] + +# Menu title if your navbar has a versions selector to access old versions of your site. +# This menu appears only if you have at least one [params.versions] set. +version_menu = "Releases" + +# Flag used in the "version-banner" partial to decide whether to display a +# banner on every page indicating that this is an archived version of the docs. +# Set this flag to "true" if you want to display the banner. +archived_version = false + +# The version number for the version of the docs represented in this doc set. +# Used in the "version-banner" partial to display a version number for the +# current doc set. +version = "0.0" + +# A link to latest version of the docs. Used in the "version-banner" partial to +# point people to the main doc site. +url_latest_version = "https://azure.github.io/azqr" + +# Repository configuration (URLs for in-page links to opening issues and suggesting changes) +github_repo = "https://github.com/azure/azqr" +# An optional link to a related project repo. For example, the sibling repository where your product code lives. +github_project_repo = "https://github.com/azure/azqr" + +# Specify a value here if your content directory is not in your repo's root directory +# github_subdir = "" + +# Uncomment this if your GitHub repo does not have "main" as the default branch, +# or specify a new value if you want to reference another branch in your GitHub links +github_branch= "main" + +# Google Custom Search Engine ID. Remove or comment out to disable search. +# gcs_engine_id = "d72aa9b2712488cc3" + +# Enable Algolia DocSearch +algolia_docsearch = false + +# Enable Lunr.js offline search +offlineSearch = true + +# Enable syntax highlighting and copy buttons on code blocks with Prism +prism_syntax_highlighting = false + +# User interface configuration +[params.ui] +# Set to true to disable breadcrumb navigation. +breadcrumb_disable = false +# Set to true to disable the About link in the site footer +footer_about_disable = false +# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar +navbar_logo = true +# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. +navbar_translucent_over_cover_disable = false +# Enable to show the side bar menu in its compact state. +sidebar_menu_compact = false +# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) +sidebar_search_disable = false + +# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. +# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. +# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, +# add "hide_feedback: true" to the page's front matter. +[params.ui.feedback] +enable = true +# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). +yes = 'Glad to hear it! Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' + +# Adds a reading time to the top of each doc. +# If you want this feature, but occasionally need to remove the Reading time from a single page, +# add "hide_readingtime: true" to the page's front matter +[params.ui.readingtime] +enable = false + +[params.links] +# Developer relevant links. These will show up on right side of footer and in the community page if you have one. +[[params.links.developer]] + name = "GitHub" + url = "https://github.com/azure/azqr" + icon = "fab fa-github" + desc = "Development takes place here!" + +# hugo module configuration + +[module] + # uncomment line below for temporary local development of module + # replacements = "github.com/google/docsy -> ../../docsy" + [module.hugoVersion] + extended = true + min = "0.110.0" + [[module.imports]] + path = "github.com/google/docsy" + disable = false + [[module.imports]] + path = "github.com/google/docsy/dependencies" + disable = false diff --git a/docs/layouts/404.html b/docs/layouts/404.html new file mode 100644 index 00000000..1a9bd704 --- /dev/null +++ b/docs/layouts/404.html @@ -0,0 +1,7 @@ +{{ define "main" -}} +
+

Not found

+

Oops! This page doesn't exist. Try going back to the home page.

+

You can learn how to make a 404 page like this in Custom 404 Pages.

+
+{{- end }} diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 00000000..53b45ce1 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,38 @@ +{ + "name": "azqr", + "version": "0.7.1", + "description": "Azure Quick Review documentation.", + "repository": "github:azure/azqr", + "homepage": "https://azure.github.io/azqr/", + "author": "azqr Authors", + "license": "Apache-2.0", + "bugs": "https://github.com/azure/azqr/issues", + "spelling": "cSpell:ignore HTMLTEST precheck postbuild -", + "scripts": { + "_build": "npm run _hugo-dev", + "_check:links": "echo IMPLEMENTATION PENDING for check-links; echo", + "_hugo": "hugo --cleanDestinationDir", + "_hugo-dev": "npm run _hugo -- -e dev -DFE", + "_serve": "npm run _hugo-dev -- --minify serve", + "build:preview": "npm run _hugo-dev -- --minify --baseURL \"${DEPLOY_PRIME_URL:-/}\"", + "build:production": "npm run _hugo -- --minify", + "build": "npm run _build", + "check:links:all": "HTMLTEST_ARGS= npm run _check:links", + "check:links": "npm run _check:links", + "clean": "rm -Rf public/* resources", + "make:public": "git init -b main public", + "precheck:links:all": "npm run build", + "precheck:links": "npm run build", + "postbuild:preview": "npm run _check:links", + "postbuild:production": "npm run _check:links", + "serve": "npm run _serve", + "test": "npm run check:links", + "update:pkg:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest", + "update:pkg:hugo": "npm install --save-dev --save-exact hugo-extended@latest" + }, + "devDependencies": { + "autoprefixer": "^10.4.14", + "hugo-extended": "0.119.0", + "postcss-cli": "^10.1.0" + } +} \ No newline at end of file diff --git a/docs/scss/_variables_project.scss b/docs/scss/_variables_project.scss new file mode 100644 index 00000000..25690273 --- /dev/null +++ b/docs/scss/_variables_project.scss @@ -0,0 +1,6 @@ +/* + +Add styles or override variables from the theme here. + +*/ + diff --git a/docs/scan_results/img/defender.png b/docs/static/img/defender.png similarity index 100% rename from docs/scan_results/img/defender.png rename to docs/static/img/defender.png diff --git a/docs/scan_results/img/overview.png b/docs/static/img/overview.png similarity index 100% rename from docs/scan_results/img/overview.png rename to docs/static/img/overview.png diff --git a/docs/scan_results/img/recommendations.png b/docs/static/img/recommendations.png similarity index 100% rename from docs/scan_results/img/recommendations.png rename to docs/static/img/recommendations.png diff --git a/docs/scan_results/img/services.png b/docs/static/img/services.png similarity index 100% rename from docs/scan_results/img/services.png rename to docs/static/img/services.png