Skip to content

Conversation

@fnune
Copy link
Member

@fnune fnune commented Oct 21, 2025

Proposed changes

Document and announce component usage tracking feature

Adds documentation for the component usage tracking feature in the private registry and a blog post announcing its availability.

The usage tracking feature shows which stacks are using components from the private registry, including version information and last update timestamps. This helps platform teams understand component adoption and plan updates.

Changes:

  • Add usage tracking section to private registry documentation
  • Create blog post announcing the feature

Related issues (optional)

Fixes: https://github.com/pulumi/pulumi-service/issues/33384
Fixes: https://github.com/pulumi/pulumi-service/issues/33383

@fnune fnune requested review from komalali and kramhuber October 21, 2025 08:57
@fnune fnune changed the title Fixes: https://github.com/pulumi/pulumi-service/issues/33383 Document and announce the "used by" feature for Private Registry components Oct 21, 2025
@claude
Copy link
Contributor

claude bot commented Oct 21, 2025

Review Summary

I've reviewed the changes for documenting the component usage tracking feature. Overall, the content is well-structured and clear. I found one critical issue and several minor suggestions:


Critical Issue

Blog Post (content/blog/idp-component-usage-tracking/index.md)

1. Missing proper break placement

The blog post has the <!--more--> break on line 17, but it should appear immediately after the opening paragraph (line 15) with no blank line between the paragraph and the break.

Current structure:

Platform teams can now see which stacks are using components from the private registry, helping you understand adoption and plan updates.

<!--more-->

Issue: There is a blank line between the opening paragraph (line 15) and the <!--more--> break (line 17). According to the blogging guidelines, the break should come immediately after the first paragraph for proper display on the blog home page.

Expected structure:

Platform teams can now see which stacks are using components from the private registry, helping you understand adoption and plan updates.
<!--more-->

Minor Suggestions

Blog Post

2. Date verification needed (line 3)

Line 3: The date is set to 2025-10-21T09:00:00-07:00. Please verify this is the intended publication date.

3. Terminology consistency (line 23)

Line 23: Consider making the UI element name more explicit by using bold formatting for "Usage" tab, similar to how UI elements are referenced elsewhere in the docs.

Current: "Each component in the private registry includes a usage tab that displays:"

Suggested: "Each component in the private registry has a Usage tab that shows:"

Documentation (content/docs/idp/get-started/private-registry.md)

4. Section placement (line 141)

The new "Component usage tracking" section is added between the code examples and the "Specifying an Organization" section. This placement is logical and works well.

5. Content clarity (lines 145-150)

The bullet list is clear and informative. The information provided matches the blog post description, which is good for consistency.


Style Compliance Check

Correct:

  • Headings use proper sentence case (H2+)
  • No jargon or unnecessary complexity
  • Active voice used throughout
  • Appropriate paragraph lengths (3-4 sentences)
  • Clear structure with logical flow
  • Files end with newlines
  • Markdown formatting is clean
  • Links are properly formatted
  • Author metadata exists (idp-team)
  • Tags are appropriate

Blog post specific:

  • Title is within 60 character limit
  • Meta description is concise
  • Meta image file exists
  • Proper frontmatter structure

Pre-Merge Checklist

Please verify:

  • Fix the <!--more--> break placement (remove blank line before it)
  • Meta image uses current logos (per BLOGGING.md requirements)
  • Meta image meets 1200×628 PNG specifications
  • Preview locally to ensure blog home page display is correct
  • Test the break renders correctly on the blog index
  • Consider using Twitter card validator for social preview

Recommendation

Please fix the <!--more--> break placement (#1) before merging. This affects how the post displays on the blog home page.

The other suggestions are optional improvements. The content is accurate, well-written, and follows the style guide. Once the break is fixed, this will be ready to publish.


Mention me ('@claude') if you'd like me to review the changes again or if you need help with any suggestions.

@pulumi-bot
Copy link
Collaborator

@fnune fnune force-pushed the fnune/document-and-announce-used-by branch from dbdcc11 to 4abb1a5 Compare October 21, 2025 10:15
Fixes: pulumi/pulumi-service#33384

Document and announce component usage tracking feature

Adds documentation for the component usage tracking feature in the
private registry and a blog post announcing its availability.

The usage tracking feature shows which stacks are using components
from the private registry, including version information and last
update timestamps. This helps platform teams understand component
adoption and plan updates.

Changes:
- Add usage tracking section to private registry documentation
- Create blog post announcing the feature
@fnune fnune force-pushed the fnune/document-and-announce-used-by branch from 4abb1a5 to 205c7a4 Compare October 21, 2025 10:17
@pulumi-bot
Copy link
Collaborator

@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.

2 participants