4cfff239f3
- **Environment variable formatting** - Updated environment variable configuration from array format to object format to comply with Lefthook schema validation requirements. - **Unified link testing** - Consolidated multiple product-specific link testing commands into a single `e2e-links` command that processes all staged Markdown and HTML files across content directories. - **Package script integration** - Modified commands to use centralized yarn scripts instead of direct execution, improving maintainability and consistency. - **Source information extraction** - Enhanced to correctly extract and report source information from frontmatter. - **URL and source mapping** - Improved handling of URL to source path mapping for better reporting. - **Ignored anchor links configuration** - Added proper exclusion of behavior-triggering anchor links (like tab navigation) to prevent false positives. - **Request options correction** - Fixed Cypress request options to ensure `failOnStatusCode` is properly set when `retryOnStatusCodeFailure` is enabled. - **Improved error reporting** - Enhanced error reporting with more context about broken links. - **New test scripts added** - Added centralized testing scripts for link checking and codeblock validation. - **Product-specific test commands** - Added commands for each product version (InfluxDB v2, v3 Core, Enterprise, Cloud, etc.). - **API docs testing** - Added specialized commands for testing API documentation links. - **Comprehensive test runners** - Added commands to run all tests of a specific type (`test:links:all`, `test:codeblocks:all`). - Fix Docker build command and update CONTRIBUTING. chore(js): JavaScript QoL improvements: - Refactor main.js with a componentRegistry object and clear initialization of components and globals - Add a standard index.js with all necessary exports. - Update javascript.html to use the index.js - Remove jQuery script tag from header javascript.html (remains in footer) - Update package file to improve module discovery. - Improve Hugo and ESLint config for module discovery and ES6 syntax |
||
|---|---|---|
| .ci | ||
| .circleci | ||
| .github | ||
| .husky/_ | ||
| .vscode | ||
| api-docs | ||
| assets | ||
| content | ||
| cypress | ||
| data | ||
| deploy | ||
| flux-build-scripts | ||
| influxdb3cli-build-scripts | ||
| layouts | ||
| resources | ||
| shared/text | ||
| static | ||
| telegraf-build | ||
| test | ||
| .editorconfig | ||
| .frontmatter-schema.json | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.yaml | ||
| .s3deploy.yml | ||
| .vale.ini | ||
| CONTRIBUTING.md | ||
| DOC_GPT_PROFILE.md | ||
| Dockerfile.pytest | ||
| Dockerfile.tests | ||
| LICENSE | ||
| PLATFORM_REFERENCE.md | ||
| README.md | ||
| compose.yaml | ||
| cypress.config.js | ||
| eslint.config.mjs | ||
| hugo.staging.yml | ||
| hugo.testing.yml | ||
| hugo.yml | ||
| install-influxdb3-core.sh | ||
| lefthook.yml | ||
| package.json | ||
| yarn.lock | ||
README.md
InfluxDB 2.0 Documentation
This repository contains the InfluxDB 2.x documentation published at docs.influxdata.com.
Contributing
We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see Contribution guidelines.
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
-
Clone this repository to your local machine.
-
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:
-
In your terminal, from the
docs-v2directory, install the dependencies:cd docs-v2 yarn installNote: The most recent version of Hugo tested with this documentation is 0.123.8.
-
To generate the API docs, see api-docs/README.md.
-
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 -
View the docs at localhost:1313.
Alternative: Use docker compose
-
Clone this repository to your local machine. See how to clone a repository.
-
Follow the instructions to install Docker Desktop and Docker Compose to your local machine.
-
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 -
View the docs at localhost:1313.