47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
# CLI Documentation Sync - Execution Log
|
|
|
|
## v3.2.0 Execution
|
|
|
|
### Status: Planning Complete ✅
|
|
**Date**: 2025-06-26
|
|
**Plan**: `plan-v3.2.0.md`
|
|
|
|
### Phase 1: Analysis (Not Started)
|
|
- [ ] Audit existing CLI documentation structure
|
|
- [ ] Extract v3.2.0 changes from release notes
|
|
- [ ] Generate current CLI help output
|
|
|
|
### Phase 2: Update Documentation (Not Started)
|
|
#### Files to Create:
|
|
- [ ] `/content/shared/influxdb3-cli/update/_index.md`
|
|
- [ ] `/content/shared/influxdb3-cli/update/database.md`
|
|
- [ ] `/content/shared/influxdb3-cli/update/table.md` (Enterprise)
|
|
- [ ] `/content/shared/influxdb3-cli/show/license.md` (Enterprise)
|
|
|
|
#### Files to Update:
|
|
- [ ] `/content/shared/influxdb3-cli/create/database.md` (add `--retention-period`)
|
|
- [ ] `/content/shared/influxdb3-cli/create/table.md` (add Enterprise `--retention-period`)
|
|
- [ ] `/content/shared/influxdb3-cli/show/_index.md` (add license command)
|
|
- [ ] `/content/shared/influxdb3-cli/delete/database.md` (review hard delete)
|
|
- [ ] `/content/shared/influxdb3-cli/delete/table.md` (review hard delete)
|
|
|
|
### Phase 3: Automation (Not Started)
|
|
- [ ] Create CLI documentation sync script
|
|
- [ ] Establish documentation standards
|
|
- [ ] Plan CI/CD integration
|
|
|
|
### Phase 4: Validation (Not Started)
|
|
- [ ] Test documented commands
|
|
- [ ] Verify completeness
|
|
- [ ] Check cross-references
|
|
|
|
### Notes and Lessons Learned
|
|
- Release notes analysis was crucial for identifying specific CLI changes
|
|
- Having automation scripts in place (`generate-release-notes.sh`) helped identify features
|
|
- Need to distinguish between Core and Enterprise features clearly
|
|
|
|
### Next Actions
|
|
When ready to execute:
|
|
1. Reference plan: `@plans/cli-docs-sync/plan-v3.2.0.md`
|
|
2. Start with Phase 1 analysis
|
|
3. Update this log as progress is made |