Skip to content

Conversation

@pose
Copy link
Contributor

@pose pose commented Nov 26, 2025

Fixes #16674

Expanded explanation of the project file's role in Pulumi YAML programs by adding details about top-level attributes. For example, this should make easier to discover where to find documentation for the resources property.

Fixes #16674

Expanded explanation of the project file's role in Pulumi YAML programs by adding details about top-level attributes.
@pose pose self-assigned this Nov 26, 2025
@pose pose requested a review from Frassle November 26, 2025 11:18
@claude
Copy link
Contributor

claude bot commented Nov 26, 2025

Documentation Review

I've reviewed the changes in this PR. The enhancement adds helpful context about Pulumi YAML's top-level attributes (resources, variables, and outputs) in the project file documentation.

✅ Strengths

  • Good addition: The specific examples of top-level attributes (resources, variables, outputs) make it easier for users to discover relevant documentation
  • Link validity: The link to /docs/iac/languages-sdks/yaml/yaml-language-reference/ correctly points to the YAML language reference documentation
  • Addresses the issue: This change directly addresses issue Document resource attribute on Pulumi.yaml #16674 by providing more discoverable information about the resources property

📝 Suggestions

Line 25: Consider rewording for better clarity

The phrase "top-level attributes related to infrastructure" could be more precise. Consider:

For Pulumi programs specifically written in Pulumi YAML, the project file not only serves as a configuration and metadata repository but also contains the program's infrastructure definition itself. For instance, `resources`, `variables`, and `outputs` are [top-level properties that define your infrastructure](/docs/iac/languages-sdks/yaml/yaml-language-reference/). To learn more, see [Pulumi YAML](/docs/intro/languages/yaml/).

Rationale:

  • "top-level properties" is more technically accurate than "top-level attributes" (the YAML spec refers to them as properties in the table)
  • "that define your infrastructure" is more direct than "related to infrastructure"

Summary

The change is technically accurate and improves discoverability. The minor wording suggestion above is optional but would improve precision and clarity.


If you'd like me to apply the suggested changes or perform additional reviews, mention me (@claude) in a comment.

@pulumi-bot
Copy link
Collaborator

@pose
Copy link
Contributor Author

pose commented Nov 26, 2025

@claude apply the suggested changes

@claude
Copy link
Contributor

claude bot commented Nov 26, 2025

Claude finished @pose's task —— View job


Applying Suggested Changes

I've successfully applied the wording improvements from my previous review.

Tasks

  • Read the current file state
  • Apply the suggested wording changes
  • Commit and push the changes

Changes Made

Updated line 25 in content/docs/iac/concepts/projects/project-file.md:

  • Changed "top-level attributes related to infrastructure" → "top-level properties that define your infrastructure"
  • Removed backticks around resources, variables, and outputs in the main text (kept them in code context)

These changes improve technical accuracy (the YAML spec refers to them as properties) and make the description more direct and clear.

--- |

Changed "top-level attributes related to infrastructure" to "top-level properties that define your infrastructure" for better technical accuracy and clarity.

Co-authored-by: Alberto Pose <pose@users.noreply.github.com>
@pulumi-bot
Copy link
Collaborator

@pose pose merged commit 7148696 into master Nov 26, 2025
11 checks passed
@pose pose deleted the link-to-top-level-infra-in-pulumi-yaml branch November 26, 2025 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document resource attribute on Pulumi.yaml

4 participants