- Adds missing examples for v1-compatible /query
- Fixes curl params in examples
- Removes unsupported async option from examples
- Updates terms for consistency with branding and influxdb3 docs
- Copies the missing POST /query operation from swaggerv1compat to the v2 ref.yml
- Effectively removes the separate v1-compat spec, and adds redirects and tags for v1-compat endpoints in v2/ref.yml
- Updates affected links
helper-scripts directory to:
1. Main helper-scripts/README.md:
Updated to describe
generate-release-notes.js instead of
the old bash script, including new
configuration options and examples.
2. helper-scripts/common/README.md:
Updated to describe the JavaScript
version with all its new features like
configuration files,
integrated/separated formats, and PR
link options.
3. helper-scripts/influxdb3-monolith/RE
ADME.md: Completely updated to reflect
the actual JavaScript scripts present
(audit-cli-documentation.js and
apply-cli-patches.js) instead of the
non-existent bash scripts, updated
prerequisites, examples, and workflow
documentation.
that provides Claude with detailed instructions
for enhancing release notes.
The command includes specific transformation
patterns for different components (database, CLI,
API, etc.) and provides fallback templates for
handling edge cases. It also includes error
handling for common issues like rate limits and
private repositories.
script with the following improvements:
1. Renamed output formats:
- standard → integrated: All repositories' changes are
integrated together
- core-enterprise → separated: Primary repository
first, then secondary repositories
2. Generalized the separated format:
- Configurable primary repository (by name or index)
- Customizable section labels and headers
- Flexible template system for different products
3. Enhanced configuration system:
- Per-repository PR link settings
- Full template customization for separated format
- Support for configuration files
4. Created example configurations:
- config/influxdb3-core-enterprise.json: For InfluxDB 3
Core/Enterprise releases
- config/influxdb-v2.json: For InfluxDB v2 releases
- config/influxdb3-clustered.json: For Clustered
(Kubernetes operator) releases
5. Updated documentation:
- Explained both output formats clearly
- Added configuration options documentation
- Included example configurations usage
The script now provides a flexible system that can handle
various release note formats for different InfluxData
products while maintaining the specific requirements like
excluding PR links for influxdb_pro but including them
for influxdb.
bullet point formatting like:
* feat: some feature * fix: some fix Changes made: 1. Added new function get_commits_with_body() that uses git log --format="%B" to get full commit messages 2. Updated pattern matching to handle both direct commits and bullet-pointed entries in merge commits (supporting both * and - bullets) 3. Modified the feature and fix extraction to check both commit subjects and commit bodies 4. Fixed pattern anchoring by removing ^ anchors when calling the body parsing function
scripts
- Supports special case for local development mode
- Provides helpful error messages with available tags
- Can be used as CLI tool or imported module
Now you can run specific audits directly:
# Run specific audits
gh act workflow_dispatch -j cli-3-enterprise
gh act workflow_dispatch -j cli-3-core
gh act workflow_dispatch -j api-3-cloud-dedicated
# Run with custom version
gh act workflow_dispatch -j cli-3-enterprise --input
version=3.1.0
# Run all audits (scheduled behavior)
gh act workflow_dispatch
Migrates v1 OSS and Enterprise sections from the DockerHub README into new pages in docs-v2.
- Add a new section page for Installing and running with Docker.o
1. Created main Docker installation page (docker.md) with:
- Complete Docker setup instructions for Enterprise clusters
- Environment variable configuration options
- Persistent storage examples
- Network setup guidance
- License key requirements using GitHub note callout syntax
2. Enhanced existing installation pages:
- Added Docker installation sections to both meta and data node installation
pages
- Updated the main installation index to include Docker as an option
3. Created Docker troubleshooting guide (docker-troubleshooting.md) with:
- Common Docker-specific issues and solutions
- Debugging commands and best practices
- Positioned next to the Docker installation guide
4. Added proper cross-references:
- Used related frontmatter to link Docker installation to troubleshooting
- Updated navigation and references throughout
The migration preserves all the essential Docker README content while
integrating it properly into the existing InfluxDB Enterprise v1 documentation
structure, following the project's style guidelines and conventions.
Jason Stirnaman
Jason Stirnaman
jonasnoki
Jonathan Coates