Skip to content

Conversation

@jkodroff
Copy link
Member

@jkodroff jkodroff commented Oct 31, 2025

Split the monolithic integration testing page into three focused pages:

  • Overview page explaining integration testing concepts and options
  • Dedicated framework page with updated Go v3 SDK examples
  • Dedicated Automation API page with numbered workflow steps

Changes:

  • Update SDK imports from pkg/v2 to pkg/v3
  • Improve intro to explain black-box testing before using the term
  • Remove outdated ephemeral environments section
  • Add clear sections for "Why integration testing?" and benefits
  • Organize testing options with explicit benefits and constraints
  • Maintain SEO with proper aliases configuration
  • Update menu structure with parent/child relationships

Fixes #16430 #11743

🤖 Generated with Claude Code

Split the monolithic integration testing page into three focused pages:
- Overview page explaining integration testing concepts and options
- Dedicated framework page with updated Go v3 SDK examples
- Dedicated Automation API page with numbered workflow steps

Changes:
- Update SDK imports from pkg/v2 to pkg/v3
- Improve intro to explain black-box testing before using the term
- Remove outdated ephemeral environments section
- Add clear sections for "Why integration testing?" and benefits
- Organize testing options with explicit benefits and constraints
- Maintain SEO with proper aliases configuration
- Update menu structure with parent/child relationships

Fixes #16430

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Contributor

claude bot commented Oct 31, 2025

Documentation Review

I've reviewed the restructuring of the integration testing documentation. The changes successfully split the monolithic page into three focused pages and update the Go SDK imports from v2 to v3. Overall, the structure is clear and the content is well-organized.

Issues Found

1. H1 Heading Capitalization (Multiple Files)

Per the style guide, H1 headings should use Title Case, but H2+ headings should use Sentence case. The H1 headings in the frontmatter are inconsistent with the style guide:

content/docs/iac/guides/testing/integration/_index.md:5

h1: Integration testing for Pulumi programs

content/docs/iac/guides/testing/integration/framework.md:5

h1: Integration testing framework

content/docs/iac/guides/testing/integration/automation-api.md:5

h1: Integration testing with Automation API

2. Menu Name Capitalization (automation-api.md:10)

Menu items should use Title Case per the style guide, not Sentence case:

content/docs/iac/guides/testing/integration/automation-api.md:10

        name: Automation API Testing

3. Menu Name Capitalization (framework.md:10)

content/docs/iac/guides/testing/integration/framework.md:10

        name: Integration Testing Framework

Positive Aspects

  • ✅ SDK imports correctly updated from pkg/v2 to pkg/v3
  • ✅ Aliases properly configured on the index page to maintain SEO
  • ✅ Menu structure correctly uses parent/child relationships with identifiers
  • ✅ Content flows well and improves readability by splitting into focused topics
  • ✅ Files end with newlines
  • ✅ H2+ headings correctly use Sentence case
  • ✅ Technical accuracy maintained throughout
  • ✅ Links appear valid and follow proper formatting

Please mention @claude if you would like me to review any additional changes or if you have questions about these suggestions.

@pulumi-bot
Copy link
Collaborator

Copy link
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

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

Excellent work. I particularly liked the extra context we get in _index.md that we didn't have before.

@jkodroff jkodroff merged commit 2086408 into master Nov 4, 2025
14 checks passed
@jkodroff jkodroff deleted the jkodroff/integration-testing-refresh branch November 4, 2025 01:58
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.

Integration Testing: Content refresh

4 participants