@@ -56,47 +56,63 @@ mkdocs serve
56
56
57
57
We use ** branch-based versioning** to control what customers see on the live documentation site:
58
58
59
+ #### ** Current State (Transition Period)**
59
60
| Version | Status | Branch | Customer Visibility | Purpose |
60
61
| ---------| --------| --------| -------------------| ---------|
61
- | ** v1.9** | 🟢 ** LIVE** | ` v1.9 ` | ✅ ** Visible** | Current customer documentation |
62
+ | ** v1.9** | 🟢 ** LIVE** | ` main ` | ✅ ** Visible** | Current customer documentation |
63
+ | ** v1.10** | 🟡 ** Beta** | * not created yet* | ❌ ** Hidden** | NetBox Enterprise + Assurance features |
64
+ | ** v1.11** | 🔴 ** Alpha** | * future* | ❌ ** Hidden** | NetBox Enterprise + Helm features |
65
+
66
+ #### ** Future State (After Transition)**
67
+ | Version | Status | Branch | Customer Visibility | Purpose |
68
+ | ---------| --------| --------| -------------------| ---------|
69
+ | ** v1.9** | 🟢 ** STABLE** | ` v1.9 ` | ✅ ** Visible** | Maintenance updates for current customers |
62
70
| ** v1.10** | 🟡 ** Beta** | ` v1.10 ` | ❌ ** Hidden** | NetBox Enterprise + Assurance features |
63
71
| ** v1.11** | 🔴 ** Alpha** | ` main ` | ❌ ** Hidden** | NetBox Enterprise + Helm features |
64
72
73
+ ** 🔄 Transition Note** : Currently, ` main ` branch contains v1.9 content. We will create dedicated version branches as we prepare for v1.10 and v1.11 releases.
74
+
65
75
### Where to Add New Documentation
66
76
67
- #### ✅ ** For Current Customer Issues/Fixes (v1.9)**
77
+ #### ✅ ** For Current Customer Issues/Fixes (v1.9) - CURRENT WORKFLOW **
68
78
``` bash
69
- git checkout v1.9
79
+ git checkout main # Currently contains v1.9 content
70
80
# Edit documentation for current features
71
81
git add docs/path/to/file.md
72
82
git commit -m " Fix SSL certificate installation steps"
73
- git push origin v1.9
83
+ git push origin main
74
84
git tag v1.9.1 # Automatically deploys to live site
75
85
git push origin v1.9.1
76
86
```
77
87
** Result** : ✅ Changes appear immediately on https://netboxlabs.com/docs
78
88
79
- #### 🔄 ** For NetBox Enterprise + Assurance Features (v1.10 Beta)**
89
+ #### 🔄 ** For NetBox Enterprise + Assurance Features (v1.10 Beta) - PREPARE FOR FUTURE **
80
90
``` bash
81
- git checkout v1.10 # (when branch exists)
91
+ # Branch doesn't exist yet - will be created when v1.10 development starts
92
+ # For now, document in feature branches and merge when ready
93
+
94
+ git checkout -b feature/assurance-monitoring
82
95
# Add documentation for Assurance features
83
96
git add docs/netbox-assurance/new-feature.md
84
97
git commit -m " Add documentation for network monitoring workflows"
85
- git push origin v1.10
86
- # DON'T tag yet - content stays hidden until v1.10 release
98
+ git push origin feature/assurance-monitoring
99
+ # DON'T merge to main yet - wait for v1.10 branch creation
87
100
```
88
- ** Result** : ❌ Content written but not visible to customers until activated
101
+ ** Result** : ❌ Content prepared but not visible to customers until v1.10 branch exists
89
102
90
- #### 🚀 ** For NetBox Enterprise + Helm Features (v1.11 Alpha)**
103
+ #### 🚀 ** For NetBox Enterprise + Helm Features (v1.11 Alpha) - FUTURE WORKFLOW **
91
104
``` bash
92
- git checkout main
105
+ # After v1.9 branch is created, main will be used for v1.11 development
106
+ # For now, use feature branches
107
+
108
+ git checkout -b feature/helm-deployment
93
109
# Add documentation for Helm deployment features
94
110
git add docs/netbox-enterprise/helm-installation.md
95
111
git commit -m " Add Helm deployment guide"
96
- git push origin main
97
- # DON'T tag yet - content stays hidden until v1.11 release
112
+ git push origin feature/helm-deployment
113
+ # DON'T merge to main yet - wait for branch strategy transition
98
114
```
99
- ** Result** : ❌ Content written but not visible to customers until activated
115
+ ** Result** : ❌ Content prepared but not visible to customers until workflow transition
100
116
101
117
### How Integration with Dochub Works
102
118
@@ -206,40 +222,62 @@ git push origin v1.10
206
222
### 🚨 ** Critical Rules**
207
223
208
224
#### ** DO:**
209
- - ✅ ** Always work on the correct version branch** for your content
210
- - ✅ ** Tag v1.9 changes immediately** (they go live instantly)
225
+ - ✅ ** Always work on the correct branch** for your content type
226
+ - ✅ ** Tag main branch changes immediately** (they go live as v1.9 instantly)
211
227
- ✅ ** Test your changes locally** before committing
212
228
- ✅ ** Use clear commit messages** describing what changed
213
229
- ✅ ** Check if your update applies to multiple versions**
214
230
215
231
#### ** DON'T:**
216
- - ❌ ** Never tag v1.10 or v1.11 branches** until release is approved
217
- - ❌ ** Don't merge development features into v1.9** branch
232
+ - ❌ ** Never tag future version branches** until release is approved
233
+ - ❌ ** Don't merge unreleased features into main ** (currently v1.9 live content)
218
234
- ❌ ** Don't assume all versions need the same content**
219
- - ❌ ** Don't work directly on main branch** for production fixes
235
+ - ❌ ** Don't commit untested changes ** to main branch (goes live immediately)
220
236
221
237
### 🎯 ** Quick Decision Guide**
222
238
223
239
** Ask yourself** : * "Should customers see this immediately?"*
224
240
225
- - ** YES** → Work on ` v1.9 ` branch and tag when ready
241
+ #### ** FOR TODAY (Current Workflow):**
242
+ - ** YES** → Work on ` main ` branch and tag when ready (deploys v1.9 immediately)
243
+ - ** NO, it's for Assurance features** → Work on feature branch (wait for v1.10 branch)
244
+ - ** NO, it's for Helm features** → Work on feature branch (wait for transition)
245
+
246
+ #### ** FOR FUTURE (After Transition):**
247
+ - ** YES** → Work on ` v1.9 ` branch and tag when ready
226
248
- ** NO, it's for Assurance features** → Work on ` v1.10 ` branch (don't tag)
227
249
- ** NO, it's for Helm features** → Work on ` main ` branch (don't tag)
228
250
229
251
### 📋 ** Before You Start Writing**
230
252
253
+ #### ** Today's Checklist:**
254
+ 1 . ** Is this for current customers?** → Use ` main ` branch and tag when ready
255
+ 2 . ** Is this for future features?** → Use feature branch, don't merge yet
256
+ 3 . ** Test locally** before committing to ` main `
257
+ 4 . ** Ask DevOps if unsure** about version targeting or transition timing
258
+
259
+ #### ** Future Checklist (After Transition):**
231
260
1 . ** Check which NetBox Enterprise version** the feature is targeting
232
- 2 . ** Confirm the correct branch** to work on
261
+ 2 . ** Confirm the correct version branch** to work on (v1.9, v1.10, or main)
233
262
3 . ** Understand if it's customer-ready** or still in development
234
263
4 . ** Ask DevOps if unsure** about version targeting
235
264
236
265
### 🔧 ** Technical Reference**
237
266
238
267
#### Branch Structure
268
+
269
+ ** Current State:**
270
+ ```
271
+ main # v1.9 current (Live customer docs) - VISIBLE to customers
272
+ ├── feature/* # Feature branches for future content preparation
273
+ └── versioning/* # Infrastructure branches (like feature/versioning-system)
274
+ ```
275
+
276
+ ** Future State (After Transition):**
239
277
```
240
278
main # v1.11 alpha (Helm capabilities) - HIDDEN from customers
241
279
├── v1.10 # v1.10 beta (Assurance capabilities) - HIDDEN from customers
242
- ├── v1.9 # v1.9 current (Live customer docs ) - VISIBLE to customers
280
+ ├── v1.9 # v1.9 stable (Maintenance for current customers ) - VISIBLE to customers
243
281
└── feature/* # Feature branches for new content
244
282
```
245
283
@@ -248,6 +286,37 @@ main # v1.11 alpha (Helm capabilities) - HIDDEN from customers
248
286
- ` mkdocs.yml ` - Local development configuration
249
287
- ` .github/workflows/version-deploy.yml ` - Automated deployment system
250
288
289
+ ### 🔄 ** Transition Plan**
290
+
291
+ #### ** Phase 1: Current State (Today)**
292
+ - ` main ` branch contains v1.9 documentation (customer-facing)
293
+ - Tagging ` main ` deploys v1.9 updates to live site
294
+ - Future feature development uses feature branches
295
+
296
+ #### ** Phase 2: Branch Creation (When v1.10 Development Starts)**
297
+ 1 . ** Create v1.9 maintenance branch** :
298
+ ``` bash
299
+ git checkout main
300
+ git checkout -b v1.9
301
+ git push origin v1.9
302
+ ```
303
+
304
+ 2 . ** Update main for v1.10 development** :
305
+ ``` bash
306
+ git checkout main
307
+ # Begin v1.10 (Assurance) content development
308
+ # DON'T tag main branch anymore
309
+ ```
310
+
311
+ #### ** Phase 3: Future State (When v1.11 Development Starts)**
312
+ 1 . ** Create v1.10 maintenance branch**
313
+ 2 . ** Use main for v1.11 (Helm) development**
314
+
315
+ #### ** Team Communication Points**
316
+ - 📢 ** Before Phase 2** : Announce transition timeline to documentation team
317
+ - 📢 ** During Phase 2** : Update team workflows and training
318
+ - 📢 ** After Phase 2** : Monitor and refine new branch strategy
319
+
251
320
## 🛠️ For DevOps/Maintainers: Technical Details
252
321
253
322
<details >
0 commit comments