79 lines
3.0 KiB
Markdown
79 lines
3.0 KiB
Markdown
# Plan: Update InfluxDB 3 CLI Reference Documentation
|
|
|
|
## Automation and Process Improvements
|
|
|
|
### Immediate Improvements:
|
|
1. **Create CLI documentation sync script:**
|
|
```bash
|
|
# Script: /Users/ja/Documents/github/docs-v2/scripts/sync-cli-docs.sh
|
|
# - Extract help text from influxdb3 CLI at /Users/ja/.influxdb//influxdb3
|
|
# - Compare with existing docs
|
|
# - Generate report of differences
|
|
# - Auto-update basic command syntax
|
|
# - Real-time CLI verification capability established
|
|
```
|
|
|
|
2. **Establish documentation standards:**
|
|
- Standardize frontmatter across CLI docs
|
|
- Create templates for command documentation
|
|
- Define Enterprise vs Core content patterns using Hugo shortcodes
|
|
|
|
### Long-term Automation Strategy:
|
|
1. **CI/CD Integration:**
|
|
- Add GitHub Actions workflow to detect CLI changes
|
|
- Auto-generate CLI help extraction on new releases
|
|
- Create pull requests for documentation updates
|
|
|
|
2. **Release Process Integration:**
|
|
- Include CLI documentation review in release checklist
|
|
- Link release notes to specific CLI documentation updates
|
|
- Automated cross-referencing between release notes and CLI docs
|
|
|
|
3. **Content Management Improvements:**
|
|
- Use Hugo shortcodes for Enterprise-specific content
|
|
- Implement version-aware documentation
|
|
- Create shared content templates for common CLI patterns
|
|
|
|
## Phase 4: Validation and Testing
|
|
|
|
### Content accuracy verification:
|
|
- ✅ **CLI Access Available**: Direct verification via `influxdb3 --help` commands
|
|
- ✅ **Real-time Validation**: All commands and options verified against actual CLI output
|
|
- **Process**: Use `influxdb3 [command] --help` to validate documentation accuracy
|
|
- **Verification**: Cross-reference documented options with actual CLI behavior
|
|
|
|
### Documentation completeness check:
|
|
- Ensure all v3.2.0 features are documented
|
|
- Verify examples and use cases
|
|
- Check internal links and cross-references
|
|
|
|
## Suggested Recurring Process
|
|
|
|
### Pre-release (during development):
|
|
- Monitor CLI changes in pull requests
|
|
- Update documentation as features are added
|
|
- Maintain CLI help extraction automation
|
|
|
|
### At release (when tagging versions):
|
|
- Run automated CLI documentation sync
|
|
- Review and approve auto-generated updates
|
|
- Publish updated documentation
|
|
|
|
### Post-release (after release):
|
|
- Validate documentation accuracy
|
|
- Gather user feedback on CLI documentation
|
|
- Plan improvements for next cycle
|
|
|
|
## Related Documentation Paths
|
|
|
|
### InfluxDB 3 Product Documentation (affects CLI usage examples):
|
|
- `/content/influxdb3/core/write-data/influxdb3-cli.md`
|
|
- `/content/influxdb3/enterprise/write-data/influxdb3-cli.md`
|
|
- `/content/shared/influxdb3-write-guides/influxdb3-cli.md`
|
|
|
|
### Admin Documentation (affects retention and license features):
|
|
- `/content/influxdb3/core/admin/`
|
|
- `/content/influxdb3/enterprise/admin/`
|
|
- `/content/influxdb3/enterprise/admin/license.md`
|
|
|
|
This plan ensures comprehensive documentation updates for v3.2.0 while establishing sustainable processes for future releases. |