InfluxData Product Documentation

This repository contains the InfluxData product documentation for InfluxDB and related tooling published at docs.influxdata.com.

Contributing

We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see Contribution guidelines.

Testing

For information about testing the documentation, including code block testing, link validation, and style linting, see Testing guide.

Documentation Tools

This repository includes a docs CLI tool for common documentation workflows:

# Create new documentation from a draft
npx docs create drafts/new-feature.md --products influxdb3_core

# Edit existing documentation from a URL
npx docs edit https://docs.influxdata.com/influxdb3/core/admin/

# Add placeholder syntax to code blocks
npx docs placeholders content/influxdb3/core/admin/upgrade.md

# Get help
npx docs --help

The docs command is automatically configured when you run yarn install.

Documentation

Comprehensive reference documentation for contributors:

• Contributing Guide - Workflow and contribution guidelines
• Shortcodes Reference - Complete Hugo shortcode documentation
  • Working examples - Test shortcodes in the browser
• Frontmatter Reference - Complete page metadata documentation
• Testing Guide - Testing procedures and requirements
• API Documentation - API reference generation

Quick Links

• Style guidelines
• Commit guidelines
• Code block testing

Reporting a Vulnerability

InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our open source projects, please responsibly disclose it by contacting security@influxdata.com. More details about security vulnerability reporting, including our GPG key, can be found at https://www.influxdata.com/how-to-report-security-vulnerabilities/.

Running the docs locally

1. Clone this repository to your local machine.

2. Install NodeJS, Yarn, Hugo, & Asset Pipeline Tools

   The InfluxData documentation uses Hugo, a static site generator built in Go. The site uses Hugo's asset pipeline, which requires the extended version of Hugo along with NodeJS tools like PostCSS, to build and process stylesheets and JavaScript.

   To install the required dependencies and build the assets, do the following:

   1. Install NodeJS

   2. Install Yarn

   3. In your terminal, from the docs-v2 directory, install the dependencies:

      cd docs-v2
      yarn install
      

      Note: The most recent version of Hugo tested with this documentation is 0.149.0.

      After installation, the docs command will be available via npx:

      npx docs --help
      

3. To generate the API docs, see api-docs/README.md.

4. Start the Hugo server

   Hugo provides a local development server that generates the HTML pages, builds the static assets, and serves them at localhost:1313.

   In your terminal, start the Hugo server:

   npx hugo server
   

5. View the docs at localhost:1313.

Alternative: Use docker compose

1. Clone this repository to your local machine. See how to clone a repository.

2. Follow the instructions to install Docker Desktop and Docker Compose to your local machine.

3. Use Docker Compose to start the Hugo server in development mode--for example, enter the following command in your terminal:

   docker compose up local-dev
   

4. View the docs at localhost:1313.