Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

set up resource page and reference area #36617

Open
wants to merge 19 commits into
base: docs/reference-rewrites-phrase-1
Choose a base branch
from

Conversation

trujillo-adam
Copy link
Contributor

@trujillo-adam trujillo-adam commented Mar 3, 2025

This PR implements Jira story IPE-1066 and is part of the Terraform information architecture redesign. It several existing page with a new reference page that describes arguments you can use in a resource block. It also factors the resources overview page, which describes the resource creation and management workflow.

I will create another PR to implement IPE-1067, which is the companion to 1066. The companion story outlines new usage pages that describe how to create and manage resources in Terraform configuration.

…-ref-rewrite' into docs/resource-block-ref-rewrite

merging changes pulled from main rollup branch into local working branch
@trujillo-adam trujillo-adam added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Mar 24, 2025
@trujillo-adam trujillo-adam marked this pull request as ready for review March 26, 2025 20:43
@trujillo-adam trujillo-adam requested a review from a team as a code owner March 26, 2025 20:43
@trujillo-adam trujillo-adam requested a review from a team as a code owner March 26, 2025 20:43
@trujillo-adam trujillo-adam marked this pull request as draft March 26, 2025 20:44
@rkoron007 rkoron007 force-pushed the docs/march-sprint-lang-rewrites branch 3 times, most recently from d2adaa0 to 92b1b12 Compare March 27, 2025 01:10
@trujillo-adam trujillo-adam marked this pull request as ready for review March 31, 2025 19:27
@@ -43,7 +43,9 @@ You can use a scoped data source to validate the status of a piece of infrastruc

#### Meta-Arguments

Scoped data sources support the `depends_on` and `provider` [meta-arguments](/terraform/language/resources/syntax#meta-arguments). Scoped data sources do not support the `count` or`for_each` meta-arguments.
Meta-arguments are arguments built into Terraform that control how Terraform creates and manages resources. [Meta-arguments](/terraform/language/meta-arguments) for additional information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you take this change out? This is the page I'm replacing and I don't want you to have a merge conflict!

@@ -9,7 +9,7 @@ description: >-
The `terraform state rm` command removes the binding to an existing remote object without first destroying it. The remote object continues
to exist but is no longer managed by Terraform.

Instead of using the `terraform state rm` command, you can use `removed` blocks to remove resources. You can remove more than one resource at a time, and you can review removals as part of your normal plan and apply workflow. [Learn more about using `removed` blocks with resources](/terraform/language/resources/syntax#removing-resources) and [using `removed` blocks with modules](/terraform/language/modules/syntax#removing-modules).
Instead of using the `terraform state rm` command, you can use `removed` blocks to remove resources. You can remove more than one resource at a time, and you can review removals as part of your normal plan and apply workflow. Refer to the [`removed` block reference](/terraform/language/block/removed) for additional information about removing resources. Refer to [Removing modules](/terraform/language/modules/syntax#removing-modules) for information about removing modules.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We won't have a removed block reference yet though, right? So the /terraform/language/block/removed link won't work?

@@ -7,7 +7,7 @@ description: Stacks help you provision and coordinate your infrastructure lifecy

A deployment configuration file defines how to deploy your Stack's infrastructure. Each Stack deployment runs in its agent, wholly isolated from other Stack deployments.

Every Stack needs a deployment configuration file, `tfdeploy.hcl`, and this page describes all of the blocks you can use within a deployment configuration file. Note that none of the blocks in the deployment configuration file support [meta-arguments](/terraform/language/resources/syntax#meta-arguments).
Every Stack needs a deployment configuration file, `tfdeploy.hcl`, and this page describes all of the blocks you can use within a deployment configuration file. Note that none of the blocks in the deployment configuration file support [meta-arguments](/terraform/language/meta-arguments).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no /terraform/language/meta-arguments because there is no index page for that directory.

@rkoron007 rkoron007 deleted the branch docs/reference-rewrites-phrase-1 March 31, 2025 22:55
@rkoron007 rkoron007 closed this Mar 31, 2025
@rkoron007 rkoron007 reopened this Mar 31, 2025
@rkoron007 rkoron007 requested review from a team as code owners March 31, 2025 23:08
@rkoron007 rkoron007 changed the base branch from docs/march-sprint-lang-rewrites to docs/reference-rewrites-phrase-1 March 31, 2025 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-needed Add this to your PR if the change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants