@@ -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** (Development ) - Upcoming release
41
- - ** v1.11** (Development ) - Future release
40
+ - ** v1.10** (Beta ) - Upcoming release
41
+ - ** v1.11** (Alpha ) - Future release
42
42
43
43
### Creating a New Version
44
44
@@ -77,25 +77,26 @@ 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
- - ** Development Versions (v1.10, v1.11)** : Prepared infrastructure, hidden from users until release
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
81
82
82
83
### Branch and Content Strategy
83
84
84
85
#### Branch Structure
85
86
```
86
- main # Latest development (v1.11 content)
87
- ├── v1.10 # v1.10 maintenance branch (when ready)
88
- ├── v1.9 # v1.9 maintenance branch (current)
87
+ main # Latest alpha development (v1.11 content)
88
+ ├── v1.10 # v1.10 beta branch (when ready)
89
+ ├── v1.9 # v1.9 current release branch
89
90
└── feature/* # Feature branches for new content
90
91
```
91
92
92
93
#### Where to Write Documentation
93
94
94
95
| Content Type | Target Branch | When to Use |
95
96
| -------------| ---------------| -------------|
96
- | ** New features for future release** | ` main ` | Writing docs for v1.11 features |
97
+ | ** New features for alpha release** | ` main ` | Writing docs for v1.11 (Alpha) features |
97
98
| ** Updates to current release** | ` v1.9 ` | Bug fixes, clarifications for current customers |
98
- | ** Preparing next release** | ` v1.10 ` | Writing docs for v1.10 features (when branch exists) |
99
+ | ** Preparing beta release** | ` v1.10 ` | Writing docs for v1.10 (Beta) features (when branch exists) |
99
100
100
101
### Tagging and Release Workflow
101
102
@@ -119,21 +120,21 @@ main # Latest development (v1.11 content)
119
120
```
120
121
** Result** : Documentation automatically deploys to production
121
122
122
- 2 . ** Future version content (v1.11)** :
123
+ 2 . ** Alpha version content (v1.11)** :
123
124
``` bash
124
- # Work on main branch for future features
125
+ # Work on main branch for alpha features
125
126
git checkout main
126
127
git pull origin main
127
128
128
129
# Make your documentation changes for new features
129
130
# Commit and push changes
130
131
git add .
131
- git commit -m " Add documentation for new Jinja2 features in v1.11"
132
+ git commit -m " Add documentation for new Jinja2 features in v1.11 (Alpha) "
132
133
git push origin main
133
134
134
- # Don't tag yet - wait for v1.11 release
135
+ # Don't tag yet - wait for v1.11 alpha release
135
136
```
136
- ** Result** : Content ready for v1.11 but not visible to customers yet
137
+ ** Result** : Content ready for v1.11 alpha but not visible to customers yet
137
138
138
139
#### For Major Release Preparation
139
140
@@ -170,12 +171,18 @@ When preparing a new major/minor version (like v1.10 or v1.11):
170
171
- ** Avoid** : Documentation for unreleased features
171
172
- ** Review** : Test all examples and procedures
172
173
173
- #### Development Version (v1.11) Content
174
+ #### Alpha Version (v1.11) Content
174
175
- ** Focus** : New features, major changes, future functionality
175
176
- ** Updates** : Draft documentation, work-in-progress content
176
- - ** Include** : Feature flags, beta warnings if applicable
177
+ - ** Include** : Feature flags, alpha warnings if applicable
177
178
- ** Note** : Content won't be visible to customers until release
178
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
184
+ - ** Note** : Content ready for review but hidden from customers until release
185
+
179
186
### Common Workflows
180
187
181
188
#### Scenario 1: Fix Documentation Error for Current Customers
@@ -190,14 +197,14 @@ git push origin v1.9.4
190
197
# Documentation automatically updates for customers
191
198
```
192
199
193
- #### Scenario 2: Document New Feature for Next Release
200
+ #### Scenario 2: Document New Feature for Alpha Release
194
201
``` bash
195
- # New Jinja2 template feature added to v1.11
202
+ # New Jinja2 template feature added to v1.11 (Alpha)
196
203
git checkout main
197
204
# Add comprehensive documentation
198
205
git commit -m " Add Jinja2 conditional logic documentation"
199
206
git push origin main
200
- # Content staged for v1.11 release, not visible to customers yet
207
+ # Content staged for v1.11 alpha release, not visible to customers yet
201
208
```
202
209
203
210
#### Scenario 3: Backport Important Update
0 commit comments