Commit Graph

305 Commits

Author SHA1 Message Date
Laura Pacilio 821064edd3
Merge pull request #30637 from kderck/patch-2
Change aws.dest to aws.dst
2022-03-10 18:08:29 -05:00
Kyle Davies 0ea6874bc1
Change aws.dest to aws.dst
Documentation is wrong the `configuration_aliases` should be `[ aws.src, aws.dst ]` not `[ aws.src, aws.dest ]`.
2022-03-09 20:26:10 +00:00
savage-tm d6a98ac22b
Document logical operators not short-circuiting
Including a note about logical operators not short-circuiting will make the documentation clearer and more useful. https://github.com/hashicorp/terraform/issues/24128 includes examples of people being caught out by this lack of clarity.
2022-03-09 17:10:06 +13:00
Alisdair McDiarmid f21d0e8bf6 website: Update docs for check rule error messages 2022-03-04 15:39:31 -05:00
Laura Pacilio ad1ba5ef12 fix broken link on provisioners connection page 2022-02-24 18:15:05 -05:00
Drew Hodun a26b551d47 added github.com commit reference example 2022-02-22 11:09:22 -05:00
Laura Pacilio 68e70d71d4
Merge pull request #30483 from bpar476/patch-1
Adds documentation to `substr` function to cover when `length` exceeds input length
2022-02-15 11:27:47 -05:00
Ben Partridge 252865c6a0
Improvements to wording of substr function documentation
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-02-15 10:23:37 +11:00
Alisdair McDiarmid 0a9503812d
Merge pull request #30476 from hashicorp/alisdair/fix-type-marks
cli: Prevent complex uses of the console-only `type` function
2022-02-10 10:23:07 -05:00
Alisdair McDiarmid 98f80bc5da website: Explain limitations of type function 2022-02-10 06:12:58 -05:00
Laura Pacilio 24cffb5ff3 Soften language for determining run environment 2022-02-09 17:41:12 -05:00
Laura Pacilio 422b47618c Change name example to match new edits 2022-02-09 17:37:06 -05:00
Laura Pacilio 8be2c4a397 fix link 2022-02-09 14:30:02 -05:00
Laura Pacilio faffa11e08 Update workspaces page 2022-02-09 14:21:46 -05:00
Laura Pacilio ba0e2c1133 Update remote backend page to clarify workspace.name expression 2022-02-09 14:10:11 -05:00
Craig Wright 3af6e82463
Merge pull request #30485 from salob/patch-1
Removing unnecessary comma from a single entry list example.
2022-02-08 11:59:44 -08:00
Laura Pacilio 7eee8c674e Remove extra spaces 2022-02-07 18:16:16 -05:00
Laura Pacilio 879edcae72 wording changes 2022-02-07 18:09:07 -05:00
sian d81335a55e
delete comma from single entry list 2022-02-07 18:12:26 +00:00
Laura Pacilio 6e399dfbe0 Update filename 2022-02-07 12:04:50 -05:00
Laura Pacilio 834f65e4f0 Fix formatting issues that would prevent website from loading 2022-02-07 11:59:28 -05:00
Ben Partridge fa8a87fab5
Adds documentation to `substr` function to cover when `length` longer than input `string`
The `substr` function allows the `length` parameter to be longer than the remaining characters in the input after the offset. This is useful for when you want to truncate a string to a maximum number of characters. However, the documentation isn't clear on this so I had to do a test deployment to confirm the behaviour after finding the behaviour in an old issue https://github.com/hashicorp/terraform/issues/15751
2022-02-07 15:12:22 +11:00
Martin Atkins f1b7f12f1c website: Initial draft docs for Preconditions and Postconditions 2022-01-31 14:02:53 -05:00
Craig Wright ca02b55fba
Merge pull request #30409 from tyron/fix-module-outputs-reference
Fix reference to child module in outputs docs
2022-01-26 15:47:42 -08:00
Laura Pacilio 9e28fc44cd
Merge branch 'main' into fix-remote-backend-references 2022-01-26 11:47:19 -05:00
Laura Pacilio 53aa84576f
Update website/docs/language/state/remote-state-data.mdx
Co-authored-by: Nick Fagerlund <nick.fagerlund@gmail.com>
2022-01-26 11:43:16 -05:00
Laura Pacilio 1b1b5225a2
Update website/docs/language/state/remote-state-data.mdx
Co-authored-by: Nick Fagerlund <nick.fagerlund@gmail.com>
2022-01-26 11:42:22 -05:00
Tyron 322622a0f4
fix reference to module
References to child modules should use the resource name, not their path
2022-01-25 20:54:20 -05:00
Laura Pacilio 9953260083
Merge pull request #30296 from hashicorp/fix-provisioners-content
Fix provisioners content
2022-01-24 13:49:28 -05:00
Laura Pacilio 20e740ef88 Final formatting and langauge nits 2022-01-21 11:01:37 -05:00
Laura Pacilio 9f4c4ff093 Update note to be more direct :) 2022-01-21 10:48:27 -05:00
Laura Pacilio 1d53273b7a Language nits 2022-01-20 11:28:52 -05:00
Laura Pacilio 29a4591cf2 Fix warning notes 2022-01-20 10:57:38 -05:00
GiannakopoulosJ 13907690a2
Typo in zipmap documentation
zipmap does not produce a map with comma in terraform cli
tested with Terraform v1.1.3
2022-01-19 16:02:24 +02:00
Laura Pacilio ec17cbaeee update additional references to overview page 2022-01-18 14:25:28 -08:00
Laura Pacilio 20e9f30c3d formatting nits 2022-01-18 14:25:28 -08:00
Laura Pacilio 63106da0b9 Language updates 2022-01-18 14:25:28 -08:00
Laura Pacilio fc4ceedc6d Remove overview page and update notes on provisioner pages 2022-01-18 14:07:40 -08:00
Laura Pacilio 1b7e7b967d Fix broken links to external docs 2022-01-10 17:49:49 -05:00
Laura Pacilio f4eb0ed24d
Merge pull request #30280 from Mukesh05/patch-2
Update local values definition
2022-01-07 10:22:57 -05:00
Mukesh Kumar 3ac334f267
Update website/docs/language/values/locals.mdx
Thank you. Your suggestion to use "instead of" makes the sentence even more easy to understand.

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-01-07 05:52:12 +05:30
Martin Atkins 087c2f06ee website: Documentation of how provisioners upload files
We recently made a change to how provisioners upload files in order to
address an unintended remote code execution vector when using SSH, which
revealed that we had not previously documented well enough the expected
contract for how provisioners upload files to remote systems, and so some
users were depending on unintended consequences of the the bug now fixed.

