Commit Graph

35 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
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
Christian Mesh
b186fd3912 Docs update, remove additional terraform references (#1046)
Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
Co-authored-by: Janos <86970079+janosdebugs@users.noreply.github.com>
2023-12-21 08:58:23 -05: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
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ń
43b8029a1e Fix issues website/docs/language (#244)
Signed-off-by: Marcin Białoń <mbialon@spacelift.io>
2023-08-31 11:08:59 +02:00
Marcin Białoń
bf5e6c079d Update website/docs/language/data-sources (#224)
Signed-off-by: Marcin Białoń <mbialon@spacelift.io>
2023-08-29 16:37:38 +02:00
Ashlee Boyer
32f7b8ebd0 Migrating links to new format 2023-02-23 12:55:56 -05:00
Laura Pacilio
8ca918d4a5 Update website/docs/language/data-sources/index.mdx 2022-10-24 17:42:57 -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
Martin Atkins
289bb60ce1 core: Defer on transitive dependencies for data resources with conditions
When a data resource is used for the purposes of verifying a condition
about an object managed elsewhere (e.g. if the managed resource doesn't
directly export all of the information required for the condition) it's
important that we defer the data resource read to the apply step if the
corresponding managed resource has any changes pending.

Typically we'd expect that to come "for free" but unfortunately we have
a pragmatic special case in our handling of data resources where we
normally defer to the apply step only if a _direct_ dependency of the data
resource has a change pending, and allow a plan-time read if there's
a pending change in an indirect dependency. This allowed us to preserve
some compatibility with the questionable historical behavior of always
reading data resources proactively unless the configuration contains
unknown values, since the arguably-more-correct behavior would've been a
regression for anyone who had been depending on that before.

Since preconditions and postconditions didn't exist until now, we are not
constrained in the same way by backward compatibility, and so we can adopt
the more correct behavior in the case where a data resource has conditions
specified. This does unfortunately make the handling of data resources
with conditions subtly inconsistent with those that don't, but this is
a better situation than the alternative where it would be easy to get into
a trapped situation where the remote system is invalid and it's impossible
to plan the change that would make it valid again because the conditions
evaluate too soon, prior to the fix being applied.
2022-05-11 11:01:38 -07:00
Laura Pacilio
2a206c7984 fix incorrect HCL syntax for example 2022-04-20 11:49:33 -04:00
Laura Pacilio
f660f54b87 Final nits from review 2022-04-20 11:21:11 -04:00
Laura Pacilio
e8743143e3 Update website/docs/language/data-sources/index.mdx
Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>
2022-04-20 11:17:45 -04:00
Laura Pacilio
87b09b1ee1 Fix broken HCL in example 2022-04-20 11:17:16 -04:00
Laura Pacilio
f9462d5d51 Update links to say "Custom Condition Checks" 2022-04-07 16:25:09 -04:00
Laura Pacilio
04d329a9e1 Add references to custom conditions on related pages 2022-04-06 16:11:36 -04: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
06a2fdcf9d Merge branch 'main' into description-metadata-language-docs 2021-07-21 16:24:59 -04:00
Laura Pacilio
a780f625e9 Fix metadata description format on all pages 2021-07-19 12:11:10 -04:00
Laura Pacilio
bc9065334e Update description metadata per PR feedback 2021-07-14 16:54:26 -04:00
Laura Pacilio
12d1706562 Update data sources metadata to remove ing and include more detailXy 2021-07-13 17:23:07 -04:00
Nick Fagerlund
0e004f2377 website: remove legacy provider docs index (#29134)
* website: Update or remove references to legacy provider docs

We've finally evicted the last of the legacy provider docs from terraform.io!
Let's celebrate by purging all memory of them.

The 0.11 docs are now so thoroughly legacy that I don't believe they need a new
destination for their provider links, so I just removed those.

* website: remove old provider docs index

This will require a redirect in the terraform-website repo.

* Apply suggestions from code review

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-07-09 14:44:58 -07:00
Laura Pacilio
adf4dbdf84 Update description metadata 2021-07-09 11:45:42 -04:00
Judith Malnick
044c439dbc Gloss of top docs pages (#28891)
* clarify input variables opening sentence

* adjust variables description

* claraify providers text and add learn callout

* add description to providers page

* add desscription and clarify provider configuration

* add deprecation note to versions in proivder configs

* add hands on callout and clarify next steps in intro

* link to language collection from language docs

* give more context about configurtion language up front

* clarify output top page

* reorganize for each intro to present feature before notes

* move description before link out and remove passive voice

* fix typo

* clarify purpose of plan

* move explanation before learn link and fully spell boolean

* add a syntax heading  to separate intro from details

* add learn callout to module source docs

* clean up intro to provider requirements and add link

* Apply suggestions from code review

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-06-08 06:58:55 -07:00
Robin Norwood
181048b913 Add crosslink to new Learn tutorial 2021-02-04 13:43:03 -06:00
Nick Fagerlund
7a8dd326c6 website: Language: Update links to moved pages 2021-01-22 12:22:21 -08:00
Nick Fagerlund
78dcc8dc1b website: Language: Move files to match new URL structure 2021-01-22 12:22:21 -08:00