Skip to content

Commit 103aa0d

Browse files
ostermanclaudeaknysh
authored
docs: Clarify version management intro and weave industry context naturally (#1817)
Explain version management upfront with concrete examples (dev vs prod), then challenge the "obvious" approach of strict pinning by showing its hidden costs. Frame these as design patterns—proven approaches that optimize for different goals. Remove dedicated "Industry Context" section and weave LaunchDarkly and Thoughtworks quotes into relevant subsections where they provide context, following the approach used in the design documentation itself. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]> Co-authored-by: Andriy Knysh <[email protected]>
1 parent 154490b commit 103aa0d

File tree

1 file changed

+10
-18
lines changed

1 file changed

+10
-18
lines changed

website/blog/2025-11-14-comprehensive-version-management-docs.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ authors: [osterman]
55
tags: [atmos, documentation, version-management, versioning, deployment-strategies]
66
---
77

8-
There's no one-size-fits-all approach to version management. Through years of experience implementing infrastructure across hundreds of organizations, we've seen different versioning patterns work better depending on what you want to optimize for—whether that's simplicity, control, regulatory compliance, or development velocity.
8+
When you deploy infrastructure across multiple environments—dev, staging, production—you need a way to manage which version of each component runs where. Maybe your VPC module in dev is testing new CIDR ranges, while production stays on the stable version until you're confident the changes work.
99

10-
This new documentation captures the versioning patterns we've implemented, seen in production, and refined with teams ranging from small startups to large enterprises. Each pattern has trade-offs, and the right choice depends on your organization's needs and constraints.
10+
That's **version management**: deciding how different versions of your infrastructure components flow through your environments.
11+
12+
The obvious answer—pin every version in every environment—turns out to optimize for the wrong thing. Strict pinning creates divergence by default: environments drift apart unless you constantly update pins. It weakens feedback loops because lower environments stay on old versions, hiding cross-environment impacts. And at scale, you face PR storms from automated dependency updates.
13+
14+
So what's the right approach? It depends. We've documented these strategies as **design patterns**—proven approaches that optimize for different goals. Some prioritize convergence and fast feedback; others prioritize control and reproducibility. The best choice depends on your organization's culture, team size, and how you already think about software delivery.
1115

1216
<!--truncate-->
1317

@@ -30,7 +34,7 @@ All version management patterns are fully documented under a unified [Version Ma
3034

3135
#### Deployment Strategies
3236

33-
**[Continuous Version Deployment](/design-patterns/version-management/continuous-version-deployment)** - The recommended trunk-based approach where all environments converge to the same version through automated progressive rollout. Perfect for teams embracing modern DevOps practices with strong CI/CD automation.
37+
**[Continuous Version Deployment](/design-patterns/version-management/continuous-version-deployment)** - The recommended trunk-based approach where all environments converge to the same version through automated progressive rollout. As LaunchDarkly puts it, "Decoupling deploy from release increases speed and stability when delivering software." Atmos achieves this through CI/CD gates that control when environments receive changes.
3438

3539
**[Git Flow: Branches as Channels](/design-patterns/version-management/git-flow-branches-as-channels)** - Long-lived branches map to release channels for teams that need prolonged divergence or already practice Git Flow workflows. Use when you need version control to represent current state versus desired state.
3640

@@ -64,20 +68,6 @@ The documentation includes clear guidance on choosing the right pattern for your
6468
- You're comfortable with cherry-picking and merge strategies
6569
- You want version control to represent current vs. desired state
6670

67-
### 🔍 Industry Context
68-
69-
The documentation frames Atmos's approach within industry best practices:
70-
71-
> Decoupling deploy from release increases speed and stability when delivering software.
72-
>
73-
> — LaunchDarkly
74-
75-
> More-frequent deployments reduce the risk associated with change, while business stakeholders retain control over when features are released to end users.
76-
>
77-
> — Thoughtworks Technology Radar
78-
79-
Atmos achieves decoupling through **progressive deployment automation** where CI/CD gates control when environments receive changes, and comprehensive plan previews enable informed release decisions.
80-
8171
### 🛠️ Practical Improvements
8272

8373
Throughout the documentation, you'll find:
@@ -109,7 +99,9 @@ The documentation includes:
10999

110100
## Key Takeaway
111101

112-
**The best approach is what your engineering organization already follows.** If your team has established Git Flow practices, extending them to infrastructure management keeps the mental model consistent. If you're building modern cloud-native infrastructure with strong automation, Continuous Version Deployment provides the simplest path forward.
102+
**The best strategy is one that follows how your team already thinks about software delivery.** As the Thoughtworks Technology Radar notes, "More-frequent deployments reduce the risk associated with change, while business stakeholders retain control over when features are released."
103+
104+
If your team has established Git Flow practices, extend them to infrastructure—keeping the mental model consistent matters. If you embrace trunk-based development with strong automation, Continuous Version Deployment is your simplest path forward.
113105

114106
Ready to explore? Check out the new [Version Management documentation](/design-patterns/version-management) today!
115107

0 commit comments

Comments
 (0)