We are retaining the fix on security-related grounds, but this is a good
prompt to be clearer in the docs about what exactly Terraform is doing
when asked to upload files over SSH and WinRM, so users can understand
what is supported and write their configurations accordingly.

This also includes an additional section to the v1.1 upgrade guide, since
we apparently neglected to document this intentional breaking change in
the first draft of that page.

Of course, provisioners as a whole remain a last resort, and so we're
documenting this as hopefully a helpful aid to those who have no other
option, and not meaning in any way to recommend their use for any new
use-cases.
2022-01-06 13:04:55 -08:00
Laura Pacilio 870116c509 more langauge edits 2022-01-06 11:48:13 -05:00
Laura Pacilio fbf02d6342 Language edits 2022-01-06 11:46:08 -05:00
Laura Pacilio 6ef9cf652e
Merge pull request #30270 from addison-grant/patch-1
Update variables.mdx to fix typo
2022-01-06 11:14:46 -05:00
Laura Pacilio 8b69d24147 Update remote state data source page 2022-01-04 16:31:52 -05:00
Martin Atkins 74761b2f8b getmodules: Use go-getter v1.5.10 and return to upstream GitGetter
There was an unintended regression in go-getter v1.5.9's GitGetter which
caused us to temporarily fork that particular getter into Terraform to
expedite a fix. However, upstream v1.5.10 now includes a
functionally-equivalent fix and so we can heal that fork by upgrading.

We'd also neglected to update the Module Sources docs when upgrading to
go-getter v1.5.9 originally and so we were missing documentation about the
new "depth" argument to enable shadow cloning, which I've added
retroactively here along with documenting its restriction of only
supporting named refs.

This new go-getter release also introduces a new credentials-passing
method for the Google Cloud Storage getter, and so we must incorporate
that into the Terraform-level documentation about module sources.
2022-01-03 11:44:16 -08:00
Mukesh Kumar 27cc49fe91
Update local values definition
The definition of local values used "it" many times, making the sentence not very clear.
2022-01-01 20:35:47 +05:30
Addison Grant 01be55b5c4
Update variables.mdx
Remove extraneous word "from" in "...use a sensitive value from as part of an..."
2021-12-27 10:25:31 -08:00
Martin Atkins e35c25da44 website: Try function documentation "provably" vs "probably" typo
This paragraph is trying to say that try only works for dynamic errors and
not for errors that are _not_ based on dynamic decision-making in
expressions.

I'm not sure if this typo was always here or if it was mistakenly "corrected"
at some point, but either way the word "probably" changes the meaning
of this sentence entirely, making it seem like Terraform is hedging
the likelihood of a problem rather than checking exactly for one.
2021-12-22 12:10:07 -08:00