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

Clarify documentation for pulumi org set-default to indicate it only affects local users #11869

Closed
zbuchheit opened this issue May 20, 2024 · 2 comments · Fixed by pulumi/pulumi#16233
Closed

Clarify documentation for pulumi org set-default to indicate it only affects local users #11869

zbuchheit opened this issue May 20, 2024 · 2 comments · Fixed by pulumi/pulumi#16233
Assignees
@interurban @sean1588
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Milestone
0.105

Comments

@zbuchheit
Copy link
Contributor

File: content/docs/cli/commands/pulumi_org_set-default.md

Currently, this documentation for users with their own self-managed backend is confusing. The wording states, "Set the default organization for the current backend," which can mislead users into thinking that this command will change the default organization for all users sharing the same backend. In reality, it only changes this setting locally for the user via config.json in the Pulumi home directory.

Could we add a note to call out this only affects the local user?
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label May 20, 2024
@interurban interurban self-assigned this May 20, 2024
@interurban interurban added the area/docs Improvements or additions to documentation label May 20, 2024
@interurban
Copy link
Collaborator

in the pulumi cli; update the command help option as well

@interurban interurban modified the milestones: 0.104, 0.105 May 20, 2024
@sean1588 sean1588 mentioned this issue May 20, 2024
Merged
@sean1588 sean1588 self-assigned this May 20, 2024
github-merge-queue bot pushed a commit to pulumi/pulumi that referenced this issue May 23, 2024
@sean1588
Update set-default command description (#16233)
92bb050 
fixes: pulumi/docs#11869

Updates the command description to be more explicit that this only
alters default org configuration locally.
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label May 23, 2024
@pulumi-bot pulumi-bot reopened this May 23, 2024
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have required labels: kind/

Please fix these problems and try again.

@cnunciato cnunciato added kind/enhancement Improvements or new features and removed needs-triage Needs attention from the triage team labels May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@interurban interurban

@sean1588 sean1588

Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Projects
Docs 📚
Status: 🏁 Done
Milestone
0.105
Development

Successfully merging a pull request may close this issue.

Update set-default command description pulumi/pulumi
5 participants
@interurban @cnunciato @sean1588 @zbuchheit @pulumi-bot