Skip to content

Conversation

@tehsis
Copy link
Contributor

@tehsis tehsis commented Dec 29, 2025

Proposed changes

Blogpost for the new ESC Editor

Unreleased product version (optional)

This is not yet released

Related issues (optional)

@claude
Copy link
Contributor

claude bot commented Dec 29, 2025

Documentation Review

I've reviewed PR #16918 and found several issues that need to be addressed before this blog post is ready for publication.

Critical Issues

1. Blog post appears incomplete (lines 44-69)

The blog post contains placeholder sections and template content that must be removed before publication:

  • Line 44: Heading "Using built-int functions" is a typo (should be "built-in") and the section is empty
  • Lines 46-48: Empty sections for "Exporting configurations" and "Setting up integrations"
  • Lines 50-69: Contains template instructions and placeholder content including:
    • "Writing the Post" section with instructions
    • Generic code samples with ellipsis (...)
    • "Placeholder Image" alt text
    • Template notes about YouTube parameters

Recommendation: Complete the blog post content or remove all placeholder sections. A blog post should not contain template instructions or generic examples.

2. Title capitalization error (line 2)

title: "New Esc Editor"

According to STYLE-GUIDE.md line 39, H1 titles should use Title Case. "Esc" should be "ESC" as it's an acronym for "Environments, Secrets, and Configuration" (STYLE-GUIDE.md line 222).

Suggestion:

title: "New ESC Editor"

3. Future date in frontmatter (line 3)

date: 2026-01-12T13:00:00-03:00

The date is set to January 2026, which is in the future. Per BLOGGING.md line 197, the date field is used for sorting and display but doesn't control publication timing. Please verify this is the intended publication date.

Style and Content Issues

4. Typo in heading (line 44)

"Using built-int functions" should be "Using built-in functions"

5. Missing content after headings

Lines 40-48 contain multiple H2 headings with no content:

  • "Setting a secret" (line 40) - only has an image
  • "Using built-int functions" (line 44) - empty
  • "Exporting configurations" (line 46) - empty
  • "Setting up integrations" (line 48) - empty

Per Google Developer Documentation Style Guide, headings should introduce content. Either complete these sections or remove the empty headings.

6. Template/placeholder content must be removed

Lines 50-69 contain template content that appears to be from a blog post generator:

  • Instructions for writing posts
  • Links to BLOGGING.md and STYLE-GUIDE.md
  • Generic TypeScript code sample with ...
  • "Placeholder Image" alt text
  • Template notes about YouTube parameters

All of this must be removed before publication.

7. Image alt text could be more descriptive (line 42)

![Adding a secret to your ESC Environment](./adding-secrets.png)

While functional, the alt text "Adding a secret to your ESC Environment" could be more descriptive of what the image actually shows (e.g., specific UI elements, workflow steps).

8. Inconsistent terminology

The post uses both "Pulumi ESC" (lines 19, 21, 30) and "ESC" (line 21, 26, 42) interchangeably. Per STYLE-GUIDE.md line 226, expand product acronyms at first mention, then use just the product name after. Consider using "Pulumi ESC" consistently throughout or "ESC" after the first mention.

9. Blog post structure observation

The introductory paragraphs (lines 19-36) are well-written and engaging. However, the post lacks a conclusion or call-to-action. Per the docs-review criteria for blogs (line 183), blog posts should have a "clear call-to-action at the end."

Documentation Gap

This blog post announces a new ESC editor feature but doesn't reference any corresponding documentation. Per the additional instructions (lines 187-195 in docs-review.md), when blog posts announce new Pulumi features:

Recommendation: Verify that documentation exists in content/docs/esc/ explaining how to use the new editor. If not, consider adding:

  • A guide in content/docs/esc/guides/ for using the new editor
  • Updates to existing ESC documentation referencing the new editor capabilities

Action Items Summary

Before this PR can be merged:

  1. Complete or remove all empty sections (lines 44-48)
  2. Remove all template/placeholder content (lines 50-69)
  3. Fix title capitalization: "New ESC Editor"
  4. Fix typo: "built-int" → "built-in"
  5. Add a conclusion with call-to-action
  6. Verify the 2026 date is intentional
  7. Consider adding/updating ESC documentation to support this announcement

Please mention me (@claude) if you'd like help making these fixes or want me to review the updated version.

@pulumi-bot
Copy link
Collaborator

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.

3 participants