georgewshen / documentation

Docs about terraform-ibm-modules processes, concepts, and tasks. Start here.

IBM Cloud Terraform modules documentation

The IBM Cloud® Terraform modules project is a collection of curated IBM Cloud Terraform modules to help you build, update, and version complex and compliant environments that you can deploy in IBM Cloud. The goal of this project is to share useful infrastructure as code (IaC) and automation assets and support collaboration with them.

Project documentation

You can see the published documentation at https://terraform-ibm-modules.github.io/documentation/.

Table of contents

• Getting started
  • About IBM Cloud Terraform modules
• Contributing modules
  • Local development setup
  • Regular developer tasks
  • Contributing modules
  • Porting an older module
  • Validation tests
  • GitHub Actions workflows
• Adding your module to IBM Cloud
• Maintaining the GitHub project
  • Maintainers contribution process
  • About merging pull requests
• Reference
  • Module authoring guidelines
  • Design guidelines
  • Module structure
  • Metadata file (index.yml)
  • About module badges
  • Release versioning
  • Governance
• Troubleshooting
  • Known issues
  • How do I address errors when I run tests?
  • Report and issue or request a feature
  • Communities
• Contributing to the docs

Contributing to the project

See the Contributing guide.

❗ Important: By contributing content, you agree to allow the project owner to license your work under the same license as that used by the project.

Reporting a bug or suggesting a feature

See Report an issue or request a feature.