Skip to content

Migrate tutorials into main docs structure #16254

@CamSoper

Description

@CamSoper

Problem

Currently, tutorials live in a separate /tutorials/ area of the site, disconnected from the main documentation structure. This makes them harder to discover and creates an artificial separation between learning resources and reference/guide content.

Proposal

Integrate all tutorials into the main docs structure as top-level product submenus. Each product (IaC, ESC, Platform) will have a "Tutorials" section at the same level as "Concepts" and "Guides", making all tutorials easily discoverable in the unified navigation.

For IaC, which has 23 tutorials, we'll organize them into logical subgroups.

New Structure

IaC Tutorials (23 total)

Location: /docs/iac/tutorials/

Getting Started (4 tutorials)

Cloud-specific introductory tutorials:

  • Creating Resources on AWS/docs/iac/tutorials/getting-started/aws-creating-resources/
  • Creating Resources on Azure/docs/iac/tutorials/getting-started/azure-creating-resources/
  • Creating Resources on GCP/docs/iac/tutorials/getting-started/gcp-creating-resources/
  • Creating Resources on Kubernetes/docs/iac/tutorials/getting-started/kubernetes-creating-resources/

Fundamentals (4 tutorials)

Core learning path - sequential tutorials:

  • Pulumi Fundamentals/docs/iac/tutorials/fundamentals/pulumi-fundamentals/
  • Building with Pulumi/docs/iac/tutorials/fundamentals/building-with-pulumi/
  • Abstraction and Encapsulation/docs/iac/tutorials/fundamentals/abstraction-encapsulation/
  • Embedding Pulumi/docs/iac/tutorials/fundamentals/embedding-pulumi/

Stacks & Configuration (7 tutorials)

Working with stacks, outputs, and secrets:

  • Stack Outputs/Refs - AWS/docs/iac/tutorials/stacks-and-config/stack-outputs-refs-aws/
  • Stack Outputs/Refs - Azure/docs/iac/tutorials/stacks-and-config/stack-outputs-refs-azure/
  • Stack Outputs/Refs - GCP/docs/iac/tutorials/stacks-and-config/stack-outputs-refs-gcp/
  • Move Resources Between Stacks/docs/iac/tutorials/stacks-and-config/move-resources-between-stacks/
  • Managing Configuration and Secrets/docs/iac/tutorials/stacks-and-config/managing-config-and-secrets/
  • Inspecting Infrastructure/docs/iac/tutorials/stacks-and-config/inspecting-infrastructure/
  • Drift Detection and Remediation/docs/iac/tutorials/stacks-and-config/drift-detection/

Migration (4 tutorials)

Importing existing infrastructure:

  • Importing AWS Infrastructure/docs/iac/tutorials/migration/importing-aws/
  • Importing Azure Infrastructure/docs/iac/tutorials/migration/importing-azure/
  • Importing GCP Infrastructure/docs/iac/tutorials/migration/importing-gcp/
  • Evaluate Compliance of Terraform Resources/docs/iac/tutorials/migration/evaluate-terraform-compliance/

Kubernetes (2 tutorials)

Kubernetes-specific workflows:

  • Kubernetes Helm Part One/docs/iac/tutorials/kubernetes/helm-release/
  • Kubernetes Helm Part Two/docs/iac/tutorials/kubernetes/helm-chart/

Policy (1 tutorial)

Compliance and security:

  • Custom Policy Pack/docs/iac/tutorials/policy/custom-policy-pack/

CLI (1 tutorial)

Command-line workflows:

  • CLI Authentication/docs/iac/tutorials/cli/authentication/

ESC Tutorials (7 total)

Location: /docs/esc/tutorials/

  • ESC + GitHub Actions/docs/esc/tutorials/github-actions-oidc/
  • ESC External Secrets Operator/docs/esc/tutorials/external-secrets-operator/
  • ESC Managed ChatApp/docs/esc/tutorials/chatapp-managed-secrets/
  • ESC Secret Store CSI Driver/docs/esc/tutorials/secret-store-csi-driver/
  • ESC Setup PSP Creds/docs/esc/tutorials/pulumi-service-provider/
  • ESC Version Tagging/docs/esc/tutorials/version-tagging/
  • Secure Kubernetes App Secrets/docs/esc/tutorials/kubernetes-app-secrets/

Platform Tutorials (1 total)

Location: /docs/platform/tutorials/

  • Pulumi Deployments Click-to-Deploy/docs/platform/tutorials/deployments/click-to-deploy/

Glossary (special case)

  • Glossary/docs/reference/glossary/ or /docs/glossary/

Note: The glossary isn't a tutorial - it's reference material and should be treated separately.


Menu Structure

Each product area will have a top-level "Tutorials" menu item:

IaC
├─ Tutorials
│  ├─ Getting Started
│  ├─ Fundamentals
│  ├─ Stacks & Configuration
│  ├─ Migration
│  ├─ Kubernetes
│  ├─ Policy
│  └─ CLI
├─ Concepts
├─ Guides
└─ Clouds

ESC
├─ Tutorials
├─ Concepts
└─ Guides

Platform
├─ Tutorials
└─ [other Platform sections]

Migration Requirements

  1. Preserve SEO: All current /tutorials/* paths need aliases in frontmatter
  2. Update menus: Add "Tutorials" as top-level menu item in each product area
  3. Update internal links: Links to tutorials from other docs need updating
  4. Verify no broken links: Test all tutorial navigation after migration

Benefits

  • Highly discoverable: Tutorials are top-level menu items, not buried in subsections
  • Unified navigation: Tutorials appear alongside concepts/guides at the same hierarchy level
  • Clearer organization: Sub-grouping within IaC tutorials creates logical learning paths
  • Consistent "one Pulumi platform" story: Each product has the same structure (Tutorials/Concepts/Guides)
  • Scalable: Easy to add new tutorials to appropriate categories

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions