terraform/website
Martin Atkins b802237e03 plans: Track an optional extra "reason" for some planned actions
Previously we were repeating some logic in the UI layer in order to
recover relevant additional context about a change to report to a user.
In order to help keep things consistent, and to have a clearer path for
adding more such things in the future, here we capture this user-facing
idea of an "action reason" within the plan model, and then use that
directly in order to decide how to describe the change to the user.

For the moment the "tainted" situation is the only one that gets a special
message, matching what we had before, but we can expand on this in future
in order to give better feedback about the other replace situations too.

This also preemptively includes the "replacing by request" reason, which
is currently not reachable but will be used in the near future as part of
implementing the -replace=... plan command line option to allow forcing
a particular object to be replaced.

So far we don't have any special reasons for anything other than replacing,
which makes sense because replacing is the only one that is in a sense
a special case of another action (Update), but this could expand to
other kinds of reasons in the future, such as explaining which of the
few different reasons a data source read might be deferred until the
apply step.
2021-04-29 17:50:46 -07:00
..
docs plans: Track an optional extra "reason" for some planned actions 2021-04-29 17:50:46 -07:00
guides update to match new default branch name (#27909) 2021-02-24 13:36:47 -05:00
intro website: Update links to redirected provider docs pages 2020-12-17 12:23:50 -08:00
layouts website: Link to the v0.15 upgrade guide 2021-04-15 10:17:02 -07:00
upgrade-guides website: v0.15 upgrade guide had invalid example for tomap(...) 2021-04-19 10:20:03 -07:00
README.md website: A note about where the root parts of the website live now 2017-06-27 14:40:13 -07:00

README.md

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.