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
Share this Lab

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

Unlock full access to TeKanAid courses, labs, and bootcamps

Buying for a team? Private corporate training is available for up to 15 learners.View team training
MonthlyQuarterly
Try Premium free for 7 days →

Just exploring? Start free below. Want the full experience? Try Premium free for 7 days (card required, $0 today).

Pro

All courses, with lab scripts to run on your own machine

$59/month

Renews automatically. Cancel anytime.

Final price verified at checkout.

  • Full access to all courses
  • Lab scripts to download and run on your own machine (hosted labs not included)
  • Progress tracking
  • Certificate of completion
  • Community access
  • Bootcamp participation
  • New content access
Recommended

Premium

Full access, including unlimited hosted labs

$99/month

Renews automatically. Cancel anytime.

Final price verified at checkout.

  • Everything in Pro
  • Unlimited hands-on labs, fully hosted on TeKanAid Academy (nothing to set up)
  • Lab AI Assistant
  • Accelerator bootcamps with live office hours
  • Priority support

Prefer a single course?

Purchase individual courses for a one-time fee of $79. Full access to course content, quizzes, certificates, and community features, lab access is not included.

Browse Courses

Just exploring? Start free, no account needed

Three free ways to start. All bridge into the paid Premium catalog when you're ready.

Not ready to commit? The crash course is email-only. No academy account required.

Ready to Get Started?

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

Get Access Now