* chore: Standard exclude comment format to denote flags, options, etc. that shouldn't be promoted in docs
* chore: exclude internal flags
* chore: Add docs:exclude comments for internal CLI flags, fix linting
- Note internal options that should be ignored by `docs audit` and authors.
- Remove character escaping from GitHub callouts and placeholders
Lint config changes:
- Add explicit exclude for content/**/*.md in lint-markdown-instructions
- Exclude all markdown files from Prettier formatting
Fixes issue where remark-lint was auto-formatting content files and
escaping special characters like [!Note] callouts and underscores.
* fix: cleanup escaping
* fix(influxdb3): document exec-mem-pool-bytes usage for data persistence
Updates documentation to reflect that exec-mem-pool-bytes is used for both
query processing and parquet persistence operations, not just queries.
Based on source code analysis showing the memory pool is used by:
- Query executor for processing queries
- Persister for converting WAL data to Parquet format
Changes:
- Updated config description to include "data operations"
- Added memory usage info to durability docs for Parquet storage
- Added troubleshooting section for memory-related write performance
- Fixed capitalization of "object store" throughout
Addresses DAR #499
Source analysis: influxdb3/src/commands/serve.rs:772-798
Shows separate executors for queries and write path operations,
both using memory pools for data processing.
* fix(influxdb3): broken links to no-sync
* fix(influxdb3): override PLUGIN_DIR env var in compose services to match --plugin-dir
- Set INFLUXDB3_PLUGIN_DIR=/var/lib/influxdb3/plugins in both influxdb3-core and influxdb3-enterprise services
- Overrides Docker image default (/plugins) to match --plugin-dir command argument
- Ensures package installation works correctly with bind-mounted plugin directory
- Update influxdb3 install package CLI documentation with complete options reference
* docs(influxdb3): add Docker disk space troubleshooting for package installation
Add troubleshooting section for 'No space left on device' errors when installing packages in Docker environments. Includes commands to check Docker disk usage and clean up unused images and build cache.
Also fix Vale linting errors by changing 'URL' to 'url'.
* Apply suggestion from @jstirnaman
* fix(ci): Vale rules for URL/-url-/WAL/-wal-/Parquet/-parquet-:
1. Simplified the Parquet vocabulary entry from the regex to just Parquet
2. Added separate regex patterns for hyphenated identifiers
* feat(influxdb3): describe use cases and effects of --package-manager disabled
* feat(influxdb3): Core and Ent performance tuning guide:Add an admin/performance-tuning/ page with specific workload and capacity configurations.Part of #6403.
* fix(influxdb3): product-specific link fragments for flags
* fix(influxdb3): enterprise-specific link fragments
* Apply suggestion from @jstirnaman
* fix(influxdb3): duplicate licensing and resource limits sections- Rem… (#6470)
* fix(influxdb3): duplicate licensing and resource limits sections- Remove duplicate licensing section- Resolve resource limits duplicates, merging details into the Resource limits section.
* fix(influxdb3): fix broken links and enterprise-only flags in config options
- Comment out TOC links to undocumented datafusion-runtime-* dev flags
- Wrap enterprise-only section references (#licensing, #resource-limits) in conditionals
- Fix num-datafusion-threads incorrectly marked as enterprise-only
- Move Resource Limits section heading outside enterprise wrapper
Resolves broken fragment links for both Core and Enterprise builds.
* feat(enterprise): add cluster management documentation (#6431)
Add comprehensive guide for managing InfluxDB 3 Enterprise clusters including:
- Node configuration and deployment
- Cluster initialization and scaling
- Node removal and replacement procedures
- Best practices for production deployments
* Fixes multiple influxdb3 config option issues:
- Fixed option placement (global vs serve options) in performance-tuning.md
- Fixed --datafusion-num-threads option name (was --num-datafusion-threads)
- Fixed --parquet-mem-cache-size option name and defaults for Core
- Commented out unreleased --compaction-row-limit option
- Added v3.0.0 breaking changes to release notes
- Updated config-options.md with correct defaults and value formats
All changes verified against InfluxDB v3.5.0 release binaries and git history.
* fix(influxdb3): config options in clustering.md
- Correctly place server options
- Comment out unreleased options
* docs(cli): fix global vs serve-specific flag documentation
- Remove --verbose from global flags (it's serve-specific)
- Document --num-io-threads as global-only flag
- Add clear examples showing correct flag positioning
- Update serve.md files with global flag usage notes
- Fix config-options.md to separate Core/Enterprise examples
Resolves incorrect CLI usage patterns that would cause errors.
Global flags must go before 'serve', serve-specific flags go after.
* docs(cli): remove Tokio runtime options from CLI index pages
- Remove detailed Tokio runtime options tables from CLI index pages
- Replace with simplified global options and link to config-options
- Add examples showing correct global flag positioning
- Fix --verbose usage to be serve-specific (after serve command)
- Add --num-io-threads example as global flag (before serve command)
These detailed options are now documented in config-options.md with
proper global vs serve-specific categorization.
Removed ")" in --exec-mem-pool-bytes as typo.
Added format information for --wal-flush-interval and 100ms suggestion from @peterbarnett03 in discord chat.
* update: add 3.4 notes
* update: 3.4 notes
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/shared/v3-core-enterprise-release-notes/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* feat(influxdb-3.4): added cli updates for influxdb 3.4
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: add whitespace to influxdb3 write doc
* fix(data): update patch versions for core and enterprise
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
---------
Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Updated /content/influxdb3/core/reference/cli/influxdb3/serve.md with 84 Core-compatible options
- Excluded 21 Enterprise-only options (like cluster-id, license-email, license-file, mode, compaction options, clustering options, etc.)
- All options now link to the Core configuration documentation
- Fixed the environment variables link to point to Core instead of Enterprise
2. Updated Enterprise serve.md Options Section
- Updated /content/influxdb3/enterprise/reference/cli/influxdb3/serve.md with all 105 configuration options
- Includes both Core and Enterprise-only options
- Maintains proper required option markers for node-id and cluster-id
- All options link to the Enterprise configuration documentation
3. Verified Content Consistency
- Core serve.md: Contains examples without cluster-id parameter (appropriate for Core)
- Enterprise serve.md: Contains examples with both node-id and cluster-id parameters, plus Enterprise-specific mode examples
- Both maintain consistent structure and troubleshooting sections appropriate to their respective products
- Environment variables sections correctly reference their respective configuration documentation
4. Allow Vale to accept "parquet" in lowercase when it appears in:
- Command-line options (e.g., --parquet-mem-cache-size)
- Hyphenated configuration names (e.g., parquet-mem-cache-prune-interval)
- Code blocks or inline code (e.g., `parquet`)
Key Changes Made:
- Core: Now includes 84 options (was 69), excluding Enterprise-only features
- Enterprise: Now includes all 105 options (was 78), comprehensive coverage
- Alphabetical ordering: Both option tables are now properly alphabetized
- New options added: Many previously missing options like buffer-mem-limit-mb, tcp-listener-file-path, telemetry-*, wal-replay-*, etc.
- Proper segregation: Core users no longer see Enterprise-only configuration options
- Vale allows Parquet or parquet in the appropriate context
Jason Stirnaman
peterbarnett03
Jason Stirnaman
jaal2001
Scott Anderson
Scott Anderson