Skip to content

Conversation

@asafashirov
Copy link
Contributor

Summary

This PR addresses issue #11608 by improving the front matter metadata for all CLI command documentation pages to enhance SEO and search discoverability.

Changes Made

  • Title Enhancement: Added " | CLI commands" suffix to all CLI command page titles (154 files)
  • Meta Descriptions: Added standardized meta_desc field with contextual descriptions for each command
  • Consistent Format: Applied uniform metadata structure across both Pulumi CLI and ESC CLI command pages

Impact

  • Improved search engine discoverability of CLI documentation
  • Better page titles in search results and browser tabs
  • Standardized meta descriptions instead of auto-generated excerpts
  • Enhanced SEO performance for CLI documentation

Files Changed

  • 118 Pulumi CLI command pages in content/docs/iac/cli/commands/
  • 36 ESC CLI command pages in content/docs/esc/cli/commands/

Closes #11608

- Add " | CLI commands" suffix to all CLI command page titles
- Add standardized meta descriptions for all CLI command pages
- Improve search engine discoverability of CLI documentation
- Update both Pulumi CLI and ESC CLI command pages (154 files total)

Addresses GitHub issue #11608
@pulumi-bot
Copy link
Collaborator

Copy link
Member

@jkodroff jkodroff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bad news: The IaC commands (definitely, and presumably ESC although I have not yet confirmed) are auto-generated, so the code change has to be in pulumi/pulumi for IaC.

This is not documented, it's a problem, and I was planning to submit a PR to the README to clearly indicate this today or tomorrow.

Good news: You should still be able to do this with Claude code.

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@asafashirov asafashirov force-pushed the cli-frontmatter-improvements branch from e75eb51 to 905be55 Compare June 4, 2025 18:22
@pulumi-bot
Copy link
Collaborator

@asafashirov
Copy link
Contributor Author

Closing this PR as I'm addressing the changes in the following PRs respectively:
pulumi/pulumi#19745
pulumi/esc#544

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CLI command pages have incomplete front matter

4 participants