LABBEGINNER

TechDocs Setup

Set up TechDocs for documentation-as-code workflows with MkDocs integration and automated publishing

180 minutes
developer-experience/backstage
TechDocs Setup - Platform Engineering Hands-On Lab Icon

Lab Overview

Configure TechDocs to enable documentation-as-code workflows in Backstage. Learn to integrate MkDocs, set up storage backends, and create documentation that automatically publishes with your services.

You'll learn to:

  • Configure TechDocs in Backstage for documentation publishing
  • Set up the TechDocs backend with local storage
  • Install and configure MkDocs with Material theme
  • Create documentation sites with proper structure and navigation
  • Integrate documentation with catalog entities
  • Test documentation publishing and validation workflows
  • Establish docs-as-code practices and templates

This hands-on lab establishes documentation workflows that integrate seamlessly with your developer portal.

Key Resources:

Prerequisites

backstage-local-setup

markdown-fundamentals

python-basics

Technologies Covered

backstagetechdocsdocumentationmkdocsdocs-as-code

Part of a Course

This lab is part of the Backstage 101: Internal Developer Portal Fundamentals course

View All Courses

Choose your plan

Simple, Transparent Pricing

One price, everything included

Monthly Plan

Access all content

$99/month
Save 16%

Quarterly Plan

Save 16% with quarterly billing

$249/quarter

Everything Included in Your Subscription

Content & Learning

  • Access to all courses and bootcamps
  • Video lessons with closed captions
  • Interactive quizzes and assessments
  • Course completion certificates

Hands-On Labs

  • Browser-based cloud labs
  • Pre-configured VMs ready to use
  • Playgrounds for experiments
  • Multi-VM realistic scenarios

AWS Integration

  • Managed AWS Account included
  • Pre-configured environments
  • Real-world cloud scenarios

Support & Community

  • Priority support
  • Active community forum

No Setup Required

  • Everything runs in your browser
  • No software installation needed
  • Automatic environment provisioning
  • Works on any device

Ready to Get Started?

Start this hands-on lab and build real-world Platform Engineering skills

Get Access Now