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

Transformation Resource Option Page Doesn't Provide a Complete Example #11652

Open
Tracked by #11197
RobbieMcKinstry opened this issue Oct 17, 2022 · 1 comment
Open
Tracked by #11197
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days).

Comments

@RobbieMcKinstry
Copy link
Contributor

What happened?

While triaging a user-reported issue today, I came across the Transformation resource option page. I noticed this page doesn't contain a complete example, only a snippet.

Specifically, the example shows code for a component resource named MyVpcComponent. However, it doesn't provide the definition of MyVpcComponent. This opens up the possibility for confusion; users might not understand what they have to do with the component options. For example, you could implement MyVpcComponent incorrectly as follows:

class MyVpcComponent extends pulumi.ComponentResource {
    constructor(name, opts) {
        super("pkg:index:MyVpcComponent", name, {}, {});
    }
}

Steps to reproduce

  1. Visit the transformation resource option page.
  2. Observe the code provided.
  3. Note that it isn't a full example in any language and cannot be run.

Expected Behavior

I expected all identifiers in the example program to be defined.

Actual Behavior

MyVpcComponent is undefined.

Output of pulumi about

No response

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

@RobbieMcKinstry RobbieMcKinstry added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Oct 17, 2022
@susanev
Copy link
Contributor

susanev commented Oct 17, 2022

@RobbieMcKinstry im going to remove the needs triage label on this, if yall would like this content updated, someone from the platform team is more than likely going to need to open a pr. id be happy to review or help however i can.

@susanev susanev removed the needs-triage Needs attention from the triage team label Oct 17, 2022
@susanev susanev added kind/enhancement Improvements or new features area/docs Improvements or additions to documentation and removed kind/bug Some behavior is incorrect or out of spec labels Mar 25, 2023
@interurban interurban self-assigned this Feb 22, 2024
@interurban interurban added the size/S Estimated effort to complete (1-2 days). label Feb 22, 2024
@interurban interurban added this to the 0.101 milestone Feb 22, 2024
@interurban interurban modified the milestones: 0.101, 0.102 Mar 11, 2024
@interurban interurban modified the milestones: 0.102, 0.103 Mar 26, 2024
@sean1588 sean1588 transferred this issue from pulumi/pulumi-hugo May 10, 2024
@interurban interurban modified the milestones: 0.103, 0.104 May 10, 2024
@interurban interurban removed this from the 0.104 milestone May 20, 2024
@interurban interurban removed their assignment May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features size/S Estimated effort to complete (1-2 days).
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

3 participants