Skip to content

Commit fcd0b4e

Browse files
committed
Update version titles to use Beta and Alpha designations - v1.10 now titled 'v1.10 (Beta)' - v1.11 now titled 'v1.11 (Alpha)' - Update all documentation to reflect development stage terminology - Confirm v1.9 as current production version - Update content guidelines and workflow examples for Beta/Alpha stages
1 parent fb781e5 commit fcd0b4e

File tree

2 files changed

+29
-22
lines changed

2 files changed

+29
-22
lines changed

README.md

Lines changed: 25 additions & 18 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** (Development) - Upcoming release
41-
- **v1.11** (Development) - Future release
40+
- **v1.10** (Beta) - Upcoming release
41+
- **v1.11** (Alpha) - Future release
4242

4343
### Creating a New Version
4444

@@ -77,25 +77,26 @@ 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-
- **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
8182

8283
### Branch and Content Strategy
8384

8485
#### Branch Structure
8586
```
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
8990
└── feature/* # Feature branches for new content
9091
```
9192

9293
#### Where to Write Documentation
9394

9495
| Content Type | Target Branch | When to Use |
9596
|-------------|---------------|-------------|
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 |
9798
| **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) |
99100

100101
### Tagging and Release Workflow
101102

@@ -119,21 +120,21 @@ main # Latest development (v1.11 content)
119120
```
120121
**Result**: Documentation automatically deploys to production
121122

122-
2. **Future version content (v1.11)**:
123+
2. **Alpha version content (v1.11)**:
123124
```bash
124-
# Work on main branch for future features
125+
# Work on main branch for alpha features
125126
git checkout main
126127
git pull origin main
127128

128129
# Make your documentation changes for new features
129130
# Commit and push changes
130131
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)"
132133
git push origin main
133134

134-
# Don't tag yet - wait for v1.11 release
135+
# Don't tag yet - wait for v1.11 alpha release
135136
```
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
137138

138139
#### For Major Release Preparation
139140

@@ -170,12 +171,18 @@ When preparing a new major/minor version (like v1.10 or v1.11):
170171
- **Avoid**: Documentation for unreleased features
171172
- **Review**: Test all examples and procedures
172173

173-
#### Development Version (v1.11) Content
174+
#### Alpha Version (v1.11) Content
174175
- **Focus**: New features, major changes, future functionality
175176
- **Updates**: Draft documentation, work-in-progress content
176-
- **Include**: Feature flags, beta warnings if applicable
177+
- **Include**: Feature flags, alpha warnings if applicable
177178
- **Note**: Content won't be visible to customers until release
178179

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+
179186
### Common Workflows
180187

181188
#### Scenario 1: Fix Documentation Error for Current Customers
@@ -190,14 +197,14 @@ git push origin v1.9.4
190197
# Documentation automatically updates for customers
191198
```
192199

193-
#### Scenario 2: Document New Feature for Next Release
200+
#### Scenario 2: Document New Feature for Alpha Release
194201
```bash
195-
# New Jinja2 template feature added to v1.11
202+
# New Jinja2 template feature added to v1.11 (Alpha)
196203
git checkout main
197204
# Add comprehensive documentation
198205
git commit -m "Add Jinja2 conditional logic documentation"
199206
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
201208
```
202209

203210
#### Scenario 3: Backport Important Update

versions.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
{
1515
"version": "v1.10",
1616
"branch": "v1.10",
17-
"title": "v1.10 (Development)",
18-
"status": "development"
17+
"title": "v1.10 (Beta)",
18+
"status": "beta"
1919
},
2020
{
2121
"version": "v1.11",
2222
"branch": "main",
23-
"title": "v1.11 (Development)",
24-
"status": "development"
23+
"title": "v1.11 (Alpha)",
24+
"status": "alpha"
2525
}
2626
]
2727
}

0 commit comments

Comments
 (0)