Skip to content

[DOCS] Automation section review — restructure, align with aztoolkit, resolve CI/CD location #31

@kristopherjturner

Description

@kristopherjturner

Summary

The docs/automation/ section of the Azure Local Cloud docs site needs a comprehensive review and cleanup. The automation guides are weak and the section structure may not be complete. Additionally, CI/CD infrastructure deployment steps were moved from the deploy section to automation, and the corresponding scripts in azurelocal-toolkit need to reflect this reorganization.

Current State

The docs/automation/ section contains:

automation/
  01-cicd-infra/         ← phase-01-cicd-setup tasks
  02-cicd-pipelines/     ← CI/CD pipeline setup guides
  03-automation-guides/  ← Tool-specific guides (Ansible, Bicep, GitHub Actions, etc.)

Individual automation guides exist for: PowerShell, Bicep, Ansible, GitHub Actions, Azure DevOps Pipelines, GitLab CI/CD, Terraform.

Problems to Address

1. Structural Completeness

  • Audit all pages in docs/automation/ for completeness — which guides are stubs vs. real content?
  • Define what the "complete" automation section should look like (table of contents / structure plan)
  • Ensure there is a strong index.mdx landing page that explains the section's purpose

2. Guide Quality

  • Each tool-specific guide (ansible.mdx, bicep.mdx, etc.) needs meaningful content, not just stubs
  • Guides should explain: when to use each tool for Azure Local automation, how it integrates with the toolkit, example use cases
  • Add code examples / snippets where applicable

3. aztoolkit Alignment

The automation section should mirror the toolkit's automation capabilities:

  • Which scripts/ folders in the toolkit relate to automation (vs. deployment)?
  • src/ in the toolkit contains Bicep, Ansible, and Terraform — this should be documented in the automation section
  • The automation section should link to or reference toolkit scripts where appropriate

4. CI/CD Infra Steps — Location Consistency

The CI/CD infrastructure setup steps were moved from docs/implementation/ to docs/automation/01-cicd-infra/. Verify:

  • All CI/CD infra steps are present in docs/automation/01-cicd-infra/ (not split across locations)
  • docs/implementation/01-cicd-infra/ correctly cross-references docs/automation/01-cicd-infra/ if it still exists there
  • The corresponding deploy scripts in scripts/deploy/01-cicd-infra/ are mapped to the correct docs section
  • No duplicate or conflicting guidance exists between docs/implementation/ and docs/automation/

5. Navigation and Cross-Links

  • Does the automation section link from the implementation guide where appropriate?
  • Is the automation section properly represented in the Docusaurus sidebar?

Deliverables

  • Audit comment listing current state of each automation doc (complete vs. stub vs. missing)
  • Proposed new structure / table of contents agreed upon
  • All stub pages either fleshed out or explicitly marked with :::info Under Construction
  • CI/CD section location issue resolved — single source of truth
  • aztoolkit src/ automation content documented in the appropriate guides
  • npm run build passes with no broken links

References

  • docs/automation/ — current automation docs section
  • docs/implementation/01-cicd-infra/ — original CI/CD infra location (verify state)
  • azurelocal-toolkit/scripts/deploy/01-cicd-infra/ — corresponding deploy scripts
  • azurelocal-toolkit/src/ — Bicep, Ansible, Terraform automation source

Metadata

Metadata

Assignees

No one assigned

    Labels

    ado-trackedIssue has a linked ADO work item

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions