Skip to content

Commit 0eef03f

Browse files
CamSoperclaude
andauthored
Follow up unapplied findings from #20861 (four-factors.md) (#20872)
The automated content review on #20861 deferred eight Vale findings as judgment calls. Resolve all of them: - Difficulty qualifiers (L22, L35): "simple parameters" -> "a small set of parameters"; "simple interfaces" -> "narrow interfaces", which also lines up with the "Limited inputs" bullet that follows. - Heading sentence case (L68, L72, L89) per STYLE-GUIDE.md §Headings. The page's H2/H3s were title-cased throughout, so this is the page-wide sweep the review deferred. - "Web Site" -> "website" in the L72 heading and its lead sentence, and "a S3" -> "an S3". The `web-site` template identifier is unchanged. - Weasel word (L101): "several key benefits" -> "four key benefits". The list has exactly four items. - Cross-reference block (L114): fold the "Additional Resources" H3 list into the "Learn more" H2 above it. STYLE-GUIDE.md §Cross-reference sections sanctions exactly two headings and says not to coin a third, so merging is the right resolution rather than renaming the H3 into a duplicate "Learn more" heading. Nothing links to the #additional-resources anchor. - Also match the "No-code stacks" link label to that page's actual title. Vale on this file goes from 8 warnings to 0; `make lint` passes. Claude-Session: https://claude.ai/code/session_01S6VDttJGquAzYdoaQK8FVR Co-authored-by: Claude <noreply@anthropic.com>
1 parent 118e981 commit 0eef03f

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

content/docs/idp/guides/best-practices/four-factors.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This guide introduces a framework for building with Pulumi IDP that leverages fo
1919

2020
Key characteristics:
2121

22-
- **User-configurable**: Developers can customize templates through simple parameters
22+
- **User-configurable**: Developers can customize templates through a small set of parameters
2323
- **Stack creation**: Each time a template is used it creates one or more new, independent [Pulumi stacks](/docs/iac/concepts/stacks/)
2424
- **Standardized starting point**: Ensures consistent project structure and configuration
2525
- **Low barrier to entry**: Enables developers to get started quickly without deep infrastructure knowledge
@@ -32,7 +32,7 @@ Templates abstract away the complexity of initial setup while providing flexibil
3232

3333
Key characteristics:
3434

35-
- **Business logic abstraction**: Hide complex infrastructure patterns behind simple interfaces
35+
- **Business logic abstraction**: Hide complex infrastructure patterns behind narrow interfaces
3636
- **Sensible defaults**: Provide secure, compliant defaults out of the box
3737
- **Limited inputs**: Reduce cognitive load by exposing only necessary configuration options
3838
- **Company standards**: Encode organizational policies and best practices directly in code
@@ -65,13 +65,13 @@ Key characteristics:
6565

6666
Policies act as a safety net, ensuring that even as infrastructure scales and evolves, it remains compliant with organizational requirements.
6767

68-
## Bringing It All Together
68+
## Bringing it all together
6969

7070
The power of Pulumi IDP comes from combining these four factors into cohesive developer workflows. Here's how they work together in practice:
7171

72-
### Example: Deploying a Web Site
72+
### Example: deploying a website
7373

74-
Consider a developer who needs to deploy a new web site hosted in a S3 bucket. Here's how the four factors collaborate:
74+
Consider a developer who needs to deploy a new website hosted in an S3 bucket. Here's how the four factors collaborate:
7575

7676
- **Template**: The developer starts with a `web-site` template that scaffolds a new project with the necessary structure and dependencies.
7777
- **Component**: The template uses a custom `TaggedBucket` component that automatically:
@@ -86,7 +86,7 @@ Consider a developer who needs to deploy a new web site hosted in a S3 bucket. H
8686
- Ensures access policies meet organizational security standards
8787
- Blocks deployment if compliance requirements aren't met
8888

89-
### Developer Experience
89+
### Developer experience
9090

9191
From the developer's perspective, they only need to:
9292

@@ -98,7 +98,7 @@ Behind the scenes, the four factors work together to apply the correct environme
9898

9999
### Benefits
100100

101-
This approach delivers several key benefits:
101+
This approach delivers four key benefits:
102102

103103
- **Reduced complexity**: Developers don't need to understand the intricacies of infrastructure configuration
104104
- **Consistent compliance**: Policies ensure all deployments meet organizational standards
@@ -111,8 +111,6 @@ By leveraging these four factors together, organizations can create internal dev
111111

112112
To see how these four factors can be used together in some common use cases, check out our [patterns](/docs/idp/guides/best-practices/patterns) library.
113113

114-
### Additional Resources
115-
116114
- [Pulumi IDP Concepts](/docs/idp/concepts)
117115
- [Private Registry](/docs/idp/concepts/private-registry)
118-
- [No-code Stacks](/docs/idp/concepts/no-code-stacks)
116+
- [No-code stacks](/docs/idp/concepts/no-code-stacks)

0 commit comments

Comments
 (0)