pulumi
CLI command pages have incomplete front matter
Hey again @susanev! Wanted to also loop back on those title tag and meta description adjustments to the CLI docs pages.
I have them written out in this spreadsheet here to make things easier. We mainly want to add " | CLI commands" to the title tags, and then set a standard meta description (since it looks like right now it's pulling from the page contents).
LMK if anything is unclear and thank you in advance!
@interurban will leave this to you to do, i didn't have time to get to this.
@interurban - were you ever able to get access to the above spreadsheet? I believe these concern these pages. Taking a look here it does look like they are missing meta_desc properties as well as the page title could be improved. These pages are auto generated when the Pulumi CLI pubishes a new release, so will probably need to make adjustments to where ever generates these pages.
Did some digging on this:
Here's an example of the incomplete front matter:
---
title: "pulumi version"
aliases:
- /docs/reference/cli/pulumi_version/
---
The CLI command pages are generated in .github/workflows/pulumi-cli.yaml, via the following command:
PULUMI_EXPERIMENTAL=true pulumi gen-markdown ./content/docs/iac/cli/commands
This means that this issue needs to go into pulumi/pulumi because that's where the Markdown for the docs site is generated (and therefore where the code change would need to occur).
@asafashirov You should provide an example of what you want the front matter to look like and transfer to pulumi/pulumi (or, alternatively, close this issue).
@jkodroff I took a first pass at it; please review: https://github.com/pulumi/docs/pull/15219
This is fixed in these PRs:
- https://github.com/pulumi/pulumi/pull/19745
- https://github.com/pulumi/esc/pull/544