Commit Graph

9678 Commits (create-your-own-docs-tutorial)

Author SHA1 Message Date
Jason Stirnaman 863052bb94 chore(instruction): tutorial improvements and fixes 2025-10-31 13:44:47 -05:00
Jason Stirnaman 6f150048ff chore(docs): Add content/create.md tutorial page for the How to create your own documentation tutorial 2025-10-31 13:44:47 -05:00
Scott Anderson ffbe4e5e18
chore: update notifications for InfluxDB 3.6 release (#6498)
* chore: update notifications for InfluxDB 3.6 release

Updated the notifications for InfluxDB version 3.6, including changes to the title, slug, and message content.

* Update data/notifications.yaml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-30 11:04:04 -04:00
Jason Stirnaman 1b57292191
feat: functional changes (#6500)
* feat: functional changes

* fix: remove serve inaccuracies

* fix: remove opining

---------

Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
2025-10-30 09:52:25 -05:00
peterbarnett03 cc36a19a17
feat: 3.6 release notes (#6499)
* feat: 3.6 release notes

* Update content/shared/v3-core-enterprise-release-notes/_index.md

* Update content/shared/v3-core-enterprise-release-notes/_index.md

* chore(influxdb3): Core/Ent 3.6, Explorer 1.4 release

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-10-30 09:31:05 -05:00
Dustin Eaton b3d9219412
chore: update to working kubit and kubectl versions (#6496) 2025-10-29 08:28:39 -05:00
Jason Stirnaman 56b459659d
Jts agentsmd (#6486)
* feat(docs): add content scaffolding system with AI-powered analysis

Add yarn docs:create command for intelligent content scaffolding:

- Phase 1: Script analyzes draft and repository structure
- Phase 2: Claude command generates file structure and frontmatter
- Phase 3: Script creates files from proposal

New files:
- scripts/docs-create.js: Main orchestration script
- scripts/lib/content-scaffolding.js: Core scaffolding logic
- scripts/lib/file-operations.js: File I/O utilities
- .claude/commands/scaffold-content.md: Claude analysis command

Features:
- Intelligent product detection (Core, Enterprise, Cloud, etc.)
- Generates complete frontmatter
- Dry-run and interactive confirmation modes

Usage:
  yarn docs:create --from path/to/draft.md
  /scaffold-content
  yarn docs:create --execute

* chore(scripts): docs:create and docs:edit scripts for content creation and editing
2025-10-28 07:20:13 -05:00
Jason Stirnaman 624c6ad0d8
Jts contrib and linting fixes (#6494)
* feat(ci): improve linting configuration for instruction files

- Add GitHub-flavored Markdown support with remark-gfm
- Create generic Vale config (.vale-instructions.ini) for instruction files
- Use pattern-based file inclusion instead of explicit file lists
- Mount repository to /workdir in remark-lint container to preserve node_modules

Changes:
- Add remark-gfm to .ci/remark-lint/package.json
- Create .remarkrc.yaml at repository root for instruction files
- Update content/.remarkrc.yaml to include remark-gfm
- Create .vale-instructions.ini for generic writing rules
- Update compose.yaml: mount repo to /workdir (preserves /app/node_modules)
- Update lefthook.yml: use glob patterns for uppercase .md files and .github/**/*.md
- Update DOCS-CONTRIBUTING.md: remove empty CONTRIBUTING.md directory reference

Benefits:
- Automatic inclusion of new instruction files without config updates
- Pattern matching for uppercase .md files (DOCS-*.md, CLAUDE.md, etc.)
- Coverage for .github/, .claude/, api-docs/ directories
- GFM features: tables, task lists, strikethrough, autolinks, footnotes
- Separate linting rules for instruction files vs product documentation

feat(lint): separate remark-lint auto-fix for instructions vs report-only for content

- Split lint-markdown into two hooks:
  - lint-markdown-instructions: Auto-fixes README, DOCS-*.md, .github/**, .claude/**
  - lint-markdown-content: Reports issues in content/**, api-docs/** without modifying
- Changed remark-lint volume mount from read_only: true to read_only: false
- Instruction files now behave like Prettier (auto-fix + stage)
- Content files report errors and block commits until manually fixed

* chore(instructions): Add content/shared details, husky/lefthook updates
2025-10-27 20:24:25 -05:00
Jason Stirnaman 56c173ec33
chore(instruction): content/shared instructions: (#6493)
* chore(instruction): content/shared instructions:

* Apply suggestion from @jstirnaman
2025-10-27 20:14:05 -05:00
Jason Stirnaman e3bfd39489
chore(instructions): Agents file initial commit (#6492) 2025-10-27 19:59:08 -05:00
Scott Anderson a43a880f2f
hotfix: Add support for .msi and .pqx file types 2025-10-27 19:19:00 -04:00
peterbarnett03 5169477f52
fix: Add '--database' flag to update database commands (#6491)
Had user feedback and have validated the flag is needed.
2025-10-27 08:34:36 -07:00
Jason Stirnaman a584807f1f
feat(influxdb3): Core/Enterprise: Upgrade instance or cluster:- Addre… (#6483)
* feat(influxdb3): Core/Enterprise: Upgrade instance or cluster:- Addresses recent internal requests for upgrade steps- Provide examples for Core or Enterprise single node (instance)- Provide steps recommended by Engineering and examples- Link from related pages

* Apply suggestion from @sanderson

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestion from @sanderson

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestion from @sanderson

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestion from @sanderson

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestion from @sanderson

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* docs(enterprise): clarify catalog version constraints for v3.3.x to v3.4.x upgrade

- Specify that catalog modification constraint applies when upgrading from v3.3.x (or earlier) to v3.4.x
- Add troubleshooting section noting that different version transitions may have different constraints
- Direct users to check release notes for version-specific upgrade requirements

Resolves review comment from hiltontj about catalog version boundaries.

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-10-25 07:42:53 -05:00
Jason Stirnaman f9435b0cf8
chore(enterprise_influxdb): specify Enterprise v1 and remove new sign… (#6485)
* chore(enterprise_influxdb): specify Enterprise v1 and remove new signup notes:

- Removes instructions for new signups at portal.influxdata (at Marketing's request)
- Uses Enterprise v1 in titles and descriptions
- Updates title metadata template to use InfluxDB Enterprise v1
- Updates products.yml to use InfluxDB Enterprise v1
- Removes unused enterprise-name/-link shortcodes

I chose InfluxDB Enterprise v1 over InfluxDB v1 Enterprise due to recent usage patterns and because it's compatible with uses like "InfluxDB Enterprise 1.11.x" without being redundant.

* Apply suggestion from @jstirnaman

* Apply suggestion from @jstirnaman

* Apply suggestion from @jstirnaman
2025-10-24 12:52:47 -05:00
Gary Fowler 872f07593d
Update InfluxDB Enterprise introduction content (#6484)
Removed sign-up instructions for InfluxDB Enterprise.
2025-10-24 07:14:26 -05:00
epgif c248d9f588
fix: Update system_metrics path (#6481)
Move from 'examples' to 'influxdata' in influxdata/influxdb3_plugins#17
2025-10-23 15:03:26 -05:00
Jason Stirnaman 61269f3823
fix(influxdb3): (#6479)
- malformed link
- update broken link fragements
- link to plugin docs at /telegraf instead of GitHub\
- Remove language fragments from tabs
2025-10-22 00:50:02 -05:00
Jason Stirnaman 17558b8207
Jts 6477 fix writelp precision (#6478)
* docs(influxdb3): update write endpoint recommendations and add Telegraf guidance

- Update write endpoint recommendations for Core/Enterprise
- Add Telegraf output plugin guidance (v1.x and v2.x)
- Improve introductory content and formatting
- Change Note to Tip for write endpoint recommendations
- Add italics to v1/v2 for clarity

* docs(influxdb3): add precision parameter comparison and format details

- Add precision comparison table across v1, v2, v3 write APIs
- Document auto precision detection with exponential notation (5e9, 5e12, 5e15)
- Add tabbed code examples for different precision values
- Update OpenAPI specs with long-form precision values only (auto, nanosecond, microsecond, millisecond, second)
- Add timestamp conversion details for internal storage
- Use long-form precision values in all examples

Note: Currently /api/v3/write_lp only supports long forms despite source code indicating short form support.
Related to #6472 - precision parameter behavior may have bugs
2025-10-21 21:10:27 -05:00
Jason Stirnaman a30345170c
Core and Ent3 performance tuning guide and configuration options (#6421)
* 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
2025-10-21 13:14:31 -05:00
Sven Rebhan 9606e1bd3e
Telegraf v1.36.3 (#6473)
* Updating changelog

* Updating product version

* Updating plugins
2025-10-21 12:23:21 -05:00
Jason Stirnaman 20562d5bb6
Automate plugin documentation sync workflow between influxdb3_plugins and docs-v2 (#6329)
* feat(plugins): add automated plugin documentation sync workflow

- Add GitHub Actions workflow for syncing plugin docs from influxdb3_plugins
- Create issue template for triggering sync requests
- Add Node.js transformation script (port_to_docs.js) with ES modules
- Add mapping configuration (docs_mapping.yaml) for all official plugins
- Add npm scripts for plugin sync operations
- Include comprehensive documentation in helper-scripts/influxdb3-plugins/README.md

The workflow provides:
- Issue-triggered automation with no cross-repo secrets required
- Validation of source READMEs against template requirements
- Content transformation with Hugo shortcodes and GitHub URLs
- Screenshot generation for visual validation
- Automatic PR creation with detailed change summaries

* Updated source paths in docs_mapping.yaml to use ./influxdb3_plugins/ instead of ../influxdb3_plugins/ to match what the
  GitHub Actions workflow expects when it clones the
  repository:

  1. GitHub Actions workflow clones to ./influxdb3_plugins/
  2. docs_mapping.yaml references
  ./influxdb3_plugins/influxdata/[plugin]/README.md
  3. Local development can manually clone the repo to the same
   location for testing

  Tupdated all the source paths in
  docs_mapping.yaml to use ./influxdb3_plugins/ instead of
  ../influxdb3_plugins/. This now matches exactly what the
  GitHub Actions workflow expects when it clones the
  repository.

  The paths are now consistent:

  1. GitHub Actions workflow clones to ./influxdb3_plugins/
  2. docs_mapping.yaml references
  ./influxdb3_plugins/influxdata/[plugin]/README.md
  3. Local development can manually clone the repo to the same
   location for testing

  This resolves the inconsistency and makes the automation
  more reliable. For local development, developers would
  just need to run:

  git clone
  https://github.com/influxdata/influxdb3_plugins.git

  From the docs-v2 root directory, and then they can use the
  same paths that the automation uses.

* Updated source paths in docs_mapping.yaml to use ./influxdb3_plugins/ instead of ../influxdb3_plugins/ to match what the
  GitHub Actions workflow expects when it clones the
  repository:

  1. GitHub Actions workflow clones to ./influxdb3_plugins/
  2. docs_mapping.yaml references
  ./influxdb3_plugins/influxdata/[plugin]/README.md
  3. Local development can manually clone the repo to the same
   location for testing

  Tupdated all the source paths in
  docs_mapping.yaml to use ./influxdb3_plugins/ instead of
  ../influxdb3_plugins/. This now matches exactly what the
  GitHub Actions workflow expects when it clones the
  repository.

  The paths are now consistent:

  1. GitHub Actions workflow clones to ./influxdb3_plugins/
  2. docs_mapping.yaml references
  ./influxdb3_plugins/influxdata/[plugin]/README.md
  3. Local development can manually clone the repo to the same
   location for testing

  This resolves the inconsistency and makes the automation
  more reliable. For local development, developers would
  just need to run:

  git clone
  https://github.com/influxdata/influxdb3_plugins.git

  From the docs-v2 root directory, and then they can use the
  same paths that the automation uses.

* Jmercer/plugin sync test (#6468)

* fix: update workflow branch references from master to main

* fix: update issue template branch references from master to main

- Update sync-plugin-docs.yml description (line 40)
- Update placeholder from 'master' to 'main' (line 41)
- Update default value from 'master' to 'main' (line 42)
- Add influxdb3_plugins/ to .gitignore
- Ensures template matches influxdb3_plugins default branch

* Update .gitignore

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Update docs_mapping.yaml

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply suggestion from @jstirnaman

* Apply suggestion from @jstirnaman

* Apply suggestion from @jstirnaman

* Apply suggestion from @jstirnaman

* Use <docs-root>/.ext/influxdb3_plugins for the source path

---------

Co-authored-by: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-20 17:18:34 -05:00
Jameelah Mercer a23bc0a072
Merge pull request #6331 from influxdata/feature/cloud-dedicated-user-management-docs
feat: add user management documentation for InfluxDB Cloud Dedicated Admin UI
2025-10-20 10:01:49 -07:00
meelahme d5a55bef8c Merge branch 'feature/cloud-dedicated-user-management-docs' of github.com:influxdata/docs-v2 into feature/cloud-dedicated-user-management-docs 2025-10-20 09:58:15 -07:00
Jameelah Mercer c0cf22c166 Merge branch 'master' into feature/cloud-dedicated-user-management-docs 2025-10-20 09:58:00 -07:00
Jameelah Mercer d30ffb33a4
Merge branch 'master' into feature/cloud-dedicated-user-management-docs 2025-10-20 09:51:41 -07:00
meelahme 142b82785b updating broken link in _index.md 2025-10-20 09:48:31 -07:00
meelahme 5afb288b08 updating broken link 2025-10-20 09:35:53 -07:00
Jameelah Mercer 856c40be00
Merge pull request #6467 from influxdata/fix/6432-update-docker-compose-v2-commands
Fix #6432: Update docker-compose to docker compose commandsRetry
2025-10-20 09:17:03 -07:00
Jameelah Mercer d9f35b89ea
Merge branch 'master' into fix/6432-update-docker-compose-v2-commands 2025-10-20 09:10:25 -07:00
Jameelah Mercer 54fc68edf0
Update content/influxdb3/cloud-dedicated/process-data/visualize/superset.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-10-20 09:10:15 -07:00
Jason Stirnaman 9729ef04b8
fix(clustered): add license renewal troubleshooting steps (#6397)
Addresses DAR #470 by documenting:
- Expected kubectl warning that can be safely ignored
- Troubleshooting steps for 'no license found' errors after renewal
- Service restart workaround when validation doesn't auto-detect new license
- License validation timing information

closes influxdata/DAR#470
2025-10-20 11:05:29 -05:00
Jason Stirnaman 06512e3e93
Merge branch 'master' into fix/6432-update-docker-compose-v2-commands 2025-10-20 10:56:04 -05:00
Jason Stirnaman cfe1d32f24
Merge branch 'master' into feature/cloud-dedicated-user-management-docs 2025-10-20 10:52:19 -05:00
Jason Stirnaman ca24b3be54
Influxdb3 config options (#6419)
* 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.
2025-10-20 10:17:56 -05:00
Jameelah Mercer 36b09a4605
Update content/influxdb3/cloud-dedicated/process-data/visualize/superset.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-17 12:08:23 -07:00
Jameelah Mercer bba045aeeb
Merge branch 'master' into fix/6432-update-docker-compose-v2-commands 2025-10-17 12:04:18 -07:00
Jameelah Mercer e17c8e1da8
Merge pull request #6465 from influxdata/fix/python-dir-requirement-6366
fix(influxdb3): add python directory requirement note to plugins setup
2025-10-17 12:03:49 -07:00
meelahme cd79e3503d Fix #6432: fix broken links 2025-10-17 12:03:07 -07:00
meelahme 7785503680 Merge branch 'fix/6432-update-docker-compose-v2-commands' of github.com:influxdata/docs-v2 into fix/6432-update-docker-compose-v2-commands 2025-10-17 11:43:25 -07:00
Jameelah Mercer d972020976
Merge branch 'master' into fix/6432-update-docker-compose-v2-commands 2025-10-17 11:43:09 -07:00
meelahme 986ead55c6 minor update to instal prereq 2025-10-17 11:42:55 -07:00
meelahme 1639bde073 Fix #6432: Update docker-compose to docker compose commandsRetry 2025-10-17 11:39:21 -07:00
meelahme 059d60117c update to title in importatnt note to make it more clear 2025-10-17 11:19:46 -07:00
meelahme 9e767bcd63 fixing filesystem-diagram 2025-10-17 10:55:09 -07:00
Jameelah Mercer 631fb5c802
Update content/shared/influxdb3-plugins/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-10-17 10:41:00 -07:00
Jameelah Mercer f1dc112f43
Update content/shared/influxdb3-get-started/processing-engine.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-10-17 10:40:45 -07:00
Jameelah Mercer e8716714e6
Merge branch 'master' into feature/cloud-dedicated-user-management-docs 2025-10-17 09:58:41 -07:00
Jameelah Mercer b9bdb131d5
Merge branch 'master' into fix/python-dir-requirement-6366 2025-10-17 09:53:15 -07:00
Scott Anderson f272a980ec hotfix: add horizontal rules to influxctl release notes 2025-10-17 10:32:32 -06:00
Dustin Eaton 608b767c02
Influxctl v2.11.0 (#6466)
* Release influxctl v2.11.0

* chore(influxctl): add influxctl 2.11.0 release notes
2025-10-17 10:31:08 -06:00