@@ -37,8 +37,8 @@ This repository supports versioned documentation using [Mike](https://github.com
37
37
- ** v1.9** (Current) - Customer stable channel
38
38
39
39
### 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
42
42
43
43
### Creating a New Version
44
44
@@ -77,15 +77,15 @@ This repository integrates with `netboxlabs-website-dochub` for unified document
77
77
Our documentation follows the NetBox Enterprise release cycle with these version states:
78
78
79
79
- ** 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
82
82
83
83
### Branch and Content Strategy
84
84
85
85
#### Branch Structure
86
86
```
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)
89
89
├── v1.9 # v1.9 current release branch
90
90
└── feature/* # Feature branches for new content
91
91
```
@@ -94,9 +94,9 @@ main # Latest alpha development (v1.11 content)
94
94
95
95
| Content Type | Target Branch | When to Use |
96
96
| -------------| ---------------| -------------|
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 |
98
98
| ** 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) |
100
100
101
101
### Tagging and Release Workflow
102
102
@@ -120,16 +120,16 @@ main # Latest alpha development (v1.11 content)
120
120
```
121
121
** Result** : Documentation automatically deploys to production
122
122
123
- 2 . ** Alpha version content (v1.11)** :
123
+ 2 . ** Alpha version content (v1.11) - Helm capabilities ** :
124
124
``` bash
125
125
# Work on main branch for alpha features
126
126
git checkout main
127
127
git pull origin main
128
128
129
- # Make your documentation changes for new features
129
+ # Make your documentation changes for Helm features
130
130
# Commit and push changes
131
131
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)"
133
133
git push origin main
134
134
135
135
# 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):
171
171
- ** Avoid** : Documentation for unreleased features
172
172
- ** Review** : Test all examples and procedures
173
173
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
178
178
- ** Note** : Content won't be visible to customers until release
179
179
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
184
184
- ** Note** : Content ready for review but hidden from customers until release
185
185
186
186
### Common Workflows
@@ -199,10 +199,10 @@ git push origin v1.9.4
199
199
200
200
#### Scenario 2: Document New Feature for Alpha Release
201
201
``` bash
202
- # New Jinja2 template feature added to v1.11 (Alpha)
202
+ # New Helm deployment feature added to v1.11 (Alpha)
203
203
git checkout main
204
204
# Add comprehensive documentation
205
- git commit -m " Add Jinja2 conditional logic documentation"
205
+ git commit -m " Add Helm installation and configuration documentation"
206
206
git push origin main
207
207
# Content staged for v1.11 alpha release, not visible to customers yet
208
208
```
0 commit comments