4.0 KiB

Raw Blame History

InfluxData Documentation Helper Scripts

This directory contains scripts to assist with InfluxDB documentation workflows, including release notes generation, CLI/API documentation auditing, and version management.

Directory Structure

helper-scripts/
├── common/                    # Shared scripts used across all products
├── influxdb3-monolith/       # Scripts for InfluxDB 3 Core & Enterprise
├── influxdb3-distributed/    # Scripts for InfluxDB 3 Clustered & Cloud Dedicated
├── cloud-serverless/         # Scripts for InfluxDB Cloud Serverless
└── output/                   # Generated outputs from all scripts

Product Categories

InfluxDB 3 Monolith

Products: InfluxDB 3 Core, InfluxDB 3 Enterprise
Deployment: Single binary deployment
Scripts Location: influxdb3-monolith/

InfluxDB 3 Distributed

Products: InfluxDB 3 Clustered, InfluxDB 3 Cloud Dedicated
Deployment: Distributed/Kubernetes deployment
Scripts Location: influxdb3-distributed/

Cloud Serverless

Product: InfluxDB Cloud Serverless
Deployment: Fully managed cloud service
Scripts Location: cloud-serverless/

Common Scripts

Release Notes Generation

Release notes are generated using the unified docs CLI. See scripts/docs-cli/README.md for full documentation.

Usage:

# Using product keys (resolves paths from config)
npx docs release-notes v3.1.0 v3.2.0 --products influxdb3_core,influxdb3_enterprise

# Using direct repository paths
npx docs release-notes v3.1.0 v3.2.0 --repos ~/repos/influxdb,~/repos/enterprise

`common/update-product-version.sh`

Updates product version numbers in data/products.yml and related documentation files.

Usage:

./common/update-product-version.sh --product <product> --version <version>

Example:

./common/update-product-version.sh --product core --version 3.2.1

Product-Specific Scripts

InfluxDB 3 Monolith (Core & Enterprise)

See influxdb3-monolith/README.md for detailed documentation.

Key Scripts:

audit-cli-documentation.sh - Audits CLI commands against existing documentation
setup-auth-tokens.sh - Sets up authentication tokens for local containers

InfluxDB 3 Distributed (Clustered & Cloud Dedicated)

See influxdb3-distributed/README.md for detailed documentation.

Key Scripts:

clustered-release-artifacts.sh - Downloads release artifacts for Clustered releases

Output Directory

All scripts write their outputs to organized subdirectories:

output/
├── release-notes/      # Generated release notes
├── cli-audit/         # CLI documentation audit reports
├── api-audit/         # API documentation audit reports
└── artifacts/         # Downloaded release artifacts

GitHub Workflow Integration

These scripts are integrated with GitHub Actions workflows:

Workflow: .github/workflows/prepare-release.yml
Uses: docs release-notes (unified CLI), update-product-version.sh

Quick Start

Clone the repository

git clone https://github.com/influxdata/docs-v2.git
cd docs-v2/helper-scripts

Make scripts executable

find . -name "*.sh" -type f -exec chmod +x {} \;

Run a script

# Generate release notes (using unified CLI)
npx docs release-notes v3.1.0 v3.2.0 --products influxdb3_core,influxdb3_enterprise

# Audit CLI documentation
npx docs audit main --products influxdb3_core

Contributing

When adding new scripts:

Place in the appropriate product directory
Follow naming conventions (lowercase with hyphens)
Include comprehensive help text and documentation
Update the relevant README files
Test with all applicable products
Ensure outputs go to the output/ directory

Archived Scripts

Deprecated scripts are moved to archive/ subdirectories. These scripts are kept for reference but should not be used in active workflows.

4.0 KiB Raw Blame History