Skip to main content

Comprehensive Terraform Documentation and Enhanced Help System

· 2 min read
Erik Osterman
Erik Osterman
Founder @ Cloud Posse

This release brings documentation improvements to Atmos, making it easier to understand and use Terraform commands. We've focused on comprehensive command documentation and automated screengrab generation.

Complete Terraform Command Documentation​

We've added comprehensive documentation for all Terraform commands integrated with Atmos. Each command now includes:

  • Detailed usage examples with real-world scenarios
  • Complete flag reference with descriptions and defaults
  • Atmos-specific behavior explanations
  • Visual screengrabs showing actual CLI output
  • Backend configuration details and limitations

Key additions include:

  • Terraform planfile workflow documentation with security considerations
  • All Terraform subcommands (plan, apply, destroy, validate, fmt, output, etc.)
  • Best practices for using Terraform with Atmos.

View Terraform Documentation

Screengrab Generation Infrastructure​

We've built a complete system for generating accurate, up-to-date CLI help screengrabs:

  • Automated generation - All help screengrabs generated from actual CLI output
  • Color preservation - ANSI colors converted to HTML for documentation
  • Docker/Podman support - Cross-platform screengrab generation
  • CI/CD integration - GitHub Actions workflow for automatic updates

This ensures our documentation always reflects the actual CLI behavior.

Documentation Fixes​

Numerous documentation improvements including:

  • Fixed broken links across the documentation site
  • Corrected Terraform command examples
  • Updated helmfile sync description to accurately reflect behavior
  • Added security warnings for credential handling in planfiles
  • Improved Markdown formatting consistency

Contributors​

This release includes contributions from the Atmos team and community. Thank you to everyone who provided feedback, reported issues, and contributed code!

For the complete list of changes, see the GitHub release notes.

Have questions or feedback? Join us on Slack or open an issue on GitHub.