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

Generate documentation for provider configuration #4749

Open
Tracked by #1794
iwahbe opened this issue Dec 22, 2023 · 2 comments
Open
Tracked by #1794

Generate documentation for provider configuration #4749

iwahbe opened this issue Dec 22, 2023 · 2 comments
Labels
area/docs Hand-written documentation. For api docs, see area/api-docs. kind/enhancement Improvements or new features size/L Estimated effort to complete (up to 10 days).

Comments

@iwahbe
Copy link
Member

iwahbe commented Dec 22, 2023 •
edited
Loading

Generated documentation in the registry includes arguments to the Provider resource, but it doesn't talk explicitly about the values used in pulumi config set.

Since the set of values you can use for pulumi config set myProvider:myField myValue for is exactly equivalent to new myProvider.Provider(myField: myValue) we should also generate docs for the pulumi config set form.

This is separate from copying docs from upstream bridged provider's frontmatter (pulumi/pulumi-terraform-bridge#2068) and can be done for all providers (which is why it's a request here).
@iwahbe iwahbe added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Dec 22, 2023
@justinvp justinvp added area/docs Hand-written documentation. For api docs, see area/api-docs. and removed needs-triage Needs attention from the triage team labels Dec 23, 2023
@VenelinMartinov VenelinMartinov mentioned this issue Mar 26, 2024
Closed
@mjeffryes mjeffryes mentioned this issue Mar 26, 2024
Closed
@guineveresaenger
Copy link
Contributor

Related: #224

This was referenced May 31, 2024
Merged
Merged
@guineveresaenger guineveresaenger mentioned this issue Jun 10, 2024
Open
10 tasks
@iwahbe iwahbe transferred this issue from pulumi/pulumi Jun 13, 2024
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Jun 13, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Jun 13, 2024
@sean1588
Copy link
Member

thanks @iwahbe ! I think this would be a great addition.

@interurban interurban removed the needs-triage Needs attention from the triage team label Jun 17, 2024
@interurban interurban moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Jun 17, 2024
@interurban interurban added the size/L Estimated effort to complete (up to 10 days). label Jun 17, 2024
@mjeffryes mjeffryes added this to the 0.107 milestone Jul 24, 2024
@interurban interurban removed this from the 0.107 milestone Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs Hand-written documentation. For api docs, see area/api-docs. kind/enhancement Improvements or new features size/L Estimated effort to complete (up to 10 days).
Projects
Docs 📚
Status: 🧳 Backlog
Milestone
No milestone
Development

No branches or pull requests
6 participants
@interurban @justinvp @mjeffryes @guineveresaenger @sean1588 @iwahbe