Fix product page heading display to use clean titles #16185
Conversation
- Updated templates for IDP, Pulumi Insights, and Neo to use heading field instead of title - Added heading and subheading fields to Pulumi Insights content - Added heading, subheading, and SEO title to Neo content - Ensures clean product names display on pages while preserving SEO titles in browser tabs
Review SummaryThis PR successfully implements the ✅ What's Working Well
Issues FoundMissing newline at end of file (content/product/neo.md:109)The file is missing a final newline. Per AGENTS.md: "New files must always end with a newline." Fix: Add a blank line after the closing Grammar: Missing period (content/product/neo.md:8)The subheading is missing a period at the end of the sentence. Current: subheading: |
Your AI platform engineer. Ship infrastructure faster, safely.Should be: subheading: |
Your AI platform engineer. Ship infrastructure faster, safelyPer STYLE-GUIDE.md guidance on conciseness and the Google Developer Documentation Style Guide, fragments in marketing copy don't require terminal punctuation. Capitalization: "complete" should be "Complete" (content/product/pulumi-insights.md:7)Following sentence case rules for subheadings, this should start with a capital letter. Current: subheading: |
Complete visibility and control for your cloudThis is actually correct as-is. The first word is capitalized. Minor ObservationThe internal-developer-platforms.html template has the most robust fallback pattern: {{ partial "hero" (dict "title" (or .Params.heading "Internal Developer Platform") "subtitle" (or .Params.subheading .Params.overview.title)) }}While neo.html and pulumi-insights.html provide hardcoded fallbacks, they're consistent with their respective page expectations. This is fine. RecommendationFix the missing newline in |
|
Your site preview for commit 5e31c57 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16185-5e31c57e.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit b06ad3b is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16185-b06ad3bb.s3-website.us-west-2.amazonaws.com. |
| heading: Internal Developer Platform | ||
| subheading: | | ||
| Build your IDP with Pulumi. Give engineers self-service infrastructure through templates, components, and developer portals while maintaining control through policies and governance. | ||
| The fastest, most secure way to deliver cloud infrastructure |
There was a problem hiding this comment.
Are we sure this is what it said prior to these changes? I vaguely recall we wanted the more descriptive version.
There was a problem hiding this comment.
I pulled the text from the nav menu description. It used to state "Accelerate Cloud Delivery with Secure Developer Self-Service". I just made the change in #16196.
Summary
This PR fixes the product page title display issue where SEO-optimized titles were being shown as main headings on pages instead of clean product names.
Problem
Following PR #16040 which added SEO-optimized titles, some product pages started displaying long SEO titles (e.g., "Cloud Asset and Compliance Management – Pulumi Insights") as the main page heading instead of clean product names.
Solution
Updated templates and content to follow the pattern used by the secrets-management page:
Changes Made
Templates Updated (3 files)
layouts/product/internal-developer-platforms.html- Use heading field instead of titlelayouts/product/pulumi-insights.html- Use heading field instead of titlelayouts/product/neo.html- Use heading field instead of titleContent Updated (2 files)
content/product/pulumi-insights.md- Added heading and subheading fieldscontent/product/neo.md- Added SEO title, heading, and subheading fieldsTesting
make serveBefore/After
Before: "Cloud Asset and Compliance Management – Pulumi Insights" displayed on page
After: "Pulumi Insights" displayed on page, SEO title in browser tab
Fixes the issue reported about product page titles getting munged in #16040.