This directory contains the portions of the OpenTofu website that pertain to the core functionality, excluding providers and the overall configuration.
You can start a local development server with Docker by running the following command from this (the website
) directory:
docker compose up --build
The development server will be available on http://localhost:3000/ .
You can submit an issue with documentation requests or submit a pull request with suggested changes.
Click Edit this page at the bottom of any OpenTofu website page to go directly to the associated markdown file in GitHub.
You must update the sidebar navigation when you add or delete documentation .mdx files. If you do not update the navigation, the website deploy preview fails.
To update the sidebar navigation, you must edit the appropriate nav-data.json
file. This repository contains the sidebar navigation files for the following documentation sets:
- OpenTofu Language:
language-nav-data.json
- OpenTofu CLI:
cli-nav-data.json
- Introduction to OpenTofu:
intro-nav-data.json
Currently, you can preview your changes through the opentofu/opentofu.org repository.
Follow the Getting Started guide.