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.

Sign up for GitHub

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

Jump to bottom

documentation on pulumi registry needs updating - config vs getconfig #3954

Closed
lethargosapatheia opened this issue Feb 13, 2024 · 2 comments
Closed

documentation on pulumi registry needs updating - config vs getconfig #3954

lethargosapatheia opened this issue Feb 13, 2024 · 2 comments
Assignees
@guineveresaenger
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) kind/enhancement Improvements or new features

Comments

@lethargosapatheia
Copy link

Hello!

There's deprecated and misleading information in the documentation.

Issue details

In the Overview section of https://www.pulumi.com/registry/packages/cloudinit/ Config is being used. But Config is deprecated as mentioned in the Config section (https://www.pulumi.com/registry/packages/cloudinit/api-docs/config/).

As far as I understand, only getConfig is supposed to be used, but I'm still not clear, given the deprecation message:

This resource is deprecated Please use the cloudinit.Config data source instead.
@lethargosapatheia lethargosapatheia added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Feb 13, 2024
@iwahbe
Copy link
Member

iwahbe commented Feb 13, 2024

Hi @lethargosapatheia. Thanks for bringing this to our attention.

@iwahbe iwahbe added area/docs Hand-written documentation. For api docs, see area/api-docs. and removed needs-triage Needs attention from the triage team labels Feb 13, 2024
@iwahbe iwahbe transferred this issue from pulumi/pulumi-cloudinit Feb 13, 2024
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Feb 13, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Feb 13, 2024
@toriancrane toriancrane added kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) and removed needs-triage Needs attention from the triage team labels Mar 11, 2024
@toriancrane toriancrane moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Mar 11, 2024
@toriancrane toriancrane added area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. and removed area/docs Hand-written documentation. For api docs, see area/api-docs. labels Mar 11, 2024
@guineveresaenger guineveresaenger self-assigned this Nov 1, 2024
@guineveresaenger
Copy link
Contributor

This is fixed via pulumi/pulumi-cloudinit#390. 🎉

@github-project-automation github-project-automation bot moved this from 🧳 Backlog to 🏁 Done in Docs 📚 Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@guineveresaenger guineveresaenger

Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) kind/enhancement Improvements or new features
Projects
Docs 📚
Status: 🏁 Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@guineveresaenger @toriancrane @iwahbe @lethargosapatheia