Skip to content

Standards

Documentation and naming conventions used throughout this project.

IIC Naming Convention

All Azure and Azure Local resources in this project follow the IIC (Infinite Improbability Corp) naming standard:

Resource Groups

rg-iic-<purpose>-<##>
Example Purpose
rg-iic-migration-01 Resources for migration tooling
rg-iic-production-01 Production workloads on Azure Local
rg-iic-network-01 Networking resources

Virtual Machines

<site>-<role>-<##>
Example Role
azlocal-iic-web-01 Web server
azlocal-iic-sql-01 SQL Server
azlocal-iic-app-01 Application server
azlocal-iic-dc-01 Domain controller

Azure Local Clusters

azlocal-iic-<##>

Example: azlocal-iic-01

Network Resources

vnet-iic-<purpose>-<##>
snet-iic-<purpose>-<##>
nsg-iic-<purpose>-<##>

Domain and DNS

Item Value
Active Directory domain iic.local
Public/cloud domain improbability.cloud
DNS servers 10.0.0.10, 10.0.0.11

Documentation Standards

All documentation in this repository follows these conventions:

  1. No real company names: All customer-specific names are replaced with IIC / Infinite Improbability Corp
  2. No real datacenters: Referred to as IIC datacenter
  3. Tabs for platform variants: AHV vs. ESXi and Option A vs. Option B use the === "..." tab syntax
  4. Admonitions for warnings: !!! warning for destructive operations, !!! tip for shortcuts, !!! note for informational asides
  5. Tables over prose: Configuration requirements are always in tables when there are 3+ items

MkDocs Style Guide

  • Page titles: Title Case
  • Section headings: Sentence case
  • Code blocks: Always include language identifier (powershell,bash, ```yaml)
  • Relative links within docs: Use relative/path.md — no absolute URLs for internal docs
  • Diagrams: Rendered images go in docs/assets/images/ and editable sources go in docs/assets/diagrams/
  • Diagram references: Embed rendered files via ![alt](../assets/images/<file>.svg|png) and include a companion Draw.io source link
  • Do not commit local export/mount artifacts (for example, mnt/ paths)

Terminology standard

  • Prefer Azure Local VMs terminology across docs for target workloads
  • Avoid outdated phrasing that implies unsupported direct AHV migration paths

See MkDocs Material reference for the full feature set.

Git Commit Conventions

This repository uses Conventional Commits:

feat:     New documentation page or significant content addition
fix:      Correction to existing content (broken link, wrong command, etc.)
docs:     Minor wording improvements
chore:    Non-content changes (mkdocs.yml, workflows, package updates)
refactor: Restructure without content change

Release notes are generated automatically from commit messages via release-please.