Repository files navigation

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

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

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

This repository includes adocs CLI tool for common documentation workflows:

# Create new documentation from a draftnpx docs create drafts/new-feature.md --products influxdb3_core# Edit existing documentation from a URLnpx docs edit https://docs.influxdata.com/influxdb3/core/admin/# Add placeholder syntax to code blocksnpx docs placeholders content/influxdb3/core/admin/upgrade.md# Get helpnpx docs --help

Thedocs command is automatically configured when you runyarn install.

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

Instructions for AI assistants working with this repository:

• GitHub Copilot Instructions - For GitHub Copilot coding agents
• AI Agents Guide - For general AI assistants (Claude, ChatGPT, etc.)
• Instructions Navigation - Complete guide to all instruction files
• Claude Instructions - For Claude Desktop and Claude Code users

• Style guidelines
• Commit guidelines
• Code block testing

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 contactingsecurity@influxdata.com.More details about security vulnerability reporting,including our GPG key, can be found athttps://www.influxdata.com/how-to-report-security-vulnerabilities/.

1. Clone this repository to your local machine.

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

   The InfluxData documentation usesHugo, 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 thedocs-v2 directory, install the dependencies:

      cd docs-v2yarn install

      Note: The most recent version of Hugo tested with this documentation is0.149.0.

      After installation, thedocs command will be available vianpx:

      npx docs --help

3. To generate the API docs, seeapi-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 atlocalhost:1313.

   In your terminal, start the Hugo server:

   npx hugo server

5. View the docs atlocalhost:1313.

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

2. Follow the instructions toinstall Docker Desktop andDocker 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 atlocalhost:1313.