-
Notifications
You must be signed in to change notification settings - Fork 9.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
website: Reworking of the "terraform plan" docs, and related pages #28570
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I left a few minor suggestions, some of which are more subjective than others; I won't be offended if you opt to ignore any of those.
It's been a long time since we gave this page an overhaul, and with our ongoing efforts to make plan and apply incorporate all of the side-effects that might need to be done against a configuration it seems like a good time for some restructuring in that vein. The starting idea here is to formally split the many "terraform plan" options into a few different categories: - Planning modes - Planning options - Other options The planning modes and options are the subset that are also accepted by "terraform apply" when it's running in its default mode of generating a plan and then prompting for interactive approval of it. This then allows us to avoid duplicating all of that information on the "terraform apply" page, and thus allows us to spend more words discussing each of them. This set of docs is intended as a fresh start into which we'll be able to more surgically add in the information about -refresh-only and -replace=... once we have those implemented. Consequently there are some parts of this which may seem a little overwraught for what it's currently describing; that's a result of my having prepared this by just deleting the -refresh-only and -replace=... content from our initial docs draft and submitted the result, in anticipation of re-adding the parts I've deleted here in the very near future in other commits.
b11427e
to
ce0bae5
Compare
Thanks for catching all of those, @mildwonkey! Unless I left a comment saying otherwise, I incorporated exactly what you proposed in the revised version that I'm about to merge. |
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
It's been a long time since we gave this page an overhaul, and with our ongoing efforts to make plan and apply incorporate all of the side-effects that might need to be done against a configuration it seems like a good time for some restructuring in that vein.
The starting idea here is to formally split the many "terraform plan" options into a few different categories:
The planning modes and options are the subset that are also accepted by
terraform apply
when it's running in its default mode of generating a plan and then prompting for interactive approval of it. This then allows us to avoid duplicating all of that information on theterraform apply
page, and thus allows us to spend more words discussing each of them.This set of docs is intended as a fresh start into which we'll be able to more surgically add in the information about
-refresh-only
and-replace=...
once we have those implemented. Consequently there are some parts of this which may seem a little overwrought for what it's currently describing; that's a result of my having prepared this by just deleting the-refresh-only
and-replace=...
content from our initial docs draft and submitted the result, in anticipation of re-adding the parts I've deleted here in the very near future in other commits.This does include some additions that catch up with some changes in #28489 that weren't documented yet:
terraform apply -destroy
is now a thing, for symmetry withterraform plan -destroy
and later on both with-refresh-only
.-help
output for various commands changed to match with the restructuring I made to the docs here, whereterraform apply -help
is more explicit that it's effectively runningterraform plan
internally and so to go look at the plan docs for information on modes and options.