search

hashicorp / terraform

Terraform enables you to safely and predictably create, change, and improve infrastructure. It is a source-available tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned.
https://www.terraform.io/
Other
41.66k stars 9.41k forks source link

Documentation: clarify `-refresh-only` behavior for apply vs plan commands #31891

Open joe-a-t opened 1 year ago

joe-a-t commented 1 year ago

Terraform Version

1.3.X

Use Cases

Trying to understand the difference of using the -refresh-only with the plan vs apply commands

Attempted Solutions

N/A

Proposal

Update the following links to explain that using the -refresh-only option with terraform plan does not result in writing to the actual state file, people have to use terraform apply in order for the saved state file to be updated.

It would also be good to talk about terraform apply -refresh-only directly on https://www.terraform.io/cli/commands/apply instead of having to go to the bottom of the https://www.terraform.io/cli/commands/apply#apply-options section and click on a link to another page.

References

No response

joe-a-t commented 1 year ago

cc @laurapacilio

ishwar-amzn commented 1 year ago

@joe-a-t I would like to work on this issue, can I start working on the same?

joe-a-t commented 1 year ago

🤷‍♂️ in my experience HashiCorp tends to only like their own people updating the main docs (or really putting in almost any PRs other than simple typo fixes) which is why I didn't PR the changes myself but feel free if you want to take a stab, this issue has been open a long time and maybe you'll have more luck than I have in the past.

crw commented 1 year ago

@joe-a-t we have been receiving a lot of similarly-worded requests to "work on issues," I'm not entirely sure what is behind it but probably safe to ignore. With regards to accepting docs changes, from my vantage point we frequently accept docs changes beyond simple corrections (although those are much easier to review). That said, @laurapacilio is no longer at HashiCorp (on to bigger and better things!) and the queue is a bit backlogged. Apologies if you were on the receiving end of a docs change that did not get merged for whatever reason.

crw commented 1 year ago

@ishwar-amzn The best way to get started contributing to Terraform is to pick up issues at https://github.com/hashicorp/terraform-provider-aws/ - they are very open to first-time contributions. AWS also seems to be directly in your wheelhouse! Best of luck.