Tf 39100 handling key warnings and notes in docgen#2144
Open
gbaker-ibm wants to merge 6 commits into
Open
Conversation
gbaker-ibm
marked this pull request as draft
July 17, 2026 17:29
gbaker-ibm
force-pushed
the
TF-39100-handling-key-warnings-and-notes-in-docgen
branch
3 times, most recently
from
July 20, 2026 19:39
a006e62 to
83ef253
Compare
gbaker-ibm
force-pushed
the
TF-39100-handling-key-warnings-and-notes-in-docgen
branch
from
July 20, 2026 20:42
83ef253 to
1a7941c
Compare
gbaker-ibm
force-pushed
the
TF-39100-handling-key-warnings-and-notes-in-docgen
branch
from
July 20, 2026 20:46
1a7941c to
666afe6
Compare
gbaker-ibm
force-pushed
the
TF-39100-handling-key-warnings-and-notes-in-docgen
branch
from
July 20, 2026 21:34
c5f2ac2 to
3315884
Compare
gbaker-ibm
marked this pull request as ready for review
July 20, 2026 21:45
ctrombley
approved these changes
Jul 21, 2026
ctrombley
left a comment
ctrombley
left a comment
Collaborator
There was a problem hiding this comment.
Approved with a few small nits!
Comment on lines
+4
to
+5
| * Documentation generation now inserts attribute and resource deprecation guidance into the generated schema docs. By @<gbaker-ibm> [#2144](https://github.com/hashicorp/terraform-provider-tfe/pull/2144) | ||
| * Corrected and reorganized schema fields across the provider, including placing deprecation marks into those previously noted as deprecated by the documentation. By @<gbaker-ibm> [#2144](https://github.com/hashicorp/terraform-provider-tfe/pull/2144) |
Collaborator
There was a problem hiding this comment.
💅 Were these angle brackets intentional?
Suggested change
| * Documentation generation now inserts attribute and resource deprecation guidance into the generated schema docs. By @<gbaker-ibm> [#2144](https://github.com/hashicorp/terraform-provider-tfe/pull/2144) | |
| * Corrected and reorganized schema fields across the provider, including placing deprecation marks into those previously noted as deprecated by the documentation. By @<gbaker-ibm> [#2144](https://github.com/hashicorp/terraform-provider-tfe/pull/2144) | |
| * Documentation generation now inserts attribute and resource deprecation guidance into the generated schema docs. By @gbaker-ibm [#2144](https://github.com/hashicorp/terraform-provider-tfe/pull/2144) | |
| * Corrected and reorganized schema fields across the provider, including placing deprecation marks into those previously noted as deprecated by the documentation. By @gbaker-ibm [#2144](https://github.com/hashicorp/terraform-provider-tfe/pull/2144) |
| Optional: true, | ||
| ConflictsWith: []string{"trigger_patterns", "trigger_prefixes"}, | ||
| Description: "A regular expression used to trigger a workspace run for matching Git tags. Conflicts with `trigger_patterns` and `trigger_prefixes`.", | ||
| Description: "A regular expression used to trigger a Workspace run for matching Git tags. This option conflicts with `trigger_patterns` and `trigger_prefixes`. Should only set this value if the former is not being used.", |
Collaborator
There was a problem hiding this comment.
💅 Consider for consistency:
Suggested change
| Description: "A regular expression used to trigger a Workspace run for matching Git tags. This option conflicts with `trigger_patterns` and `trigger_prefixes`. Should only set this value if the former is not being used.", | |
| Description: "A regular expression used to trigger a workspace run for matching Git tags. This option conflicts with `trigger_patterns` and `trigger_prefixes`. Should only set this value if the former is not being used.", |
| Optional: true, | ||
| Default: false, | ||
| Description: "If true, the workspace will be force deleted when destroyed via this provider, even if the workspace contains resources managed by Terraform.", | ||
| Description: "If this attribute is present on a workspace that is being deleted through the provider, it will use the existing force delete API. If this attribute is not present or false it will safe delete the workspace.", |
Collaborator
There was a problem hiding this comment.
force_delete is a boolean attribute with Default: false, so phrasing it as "if this attribute is present on a workspace"feels awkward (it's always "present," just true/false). Recommend keeping something closer to the original.
Comment on lines
+45
to
+46
| "-> **Note:** Stack cannot be destroyed if it contains deployments that have underlying managed resources.\n\n" + | ||
| "~> **Note:** Stack support is currently pre-release/beta and subject to change. A stack cannot be destroyed until all resources in its deployments have been destroyed.", |
Collaborator
There was a problem hiding this comment.
Can we consolidate the "cannot be destroyed" language across these two admonitions?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds admonitions regarding warnings, notes, and deprecations into schemata. Modified document generation to surface messages regarding deprecations.
Also performs minor format changes to existing website documentation and sources.
Some admonitions in a specific, handwritten section regarding TTL formats are in no way replicated, nor is the information. However that information is handled, so too this must be handled (at a later date).
Remember to:
Testing plan
generate-docs.shwhich uses deprecation and identify the style useSample doc output
Inventory of admonition changes (and consistencies)
The following report was partially generated and partially scripted; it may not be perfectly accurate.
admonitions.csv
Output from acceptance tests
Note that failures are listed. We submit they are the same before and after
test_results_new.txt
Rollback Plan
Rollback of the PR and regeneration of any docs should be sufficient.
Changes to Security Controls
N/A