Terraforge
  • Welcome to Terraforge!
  • Features
  • How it works
  • HashiCorp Meetup Slides
  • Demos & Tutorials
    • First Steps
      • 1 - Tutorial Environment
      • 2 - Terraform Stack (local_file)
        • 2.1 - Source Code Editor
        • 2.2 - Terraform validate & plan
        • 2.3 - README
      • 3 - Pipeline Apply
    • AWS Stack (simple)
      • 1 - Terraform user
      • 2 - Sandbox Environment
      • 3 - Terraform Stack (ECR registry)
        • 3.1 - Terraform Code
        • 3.2 Terraform validate & plan
      • 4 - Pipeline Apply
      • 5 - Pipeline Destroy
Powered by GitBook
On this page

Was this helpful?

  1. Demos & Tutorials
  2. First Steps
  3. 2 - Terraform Stack (local_file)

2.3 - README

Goal: Use markdown to document your stack

Previous2.2 - Terraform validate & planNext3 - Pipeline Apply

Last updated 5 years ago

Was this helpful?

Steps

  1. Switch to the README tab

  2. Click on EDIT

  3. Write documentation for this stack: # Purpose This stack creates a text-file using the Terraform local provider

  4. Click SAVE

The README can be used to document the architecture and configuration of a Terraform stack.