Skip to content

Commit 04a2a37

Browse files
Apply suggestions from CodeRabbit
All typo fixes. Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent ac19ab5 commit 04a2a37

File tree

6 files changed

+9
-11
lines changed

6 files changed

+9
-11
lines changed

docs/2.0/way/principles/governance-maintainability/offer-golden-paths.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Platform engineers face a fundamental tension: you want _consistency_ because it
99

1010
What's the right balance? The answer lies in offering **golden paths,** which are well-supported, pre-built ways to accomplish the most common infrastructure problems that developers face. To solve a given problem, application developers can choose to use the golden path approach and enjoy a pre-built solution, ongoing maintenance, and support from the platform team, or they can go their own way knowing that development, support, and maintenance will now be their responsibility.
1111

12-
The golden paths concept was [first coined by Spotify](https://engineering.atspotify.com/2020/08/how-we-use-golden-paths-to-solve-fragmentation-in-our-software-ecosystem) back in 2020 and remains popular to today. It works because it aligns incentives. Platform engineers want to see their work used and have to make their patterns compelling enough to drive adoption. Application developers want to minimize their responsibilities so they can focus on building core features and not infrastructure.
12+
The golden paths concept was [first coined by Spotify](https://engineering.atspotify.com/2020/08/how-we-use-golden-paths-to-solve-fragmentation-in-our-software-ecosystem) back in 2020 and remains popular today. It works because it aligns incentives. Platform engineers want to see their work used and need to make their patterns compelling enough to drive adoption. Application developers seek to minimize their responsibilities so they can focus on building core features and not infrastructure.
1313

1414
Once again, we see the need to [treat your platform as a product](/2.0/way/principles/core-philosophy/your-developer-platform-is-a-product). In this case, you are "competing" against the application developer's next best alternative of "I'll just do it myself." Sometimes your developer platform will lose because it's actually not the right fit for a particular use case, and that's okay. But once you create a golden path for a given use case, it should win most of the time.
1515

docs/2.0/way/principles/technical-foundations/represent-all-patterns-as-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This approach leads to many issues:
3131

3232
Around 2014, these issues reached an inflection point and the idea of infrastructure-as-code was then a major paradigm shift. More than a decade later, we can now generalize the idea of representing all infrastructure as code to the idea that you should **represent all patterns as code,** and then [define all live infrastructure as pattern instances](/2.0/way/principles/technical-foundations/define-all-live-infrastructure-as-pattern-instances).
3333

34-
Representing patterns as code brings many benefits. To start, when anything is captured as code, it can be _stored in version control. That means that every change is now tracked, attributed, and can be reverted if needed. Code can be peer reviewed, and automated tests can run to immediately validate the newly committed code.
34+
Representing patterns as code brings many benefits. To start, when anything is captured as code, it can be stored in version control. That means that every change is now tracked, attributed, and can be reverted if needed. Code can be peer reviewed, and automated tests can run to immediately validate the newly committed code.
3535

3636
More generally, when a pattern is represented as code, what were liabilities above now become key advantages:
3737

docs/2.0/way/resources/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A Platform engineer builds internal developer platforms that provide standardize
3030

3131
### DevOps bankruptcy
3232

33-
When organizations wind up in some or all of these failure modes they may reach a breaking point we describe as **DevOps Bankruptcy**, a point at which starting fresh is often the better option because correcting the anti-patterns in their current infrastructure paradigm would be too costly.
33+
When organizations wind up in some or all of these failure modes they may reach a breaking point we describe as **DevOps Bankruptcy**: a point at which starting fresh is often the better option because correcting the anti-patterns in their current infrastructure paradigm would be too costly.
3434

3535
### Unit
3636

docs/2.0/way/solution/patterns/infrastructure-modules/categories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ SME topics include:
6767
- AI model access (Azure OpenAI, Amazon Bedrock)
6868
- Data platform configuration (Databricks, Amazon Sagemaker)
6969
- Data lakes (Snowflake, AWS Glue, Amazon Athena, Amazon RedShift)
70-
- Vector databases (Pgvector, Pinecon, Amazon OpenSearch)
70+
- Vector databases (Pgvector, Pinecone, Amazon OpenSearch)
7171

7272
This covers AI model access, data platforms for AI, specialized compute resources, and AI observability.
7373

docs/2.0/way/solution/patterns/overview.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ That definition might sound a little abstract, so here are some real-world examp
1717
- Helm charts
1818

1919
The common theme among all patterns is that when a user goes to consume them, they are pre-built, they reflect the opinion of a subject matter expert, and they solve a common infrastructure problem.
20-
21-
Now let's bo back to the definition of a pattern so we can understand that more deeply.
22-
20+
Now let's go back to the definition of a pattern so we can understand that more deeply.
2321
### Common infrastructure problems
2422

2523
_Patterns are pre-built, opinionated solutions to **common infrastructure problems.**_

docs/2.0/way/solution/platform/deploy/runbooks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ But creating a module instance can be complex! The developer may need to do any
2222
- "Apply" the code they generated
2323
- Validate that a pattern was created successfully
2424

25-
The breath and depth of these requirements impose a heavy burden on the humble developer who wishes only to deploy a pattern so they can get back to their real job of building their app.
25+
The breadth and depth of these requirements impose a heavy burden on the humble developer who wishes only to deploy a pattern so they can get back to their real job of building their app.
2626

2727
### The solution
2828

@@ -65,7 +65,7 @@ To be an _effective_ runbook, we need a few more requirements. Effective runbook
6565
- **Easily authored.** It must be easy for runbook authors to capture their expertise.
6666
- **Easily launched.** It must be easy for the runbook consumer to begin using the runbook.
6767
- **Documented.** The runbook must teach the user about this particular area of subject matter expertise, intermixing documentation and interactivity.
68-
- **Testable.** A runbook must be programmatically testable so that you can continually validate that it functions as expected.immediately see how that impacts the generated code.
68+
- **Testable.** A runbook must be programmatically testable so that you can continually validate that it functions as expected.
6969
- **Capture feedback.** The runbook must expose a way for runbook consumers to share feedback about their experience and request improvements.
7070

7171
#### Code execution
@@ -127,12 +127,12 @@ This improves on using static documentation because we offer the user a pre-set
127127
Better yet, either the process of generating the code includes a step to configure variables, or the template itself can leave placeholders for users to enter variables (as it does above).
128128

129129
:::info
130-
Gruntwork maintains an open source template generator built specially for DevOps and platform engineering called **Gruntwork Boilerplate.** Learn more at https://github.com/gruntwork-io/boilerplate.
130+
Gruntwork maintains an open-source template generator built specially for DevOps and platform engineering called **Gruntwork Boilerplate.** Learn more at [https://github.com/gruntwork-io/boilerplate](https://github.com/gruntwork-io/boilerplate).
131131
:::
132132

133133
### Infrastructure module UI
134134

135-
You can build (or buy) a solution that renders a UI for a given infrastructure module. The UI lists the available parameter values, and users fill in those values directly through the UI. Ideally, the UI can allow users to fetch value from external data sources such as infrastructure-as-code state, a secrets manager, or a third-party cool.
135+
You can build (or buy) a solution that renders a UI for a given infrastructure module. The UI lists the available parameter values, and users fill in those values directly through the UI. Ideally, the UI can allow users to fetch value from external data sources such as infrastructure-as-code state, a secrets manager, or a third-party tool.
136136

137137
The primary limitation of the infrastructure module UI is that, by definition, it is scoped to a single infrastructure module.
138138

0 commit comments

Comments
 (0)