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.
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.
- 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
- Restructure content flow to follow progressive disclosure principles
- Move index type decision to Important callout after basic upgrade steps
- Improve headings with active voice ("Switch index types anytime")
- Enhance callout formatting (Important, Tip, Warning callouts)
- Consolidate Enterprise upgrade information into dedicated section
- Improve information hierarchy and scanability
Changes are primarily formatting and phrasing improvements to enhance
developer experience and follow Google Developer Documentation best practices.
- Make TSI recommendation more actionable by explaining benefits (removes RAM limits, better performance for high-cardinality data)
- Fix "from to" grammar typos in index switching instructions
- Add specific scenarios for when to switch between TSI and inmem index types
- Remove "above" directional language per style guidelines
Source: Verified against InfluxDB v1 documentation via MCP docs verification
- TSI details: https://docs.influxdata.com/influxdb/v1/concepts/tsi-details/
- TSI overview: https://docs.influxdata.com/influxdb/v1/concepts/time-series-index/
Add exclusion pattern for hub.docker.com to both production
and default link-checker configurations.
Docker Hub often implements rate limiting and bot detection that
causes false positive link validation failures in CI environments.
Moved to new tooling repo.
Removed package scripts for now.
Script Gets commands from source code and grep docs for commands- replaces the CLI audit script- searches tagged repo branch source code for CLI commands- searches docs content the commands- allows including and excluding "categories" of docs paths to search
Running node [audit-cli-documentation.js](http://_vscodecontentref_/1) both successfully audits both Core and Enterprise
Core templates use Core-specific frontmatter
Enterprise templates use Enterprise-specific frontmatter
Fixes audit-cli-documentation.js so that it parses commands dynamically from the CLI output.
Some commands () only return top-level help output, which the script had some difficulty with.That seems mostly resolved, but might rear again.
Add exclusion patterns for StackExchange sites to both production
and default link-checker configurations:
- *.stackexchange.com
- stackoverflow.com
- *.stackoverflow.com
These sites often block automated requests/bots, causing false
positive link validation failures in CI environments.
Jason Stirnaman
Scott Anderson
Phil Bracikowski
David Rusnak
David Rusnak
dependabot[bot]
Jason Stirnaman