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

Pulumi CLI documentation lacks information on pulumi ai #9972

Open
scottslowe opened this issue Oct 2, 2023 · 1 comment · May be fixed by #13309
Open

Pulumi CLI documentation lacks information on pulumi ai #9972

scottslowe opened this issue Oct 2, 2023 · 1 comment · May be fixed by #13309
Assignees
@thoward
Labels
area/docs Improvements or additions to documentation grooming-q2y25 kind/bug Some behavior is incorrect or out of spec kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) kind/enhancement Improvements or new features
Milestone
0.113

Comments

@scottslowe
Copy link
Contributor

Problem description

A community user pointed out that the Pulumi CLI documentation (https://www.pulumi.com/docs/cli/) lacks any documentation on the pulumi ai command (the user specifically referenced pulumi ai web).

Affected product version(s)

This should only affect the CLI versions that include pulumi ai commands.

Suggestions for a fix

We just need to add pulumi ai to the CLI page with appropriate explanation/details.
@scottslowe scottslowe added the needs-triage Needs attention from the triage team label Oct 2, 2023
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Oct 2, 2023
@toriancrane toriancrane added kind/enhancement Improvements or new features kind/bug Some behavior is incorrect or out of spec kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) area/docs Improvements or additions to documentation and removed needs-triage Needs attention from the triage team labels Oct 25, 2023
@toriancrane toriancrane moved this from 🤔 Triage to 🧳 Backlog in Docs 📚 Oct 25, 2023
@thoward
Copy link
Contributor

thoward commented Nov 9, 2024

Note: This is due to the make generate command, which runs pulumi gen-markdown <path>, but does not set the PULUMI_EXPERIMENTAL=true environment variable, which means that the experimental ai subcommand is hidden during the run, and Cobra doesn't generate the file for those commands. Enabling that flag generates the appropriate files.

@thoward thoward self-assigned this Nov 9, 2024
@thoward thoward linked a pull request Nov 9, 2024 that will close this issue
Open
@thoward thoward moved this from 🧳 Backlog to 💜 Review in Docs 📚 Nov 9, 2024
@thoward thoward added this to the 0.113 milestone Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thoward thoward

Labels
area/docs Improvements or additions to documentation grooming-q2y25 kind/bug Some behavior is incorrect or out of spec kind/codegen Issue relates to upstream auto codgens -- Python SDK, Bridge, Provider(s) kind/enhancement Improvements or new features
Projects
Docs 📚
Status: 💜 Review
Milestone
0.113
Development

Successfully merging a pull request may close this issue.

Generate CLI docs w/ PULUMI_EXPERIMENTAL flag pulumi/docs
3 participants
@thoward @scottslowe @toriancrane