opentofu.org/README.md

Stack

• Docusaurus
• React
• TypeScript
• Tailwind CSS

Cloning the repository

This repository uses Git submodules to pull in the main OpenTofu repository.

git clone --recurse-submodules git@github.com:opentofu/opentofu.org.git

Oops! I forgot to recurse submodules…

cd opentofu.org
git submodule init
git submodule update

Development

You can either develop locally, or by using a local Docker container.

Option A: Running the dev server locally

You can run the dev server if you have a local Node.js/npm environment installed:

1. Install dependencies:

   npm install
   

2. Start the development server:

   npm run start
   

3. You can now access the site locally at http://localhost:3000.

Option A: Running the dev server in a container

You can run the dev server in a Docker container with the following command:

docker compose up --build

Troubleshooting

The docs folder does not exist for version "vX.Y"

Error: The docs folder does not exist for version "vX.Y". A docs folder is expected to be found at versioned_docs/version-vX.Y.

Make sure you installed the Git submodules. See above for instructions.

Contributing

When you contribute code to OpenTofu, do not forget to sign off your commits as described here.