116826c32f
As of go-getter v1.8.0, which we already upgraded in an earlier commit, the S3 "getter" now uses the AWS SDK's default credentials chain configuration and so follows the same set of credentials-searching strategies that AWS CLI and other AWS SDK applications would follow. We learned this only after having already merged that upgrade, so this is a retroactive documentation and changelog update to describe the change. Since go-getter is now delegating this whole question to the AWS SDK, our future upgrades of the AWS SDK will automatically adopt any upstream changes to the default credentials chain and so our documentation about this is now more general than before: the intention is that our users can generally assume that OpenTofu should support everything that is documented as supported for the AWS CLI, instead of us listing out an explicit search sequence that will be long and inevitably become outdated again. 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.