4cffff24b1
We have two different reasons why a data resource might be read only during apply, rather than during planning as usual: the configuration contains unknown values, or the data resource as a whole depends on a managed resource which itself has a change pending. However, we didn't previously distinguish these two in a way that allowed the UI to describe the difference, and so we confusingly reported both as "config refers to values not yet known", which in turn led to a number of reasonable questions about why Terraform was claiming that but then immediately below showing the configuration entirely known. Now we'll use our existing "ActionReason" mechanism to tell the UI layer which of the two reasons applies to a particular data resource instance. The "dependency pending" situation tends to happen in conjunction with "config unknown", so we'll prefer to refer that the configuration is unknown if both are true. |
||
|---|---|---|
| .. | ||
| data | ||
| docs | ||
| img/docs | ||
| layouts | ||
| scripts | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| vercel.json | ||
Terraform Documentation
This directory contains the portions of the Terraform website that pertain to the core functionality, excluding providers and the overall configuration.
The files in this directory are intended to be used in conjunction with
the terraform-website repository, which brings all of the
different documentation sources together and contains the scripts for testing and building the site as
a whole.
Modifying Sidebar Navigation
Updates to the sidebar navigation of Terraform docs need to be made in the terraform-website repository (preferrably in a PR also updating the submodule commit). You can read more about how to make modifications to the navigation in the README for terraform-website.
Previewing Changes
You should preview all of your changes locally before creating a pull request. The build includes content from this repository and the terraform-website repository, allowing you to preview the entire Terraform documentation site.
Set Up Local Environment
- Install Docker.
- Restart your terminal or command line session.
Launch Site Locally
- Navigate into your local
terraformtop-level directory and runmake website. - Open
http://localhost:3000in your web browser. While the preview is running, you can edit pages and Next.js will automatically rebuild them. - When you're done with the preview, press
ctrl-Cin your terminal to stop the server.
Deploying Changes
Merge the PR to main. The changes will appear in the next major Terraform release.
If you need your changes to be deployed sooner, cherry-pick them to:
- the current release branch (e.g.
v1.1) and push. They will be deployed in the next minor version release (once every two weeks). - the
stable-websitebranch and push. They will be included in the next site deploy (see below). Note that the release process resetsstable-websiteto match the release tag, removing any additional commits. So, we recommend always cherry-picking to the version branch first and then tostable-websitewhen needed.
Once your PR to stable-website is merged, open a PR bumping the submodule commit in terraform-website.
Deployment
New commits in hashicorp/terraform and hashicorp/terraform-cdk don't automatically deploy the site. To use the latest upstream content, you'll need to open a PR bumping the submodule commit. If your changes aren't being deployed, it's very likely that you need to open a PR to update the submodule commit.