|
| 1 | +# Plan: Update InfluxDB 3 CLI Reference Documentation for v3.2.0 |
| 2 | + |
| 3 | +## Phase 1: Analyze Current State and Changes |
| 4 | + |
| 5 | +### 1. Audit existing CLI documentation structure |
| 6 | +**Existing files in `/content/shared/influxdb3-cli/`:** |
| 7 | +- `/content/shared/influxdb3-cli/create/_index.md` |
| 8 | +- `/content/shared/influxdb3-cli/create/database.md` ⚠️ **NEEDS UPDATE** (add `--retention-period`) |
| 9 | +- `/content/shared/influxdb3-cli/create/distinct_cache.md` |
| 10 | +- `/content/shared/influxdb3-cli/create/file_index.md` |
| 11 | +- `/content/shared/influxdb3-cli/create/last_cache.md` |
| 12 | +- `/content/shared/influxdb3-cli/create/table.md` ⚠️ **NEEDS UPDATE** (add Enterprise `--retention-period`) |
| 13 | +- `/content/shared/influxdb3-cli/create/token/_index.md` |
| 14 | +- `/content/shared/influxdb3-cli/create/token/admin.md` |
| 15 | +- `/content/shared/influxdb3-cli/create/trigger.md` |
| 16 | +- `/content/shared/influxdb3-cli/delete/_index.md` |
| 17 | +- `/content/shared/influxdb3-cli/delete/database.md` ⚠️ **REVIEW** (hard delete features) |
| 18 | +- `/content/shared/influxdb3-cli/delete/distinct_cache.md` |
| 19 | +- `/content/shared/influxdb3-cli/delete/file_index.md` |
| 20 | +- `/content/shared/influxdb3-cli/delete/last_cache.md` |
| 21 | +- `/content/shared/influxdb3-cli/delete/table.md` ⚠️ **REVIEW** (hard delete features) |
| 22 | +- `/content/shared/influxdb3-cli/delete/trigger.md` |
| 23 | +- `/content/shared/influxdb3-cli/disable/_index.md` |
| 24 | +- `/content/shared/influxdb3-cli/disable/trigger.md` |
| 25 | +- `/content/shared/influxdb3-cli/enable/_index.md` |
| 26 | +- `/content/shared/influxdb3-cli/enable/trigger.md` |
| 27 | +- `/content/shared/influxdb3-cli/query.md` |
| 28 | +- `/content/shared/influxdb3-cli/show/_index.md` ⚠️ **NEEDS UPDATE** (add license command) |
| 29 | +- `/content/shared/influxdb3-cli/show/databases.md` |
| 30 | +- `/content/shared/influxdb3-cli/show/system/_index.md` |
| 31 | +- `/content/shared/influxdb3-cli/show/system/summary.md` |
| 32 | +- `/content/shared/influxdb3-cli/show/system/table-list.md` |
| 33 | +- `/content/shared/influxdb3-cli/show/system/table.md` |
| 34 | +- `/content/shared/influxdb3-cli/show/tokens.md` |
| 35 | +- `/content/shared/influxdb3-cli/test/_index.md` |
| 36 | +- `/content/shared/influxdb3-cli/test/schedule_plugin.md` |
| 37 | +- `/content/shared/influxdb3-cli/test/wal_plugin.md` |
| 38 | +- `/content/shared/influxdb3-cli/write.md` |
| 39 | + |
| 40 | +### 2. Extract v3.2.0 changes from release notes |
| 41 | +**From `/content/shared/v3-core-enterprise-release-notes/_index.md`:** |
| 42 | + |
| 43 | +**Core v3.2.0 Features:** |
| 44 | +- Database retention period support: `create database --retention-period`, `update database --retention-period` |
| 45 | +- Hard delete for databases and tables |
| 46 | +- AWS credentials auto-reload |
| 47 | +- WAL improvements |
| 48 | + |
| 49 | +**Enterprise v3.2.0 Features:** |
| 50 | +- License management: `influxdb3 show license` |
| 51 | +- Table retention period support: `create table --retention-period`, `update table --retention-period` |
| 52 | +- All Core features plus Enterprise-specific enhancements |
| 53 | + |
| 54 | +### 3. Generate current CLI help output |
| 55 | +- Run `influxdb3 --help` for both Core and Enterprise versions |
| 56 | +- Extract new commands, options, and help text |
| 57 | +- Compare with existing documentation |
| 58 | + |
| 59 | +## Phase 2: Update Documentation Files |
| 60 | + |
| 61 | +### Files to Create (NEW): |
| 62 | +- `/content/shared/influxdb3-cli/update/_index.md` 🆕 |
| 63 | +- `/content/shared/influxdb3-cli/update/database.md` 🆕 (retention period management) |
| 64 | +- `/content/shared/influxdb3-cli/update/table.md` 🆕 (Enterprise-only, retention period management) |
| 65 | +- `/content/shared/influxdb3-cli/show/license.md` 🆕 (Enterprise-only) |
| 66 | + |
| 67 | +### Files to Update (EXISTING): |
| 68 | +- `/content/shared/influxdb3-cli/create/database.md` ⚠️ (add `--retention-period` option) |
| 69 | +- `/content/shared/influxdb3-cli/create/table.md` ⚠️ (add Enterprise `--retention-period` option) |
| 70 | +- `/content/shared/influxdb3-cli/show/_index.md` ⚠️ (include license command) |
| 71 | +- `/content/shared/influxdb3-cli/delete/database.md` ⚠️ (review hard delete options) |
| 72 | +- `/content/shared/influxdb3-cli/delete/table.md` ⚠️ (review hard delete options) |
| 73 | + |
| 74 | +### Content Changes by Category: |
| 75 | + |
| 76 | +**1. Retention Period Documentation:** |
| 77 | +- Update `/content/shared/influxdb3-cli/create/database.md` with `--retention-period` option |
| 78 | +- Create `/content/shared/influxdb3-cli/update/` directory structure |
| 79 | +- Create `/content/shared/influxdb3-cli/update/database.md` for retention management |
| 80 | +- Update `/content/shared/influxdb3-cli/create/table.md` with Enterprise `--retention-period` option |
| 81 | +- Create `/content/shared/influxdb3-cli/update/table.md` for Enterprise table retention management |
| 82 | + |
| 83 | +**2. License Management Documentation:** |
| 84 | +- Update `/content/shared/influxdb3-cli/show/_index.md` to include license command |
| 85 | +- Create `/content/shared/influxdb3-cli/show/license.md` for Enterprise license display |
| 86 | + |
| 87 | +**3. Hard Delete Documentation:** |
| 88 | +- Review and update `/content/shared/influxdb3-cli/delete/database.md` with hard delete options |
| 89 | +- Review and update `/content/shared/influxdb3-cli/delete/table.md` with hard delete options |
| 90 | + |
| 91 | +## Phase 3: Automation and Process Improvements |
| 92 | + |
| 93 | +### Immediate Improvements: |
| 94 | +1. **Create CLI documentation sync script:** |
| 95 | + ```bash |
| 96 | + # Script: /Users/ja/Documents/github/docs-v2/scripts/sync-cli-docs.sh |
| 97 | + # - Extract help text from influxdb3 CLI |
| 98 | + # - Compare with existing docs |
| 99 | + # - Generate report of differences |
| 100 | + # - Auto-update basic command syntax |
| 101 | + ``` |
| 102 | + |
| 103 | +2. **Establish documentation standards:** |
| 104 | + - Standardize frontmatter across CLI docs |
| 105 | + - Create templates for command documentation |
| 106 | + - Define Enterprise vs Core content patterns using Hugo shortcodes |
| 107 | + |
| 108 | +### Long-term Automation Strategy: |
| 109 | +1. **CI/CD Integration:** |
| 110 | + - Add GitHub Actions workflow to detect CLI changes |
| 111 | + - Auto-generate CLI help extraction on new releases |
| 112 | + - Create pull requests for documentation updates |
| 113 | + |
| 114 | +2. **Release Process Integration:** |
| 115 | + - Include CLI documentation review in release checklist |
| 116 | + - Link release notes to specific CLI documentation updates |
| 117 | + - Automated cross-referencing between release notes and CLI docs |
| 118 | + |
| 119 | +3. **Content Management Improvements:** |
| 120 | + - Use Hugo shortcodes for Enterprise-specific content |
| 121 | + - Implement version-aware documentation |
| 122 | + - Create shared content templates for common CLI patterns |
| 123 | + |
| 124 | +## Phase 4: Validation and Testing |
| 125 | + |
| 126 | +### Content accuracy verification: |
| 127 | +- Test all documented commands and options against actual CLIs |
| 128 | +- Verify Enterprise vs Core feature availability |
| 129 | +- Cross-reference with actual CLI behavior |
| 130 | + |
| 131 | +### Documentation completeness check: |
| 132 | +- Ensure all v3.2.0 features are documented |
| 133 | +- Verify examples and use cases |
| 134 | +- Check internal links and cross-references |
| 135 | + |
| 136 | +## Suggested Recurring Process |
| 137 | + |
| 138 | +### Pre-release (during development): |
| 139 | +- Monitor CLI changes in pull requests |
| 140 | +- Update documentation as features are added |
| 141 | +- Maintain CLI help extraction automation |
| 142 | + |
| 143 | +### At release (when tagging versions): |
| 144 | +- Run automated CLI documentation sync |
| 145 | +- Review and approve auto-generated updates |
| 146 | +- Publish updated documentation |
| 147 | + |
| 148 | +### Post-release (after release): |
| 149 | +- Validate documentation accuracy |
| 150 | +- Gather user feedback on CLI documentation |
| 151 | +- Plan improvements for next cycle |
| 152 | + |
| 153 | +## Related Documentation Paths |
| 154 | + |
| 155 | +### InfluxDB 3 Product Documentation (affects CLI usage examples): |
| 156 | +- `/content/influxdb3/core/write-data/influxdb3-cli.md` |
| 157 | +- `/content/influxdb3/enterprise/write-data/influxdb3-cli.md` |
| 158 | +- `/content/shared/influxdb3-write-guides/influxdb3-cli.md` |
| 159 | + |
| 160 | +### Admin Documentation (affects retention and license features): |
| 161 | +- `/content/influxdb3/core/admin/` |
| 162 | +- `/content/influxdb3/enterprise/admin/` |
| 163 | +- `/content/influxdb3/enterprise/admin/license.md` |
| 164 | + |
| 165 | +This plan ensures comprehensive documentation updates for v3.2.0 while establishing sustainable processes for future releases. |
0 commit comments