6de74668d5
We inherited this "compatibility promises" document from our predecessor as part of the fork, but have now come to realize that the specific set of platforms it committed to support had become quite stale over time: macOS support for x64 is phasing out in favor of Apple Silicon, and 32-bit CPU architectures are no longer commonly used. In preparation for some anticipated future changes to platform support, this revises the "Supported Platforms" section of our compatibility promises so that it no longer commits to any specific platforms and instead documents that we intend to provide two minor release period's worth of advance notice for removing support for any platform that is currently supported. This is a more sustainable compromise that will allow us to respond to ongoing changes in which platforms are commonly used in our community, and which platforms are supported well by the dependencies that OpenTofu relies on. This also proactively switches from listing darwin_amd64 to darwin_arm64 and removes the commitment to support linux_arm. We do not intend to immediately stop testing on and building for those two platforms, but we do expect to phasing them out under the revised version of this policy in future releases and so this update serves as part of our initial communication about that future change. Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
OpenTofu Documentation
This directory contains the portions of the OpenTofu website that pertain to the core functionality, excluding providers and the overall configuration.
Development server
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/docs/main/ .
Under Docs in the navigation bar, select Development version to see local changes.
Suggesting Changes
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.
Modifying Sidebar Navigation
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
Previewing Changes
Currently, you can preview your changes through the opentofu/opentofu.org repository.
Follow the Getting Started guide.
Copyright headers for code examples
In order to not include copyright headers for code examples used in docs, please, add the files under examples folder. This way, it will be ignored on automated copyright headers check.