DevOpsDocs - Øredev 2024

Sample code from DevOpsDocs Transforming Tediousness into Joy presented at Øredev 2024

Prerequisites

1. .NET 8s SDK
2. Run dotnet tool restore to have all tools used available
3. Run git submodule init and git submodule update to ensure Static Docable theme available.

Some of the sample PowerShell scripts use environment variables for storing Azure tenant id and subscription id.

$ENV:AZURE_TENANT_ID='{your tenant}'
$ENV:AZURE_CONTAINER_REGISTRY='{your container registry}'

Azure

Example creating a static documentation website created by inventorying an Azure tenant for resources using the ari .NET tool and Statiq Web web framework.

Bicep

Example creating a static documentation website by inventorying a container registry for Bicep modules using the bri .NET tool and Statiq Web framework.

DotNet

Example creating a static documentation website by scanning C# source code using the Statiq Docs framework. Also an example of adding .NET project dependency information to your documentation using the dpi .NET tool.

SQL

Proof of concept axample creating Markdown document containing a database tables and columns. Using SQL Server PowerShell module (Install-Module -Name SqlServer) Invoke-Sqlcmd cmdlet.