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

auto-generate the cli menu in docs #9107

Closed
susanev opened this issue May 18, 2023 · 2 comments
Closed

auto-generate the cli menu in docs #9107

susanev opened this issue May 18, 2023 · 2 comments
Assignees
Labels
kind/engineering Work that is not visible to an external user needs-triage Needs attention from the triage team resolution/fixed This issue was fixed

Comments

@susanev
Copy link
Contributor

susanev commented May 18, 2023

right now the cli menu in docs is controlled from this manually maintained file...
https://github.com/pulumi/docs/blob/master/config/_default/menus.yml

we instead want to do this over in
https://github.com/pulumi/pulumi/blob/master/pkg/cmd/pulumi/gen_markdown.go

so for every top-level command, directly under pulumi we would want to add this to its frontmatter

cli:
    weight: 2
    parent: commands

giving everything a weight of 2 will cause hugo to order them alphabetically

the pulumi command is a special case and we want it to h ave a weight of 1 so it always appears at the top

cli:
    weight: 1
    parent: commands

this should not be added for sub commands, e.g., https://www.pulumi.com/docs/cli/commands/pulumi_stack_select/

@susanev susanev added the kind/engineering Work that is not visible to an external user label May 18, 2023
@susanev susanev moved this to 🎬 Ready in Docs 📚 May 18, 2023
@susanev susanev added this to the 0.90 milestone May 18, 2023
@susanev susanev removed this from the 0.90 milestone Jun 15, 2023
@cnunciato cnunciato moved this from 🎬 Ready to 🧳 Backlog in Docs 📚 Jul 20, 2023
@interurban interurban added the resolution/fixed This issue was fixed label Dec 18, 2024
@interurban
Copy link
Collaborator

Thanks! This was fixed and we forgot to close down the issue.

@github-project-automation github-project-automation bot moved this from 🧳 Backlog to 🏁 Done in Docs 📚 Dec 18, 2024
@pulumi-bot pulumi-bot reopened this Dec 18, 2024
@pulumi-bot
Copy link
Collaborator

Cannot close issue:

  • does not have an assignee

Please fix these problems and try again.

@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Dec 18, 2024
@interurban interurban self-assigned this Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/engineering Work that is not visible to an external user needs-triage Needs attention from the triage team resolution/fixed This issue was fixed
Projects
Status: 🏁 Done
Development

No branches or pull requests

3 participants