Skip to content

Repository Map

This page maps the Azure Functions Practical Guide structure so you can navigate quickly from onboarding to production operations.

It also links the external DX toolkit repositories used with this guide.

Top-level navigation model

The documentation follows seven intent-based areas:

  1. Start Here — onboarding and plan selection
  2. Platform — architecture and hosting decisions
  3. Best Practices — production patterns and anti-patterns
  4. Language Guides — implementation details by language
  5. Operations — day-2 operational runbooks
  6. Troubleshooting — incident response and diagnostics
  7. Reference — quick lookup for commands, limits, and configuration

This structure aligns with the top-level sections in mkdocs.yml; some topics (such as networking, reliability, and security) are grouped under section index pages instead of appearing as separate top-level tabs.

flowchart TD
    R[Repository] --> S1[Start Here]
    R --> S2[Platform]
    R --> S3[Best Practices]
    R --> S4[Language Guides]
    R --> S5[Operations]
    R --> S6[Troubleshooting]
    R --> S7[Reference]

Section map

Area What you do there Primary entry
Start Here Learn fundamentals, choose track, choose plan Start Here
Platform Understand host/worker model, scaling, networking, reliability, security Platform Index
Best Practices Apply production-ready patterns and avoid anti-patterns Best Practices Index
Language Guides Build function apps using language-specific programming models Language Guides Index
Operations Deploy safely, configure correctly, monitor, alert, recover Operations Index
Troubleshooting Triage and resolve incidents with repeatable methodology Troubleshooting Index
Reference Quickly look up CLI commands, limits, and host/runtime settings Reference Index

Start Here pages

Platform pages (design decisions)

Read order for architects

Start with Architecture, then Hosting, Scaling, and Networking before implementation kickoff.

Language guides

Current primary language scope:

  • Python
  • Node.js
  • .NET
  • Java

Python currently contains the most complete tutorial and recipe depth in this guide.

Entry points:

Operations and troubleshooting

Operations content covers deployment through recovery. Troubleshooting content is optimized for incident timelines.

Start with:

Incident response

Pair Monitoring with the query workflow in Troubleshooting Index to reduce mean time to diagnosis.

DX toolkit repositories

These repositories are linked resources, not vendored into this guide.

Repository Purpose
azure-functions-openapi OpenAPI integration patterns
azure-functions-validation Input and contract validation utilities
azure-functions-doctor Diagnostics and health-check tooling
azure-functions-scaffold Project bootstrap and scaffolding
azure-functions-logging Structured logging conventions
azure-functions-python-cookbook Python recipes and practical patterns

Suggested navigation patterns

New team onboarding

  1. Overview
  2. Learning Paths
  3. Hosting Options
  4. Language Guides

Architecture first

  1. Platform Index
  2. Hosting Plans
  3. Scaling
  4. Networking guidance in Platform Index

Operations first

  1. Operations Index
  2. Monitoring
  3. Alerts
  4. Recovery guidance in Operations Index

See Also

Sources