Commit Graph

71 Commits

Author SHA1 Message Date
Martin Atkins
dc9bec611c website: Reorganize and tidy some lifecycle-related information
Over time the discussion about "lifecycle" blocks in the documentation
became confusing because the docs originally written for managed resource
lifecycle got partially generalized for resources of other modes and for
module calls, even though each of those has a completely different
lifecycle and thus a different set of lifecycle settings.

This is a first pass at trying to reorganize that so that the "lifecycle"
page is really just an index of all of the different kinds of lifecycle
block that exist in the language, while the main documentation for each
use of that block type now belongs with the documentation of the block
it's nested within.

While working on this I also found that there was some duplication inside
the "data sources" page where the same information was described multiple
times, and a few other cases where things had become inconsistent over
time. This also includes a little extra content to try to clarify the
difference between managed, data, and ephemeral resources and to make it
explicit that the "Resources" section is focused only on managed resources
because that is the primary resource mode.

As usual there's lots more that could be done here -- this documentation
has gradually evolved over time and is full of weird quirks due to that
evolution -- but I decided to draw a line here so that the diff wouldn't
get too large.

Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
2025-10-17 15:08:14 -07:00
Diógenes Fernandes
d42dcc3b0a Add docs for the conditional enabled lifecycle attribute (#3380)
Signed-off-by: Diogenes Fernandes <diofeher@gmail.com>
Co-authored-by: Martin Atkins <mart@degeneration.co.uk>
Co-authored-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
2025-10-16 13:10:00 -03:00
Diógenes Fernandes
cb73ae4299 docs for provider for_each in modules and resources (#2696)
Signed-off-by: Diogenes Fernandes <diofeher@gmail.com>
2025-07-15 16:54:32 -03:00
Martin Atkins
c453eb6a3b website: Initial documentation updates for dynamic provider instances (#2138)
Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
2024-12-05 07:46:02 -05:00
Arel Rabinowitz
3d4bf29c56 Add exclude flag support (#1900)
Signed-off-by: RLRabinowitz <rlrabinowitz2@gmail.com>
2024-11-05 10:16:00 -05:00
Janos
a15a6c9657 Versioned docs: replacing docs links with relative variants (#1537)
Signed-off-by: Janos <86970079+janosdebugs@users.noreply.github.com>
Signed-off-by: Damian Stasik <920747+damianstasik@users.noreply.github.com>
Signed-off-by: Roman Grinovski <roman.grinovski@gmail.com>
Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com>
Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
2024-04-24 13:24:30 +02:00
Julien Levasseur
4c0bda5386 Rename website to OpenTofu (#516)
Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com>
Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
2023-09-21 10:57:47 +01:00
Damian Stasik
4cab6e72b4 Replace legacy admonition syntax (#432) 2023-09-18 13:56:28 +02:00
Damian Stasik
072d1dce56 Clean up frontmatter sections in the docs (#421) 2023-09-15 16:03:23 +02:00
Roman Grinovski
a4f9c63288 Change docs links: /opentf-> /docs (#367)
Signed-off-by: Roman Grinovski <roman.grinovski@gmail.com>
2023-09-15 14:10:27 +02:00
Marcin Białoń
0a37fade1f website/docs/language/meta-arguments (#229)
Signed-off-by: Marcin Białoń <mbialon@spacelift.io>
2023-08-29 16:36:54 +02:00
RLRabinowitz
c31a2812fb Remove terraform from file names in website folder 2023-08-27 14:06:49 +03:00
Andrew Babichev
91c7402bad Update website/docs/language/meta-arguments/lifecycle.mdx
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2023-07-25 09:38:49 +01:00
Andrew Babichev
06c6532681 Update website/docs/language/meta-arguments/lifecycle.mdx
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2023-07-25 09:38:42 +01:00
Andrew Babichev
1287ad46a1 docs: create_before_destroy meta-attribute propagation 2023-07-21 19:06:47 +01:00
Ashlee Boyer
32f7b8ebd0 Migrating links to new format 2023-02-23 12:55:56 -05:00
James Bardin
1d0fc1c6c8 Update website/docs/language/meta-arguments/lifecycle.mdx
Co-authored-by: Martin Atkins <mart@degeneration.co.uk>
2023-02-14 14:11:19 -05:00
James Bardin
df65d16022 replace null_resource with terraform_data
Replace references to null_resource with terraform_data, and link the
use of terraform_data from replace_triggered_by.
2023-02-14 09:48:10 -05:00
Laura Pacilio
1ce0b91e67 Merge pull request #32020 from hashicorp/fix-future-lang-2
Remove future-facing language from docs (WIP)
2022-11-29 15:09:21 -05:00
Laura Pacilio
c3c6f8327f Merge pull request #31149 from hashicorp/docs-for-each-list-toset
fix(docs): change set to list when recommending using toset()
2022-10-25 11:04:19 -04:00
Laura Pacilio
cf47c71291 Revert "Revert "Remove future-facing statements""
This reverts commit cb975a5fff.
2022-10-14 16:14:20 -04:00
Laura Pacilio
cb975a5fff Revert "Remove future-facing statements"
This reverts commit 0a7e221a49.
2022-10-14 15:00:22 -04:00
Laura Pacilio
0a7e221a49 Remove future-facing statements 2022-10-14 14:42:40 -04:00
Bryce Kalow
b54017ef83 website: content updates for developer (#31779)
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
Co-authored-by: Kevin Wang <kwangsan@gmail.com>
Co-authored-by: Judith Malnick <judith@hashicorp.com>
Co-authored-by: Martin Atkins <mart@degeneration.co.uk>
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
2022-09-15 15:54:13 -05:00
Ansgar Mertens
6c4341e764 fix(docs): remove recommendation to wrap a set using toset() 2022-06-16 07:45:15 +00:00
Ignacio Miranda Figueroa
68a83e48e7 docs: update depends_on.mdx meta-argument 2022-06-06 11:15:09 -04:00
Nick Fagerlund
5bf48952fe Edit docs for replace_triggered_by lifecycle argument (#31129)
- Note that it was added in v1.2, so users know whether they can use it yet.
- Fix nested indentation formatting, so the parent list item stays together.
- Minor copy edits.
- List all of the available lifecycle block arguments before diving into the
  docs for each argument, for ease of reading/scanning.
2022-05-26 10:39:04 -07:00
James Bardin
4e95b24022 Update website/docs/language/meta-arguments/lifecycle.mdx
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-04-26 18:17:52 -04:00
James Bardin
6c15cab211 Update website/docs/language/meta-arguments/lifecycle.mdx
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-04-26 18:17:46 -04:00
James Bardin
840a7437c2 Update website/docs/language/meta-arguments/lifecycle.mdx
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-04-26 18:17:41 -04:00
James Bardin
7b40b31697 replace_triggered_by docs 2022-04-25 18:43:38 -04:00
Laura Pacilio
686dbcdb8d fix confusing sentence on lifecycle page 2022-04-20 11:24:23 -04:00
Laura Pacilio
f9462d5d51 Update links to say "Custom Condition Checks" 2022-04-07 16:25:09 -04:00
Laura Pacilio
eea860e0cf Fixing typos and doing a read through 2022-04-06 16:55:43 -04:00
Laura Pacilio
04d329a9e1 Add references to custom conditions on related pages 2022-04-06 16:11:36 -04: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
Dylan Staley
21cbb5b392 migrate docs to mdx 2021-12-14 18:41:17 -08:00
Dylan Staley
0e48f58688 Revert "migrate docs to mdx"
This reverts commit 3cb12b5a52.
2021-11-22 15:57:25 -08:00
Dylan Staley
3cb12b5a52 migrate docs to mdx 2021-11-22 15:47:36 -08:00
Laura Pacilio
1e1d47d16d Merge pull request #28345 from yvespp/destroy_provisioners_doc
document that destroy provisioners don't run with create_before_destroy
2021-09-03 10:19:30 -04:00
Yves Peter
fa4c590f51 Apply suggestions from code review
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-09-03 08:23:17 +02:00
Laura Pacilio
31af9adc00 Make all sentences start with caps + additional tweak wording edits 2021-07-30 14:44:17 -04:00
Laura Pacilio
6874aad76d Update website/docs/language/meta-arguments/resource-provider.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:07:19 -04:00
Laura Pacilio
809f50fbf2 Update website/docs/language/meta-arguments/module-providers.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:07:03 -04:00
Laura Pacilio
2e34e7a727 Remove back ticks from module providers meta argument page 2021-07-30 10:50:39 -04:00
Laura Pacilio
512bb1a3c5 Remove back ticks from provider meta argument page 2021-07-30 10:49:28 -04:00
Laura Pacilio
051ce2ae6c Remove back ticks from lifecycle page 2021-07-30 10:47:31 -04:00