Skip to content

Commit 787e412

Browse files
committed
Update version descriptions with specific capabilities - v1.10 (Beta): NetBox Enterprise with Assurance capabilities - v1.11 (Alpha): NetBox Enterprise with Helm capabilities - Update all documentation examples to reflect specific feature focus - Prepare for v1.9 tag to lock in current version
1 parent fcd0b4e commit 787e412

File tree

2 files changed

+25
-23
lines changed

2 files changed

+25
-23
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ This repository supports versioned documentation using [Mike](https://github.com
3737
- **v1.9** (Current) - Customer stable channel
3838

3939
### Future Versions
40-
- **v1.10** (Beta) - Upcoming release
41-
- **v1.11** (Alpha) - Future release
40+
- **v1.10** (Beta) - NetBox Enterprise with Assurance capabilities
41+
- **v1.11** (Alpha) - NetBox Enterprise with Helm capabilities
4242

4343
### Creating a New Version
4444

@@ -77,15 +77,15 @@ This repository integrates with `netboxlabs-website-dochub` for unified document
7777
Our documentation follows the NetBox Enterprise release cycle with these version states:
7878

7979
- **Current Version (v1.9)**: Live customer documentation, displayed to users
80-
- **Beta Version (v1.10)**: Near-release version, prepared infrastructure, hidden from users until release
81-
- **Alpha Version (v1.11)**: Early development version, prepared infrastructure, hidden from users until release
80+
- **Beta Version (v1.10)**: NetBox Enterprise with Assurance capabilities, near-release version, hidden from users until release
81+
- **Alpha Version (v1.11)**: NetBox Enterprise with Helm capabilities, early development version, hidden from users until release
8282

8383
### Branch and Content Strategy
8484

8585
#### Branch Structure
8686
```
87-
main # Latest alpha development (v1.11 content)
88-
├── v1.10 # v1.10 beta branch (when ready)
87+
main # Latest alpha development (v1.11 - Helm capabilities)
88+
├── v1.10 # v1.10 beta branch (Assurance capabilities, when ready)
8989
├── v1.9 # v1.9 current release branch
9090
└── feature/* # Feature branches for new content
9191
```
@@ -94,9 +94,9 @@ main # Latest alpha development (v1.11 content)
9494

9595
| Content Type | Target Branch | When to Use |
9696
|-------------|---------------|-------------|
97-
| **New features for alpha release** | `main` | Writing docs for v1.11 (Alpha) features |
97+
| **Helm capabilities (alpha)** | `main` | Writing docs for v1.11 Helm features |
9898
| **Updates to current release** | `v1.9` | Bug fixes, clarifications for current customers |
99-
| **Preparing beta release** | `v1.10` | Writing docs for v1.10 (Beta) features (when branch exists) |
99+
| **Assurance capabilities (beta)** | `v1.10` | Writing docs for v1.10 Assurance features (when branch exists) |
100100

101101
### Tagging and Release Workflow
102102

@@ -120,16 +120,16 @@ main # Latest alpha development (v1.11 content)
120120
```
121121
**Result**: Documentation automatically deploys to production
122122

123-
2. **Alpha version content (v1.11)**:
123+
2. **Alpha version content (v1.11) - Helm capabilities**:
124124
```bash
125125
# Work on main branch for alpha features
126126
git checkout main
127127
git pull origin main
128128

129-
# Make your documentation changes for new features
129+
# Make your documentation changes for Helm features
130130
# Commit and push changes
131131
git add .
132-
git commit -m "Add documentation for new Jinja2 features in v1.11 (Alpha)"
132+
git commit -m "Add documentation for Helm deployment in v1.11 (Alpha)"
133133
git push origin main
134134

135135
# Don't tag yet - wait for v1.11 alpha release
@@ -171,16 +171,16 @@ When preparing a new major/minor version (like v1.10 or v1.11):
171171
- **Avoid**: Documentation for unreleased features
172172
- **Review**: Test all examples and procedures
173173

174-
#### Alpha Version (v1.11) Content
175-
- **Focus**: New features, major changes, future functionality
176-
- **Updates**: Draft documentation, work-in-progress content
177-
- **Include**: Feature flags, alpha warnings if applicable
174+
#### Alpha Version (v1.11) Content - Helm Capabilities
175+
- **Focus**: NetBox Enterprise with Helm features, major architectural changes
176+
- **Updates**: Draft documentation for Helm deployment, work-in-progress content
177+
- **Include**: Feature flags, alpha warnings, Helm-specific installation guides
178178
- **Note**: Content won't be visible to customers until release
179179

180-
#### Beta Version (v1.10) Content
181-
- **Focus**: Near-final features, stabilized functionality
182-
- **Updates**: Refined documentation, final examples
183-
- **Include**: Beta status indicators if applicable
180+
#### Beta Version (v1.10) Content - Assurance Capabilities
181+
- **Focus**: NetBox Enterprise with Assurance features, stabilized functionality
182+
- **Updates**: Refined documentation for Assurance workflows, final examples
183+
- **Include**: Beta status indicators, Assurance-specific configuration guides
184184
- **Note**: Content ready for review but hidden from customers until release
185185

186186
### Common Workflows
@@ -199,10 +199,10 @@ git push origin v1.9.4
199199

200200
#### Scenario 2: Document New Feature for Alpha Release
201201
```bash
202-
# New Jinja2 template feature added to v1.11 (Alpha)
202+
# New Helm deployment feature added to v1.11 (Alpha)
203203
git checkout main
204204
# Add comprehensive documentation
205-
git commit -m "Add Jinja2 conditional logic documentation"
205+
git commit -m "Add Helm installation and configuration documentation"
206206
git push origin main
207207
# Content staged for v1.11 alpha release, not visible to customers yet
208208
```

versions.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@
1414
{
1515
"version": "v1.10",
1616
"branch": "v1.10",
17-
"title": "v1.10 (Beta)",
17+
"title": "v1.10 (Beta) - NetBox Enterprise with Assurance",
18+
"description": "NetBox Enterprise with Assurance capabilities",
1819
"status": "beta"
1920
},
2021
{
2122
"version": "v1.11",
2223
"branch": "main",
23-
"title": "v1.11 (Alpha)",
24+
"title": "v1.11 (Alpha) - NetBox Enterprise with Helm",
25+
"description": "NetBox Enterprise with Helm capabilities",
2426
"status": "alpha"
2527
}
2628
]

0 commit comments

Comments
 (0)