docs-v2/content/shared
Jason Stirnaman 765f669d06
feat(influxdb3): document --checkpoint-interval serve option (#6896)
* feat(influxdb3): document --checkpoint-interval serve option

Add documentation for the previously undocumented --checkpoint-interval
flag, which aggregates WAL snapshot files into monthly checkpoint files
to significantly reduce server startup time.

Changes:
- config-options.md: add checkpoint-interval entry in the WAL section,
  including description, default (disabled), env var, and usage example
- performance-tuning.md: add "Startup optimization" section explaining
  the startup-time tradeoff and recommended intervals by scenario

Closes #6884

https://claude.ai/code/session_01BArJYJTXBsUjNcdTJVyg6v

* docs(influxdb3): add version metadata to checkpoint-interval heading (#6897)

* Initial plan

* feat(influxdb3): add version metadata to checkpoint-interval heading

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Apply suggestions from code review

* fix(workflows): trigger pr-preview on ready_for_review event (#6898)

* Initial plan

* fix(workflows): trigger pr-preview on ready_for_review event

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Update content/shared/influxdb3-cli/config-options.md

* fix(influxdb3): remove WAL snapshot conflation and add release note

- Replace "WAL snapshot files" with "snapshots" shorthand, linking to
  backup-restore file structure on first use
- Simplify "snapshot files"→"snapshots" and "checkpoint files"→"checkpoints"
  throughout checkpoint-interval and startup optimization sections
- Add checkpoint-interval feature to v3.8.2 release notes

Addresses review feedback from #6896.

* Update content/shared/influxdb3-cli/config-options.md

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
2026-03-06 08:11:11 -06:00
..
influxctl Move influxctl --perf-debug example output to command reference (#6599) 2025-12-22 13:11:35 -06:00
influxdb-client-libraries-reference docs(influxdb3): use shared Grafana docs for all v3 products, fix product and token naming 2025-10-04 17:36:04 -05:00
influxdb-v2 fix(version-detector): centralize Grafana links and DRY up host examples (#6693) 2026-01-26 18:42:09 -06:00
influxdb3 docs(influxdb3): Add Core to Enterprise upgrade documentation (#6758) 2026-01-27 12:16:48 -06:00
influxdb3-admin feat(influxdb3): document --checkpoint-interval serve option (#6896) 2026-03-06 08:11:11 -06:00
influxdb3-api-reference fix: LInks and headings. Replace `latest` with `v2`. Specify OSS v2 in headings. Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866, Closes Flux docs: replace `/influxdb/latest` with `/influxdb/v2` #5864. Linting cleanup, removing terminal prompt from examples 2025-02-27 17:50:16 -06:00
influxdb3-cli feat(influxdb3): document --checkpoint-interval serve option (#6896) 2026-03-06 08:11:11 -06:00
influxdb3-get-started docs(influxdb3): document how to disable Processing Engine (#6860) 2026-02-25 10:47:03 -06:00
influxdb3-internals fix(influxdb3): link fragments 2025-10-10 18:07:30 -05:00
influxdb3-internals-reference fix(influxdb3): document exec-mem-pool-bytes usage for data persistence (#6394) 2025-11-05 11:05:13 -06:00
influxdb3-plugins docs(influxdb3): document how to disable Processing Engine (#6860) 2026-02-25 10:47:03 -06:00
influxdb3-query-guides fix(influxdb3): publish parameterized queries and add HTTP API examples (#6673) 2025-12-27 15:01:20 -06:00
influxdb3-reference docs(influxdb3): document how to disable Processing Engine (#6860) 2026-02-25 10:47:03 -06:00
influxdb3-sample-data feat(sample-data): add new wind sample dataset (#6440) 2025-10-06 12:08:35 -06:00
influxdb3-visualize docs(chronograf): add instructions for use with InfluxDB3 products (#6730) 2026-01-15 13:24:09 -06:00
influxdb3-write-guides Fix line break between `influxdb3` and "CLI" in write-data intro (#6902) 2026-03-04 11:52:42 -06:00
influxql-v3-reference fix(influxdb3): publish parameterized queries and add HTTP API examples (#6673) 2025-12-27 15:01:20 -06:00
sql-reference docs(sql): add FLOAT/REAL type casting and precision info (#6856) 2026-02-24 10:05:49 -06:00
v3-core-enterprise-release-notes feat(influxdb3): document --checkpoint-interval serve option (#6896) 2026-03-06 08:11:11 -06:00
v3-distributed-admin-custom-partitions Apply suggestions from code review 2025-05-09 10:22:47 -05:00
v3-distributed-internals-reference fix(v3): Apply code review suggestions\ 2025-09-09 14:03:44 -05:00
v3-process-data fix(influxdb3): correct Quix Streams guide for Cloud Dedicated (#6828) 2026-02-17 15:23:16 -06:00
README.md chore(instruction): content/shared instructions: (#6493) 2025-10-27 20:14:05 -05:00
_index.md chore(v3): Migrate admin/custom-partitioning to shared content 2025-01-09 10:22:12 -06:00
identify-version.md docs(influxdb3): Use a GET request to check ping response headers. (#6749) 2026-01-16 20:51:49 -06:00
v3-line-protocol.md Fix link checker for fragments (#6626) 2025-12-15 09:24:43 -06:00

README.md

Shared content

This section is for content shared across multiple products and versions. The /shared/_index.md frontmatter marks the /shared directory (/content/shared) and its children as draft so they don't get rendered independently when the site is built. The content of each shared document is included and rendered in pages that reference the file as a source in their frontmatter.

Use shared content

  1. Create a new folder for the content in the /content/shared/ directory.

  2. Copy the markdown files into the new folder.

  3. Remove any frontmatter from the markdown files in the shared directory. If the first line starts with a shortcode, add an HTML comment before the first line, otherwise Hugo will err.

  4. In each of the files that use the shared content, add a source to the frontmatter that points to the shared markdown file—for example:

    source: /shared/influxql-v3-reference/regular-expressions.md
    
  5. In the doc body, remove the shared Markdown text and add a comment that points to the shared file, in case someone happens upon the page in the repo--for example, in /content/influxdb3/core/reference/influxql/regular-expressions.md, add the following:

//SOURCE is a comment anchor (recognized by the Comment Anchors editor extension) to make the file path clickable.