855712d68d
* document influxdb enterprise startup process, closes influxdata/DAR#114 * minor adjustments to influxdb enterprise startup doc * minor typo fixes in influxdb enterprise startup doc |
||
|---|---|---|
| .circleci | ||
| .github | ||
| api-docs | ||
| assets | ||
| content | ||
| data | ||
| deploy | ||
| layouts | ||
| public/influxdb | ||
| static | ||
| .gitignore | ||
| .s3deploy.yml | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| config.toml | ||
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 Hugo
The InfluxData documentation uses Hugo, a static site generator built in Go. See the Hugo documentation for information about how to download and install Hugo.
-
Install NodeJS & Asset Pipeline Tools
This project uses tools written in NodeJS to build and process stylesheets and javascript. In order for assets to build correctly, install NodeJS and run the following command to install the necessary tools:
npm i -g postcss-cli autoprefixer -
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.Start the Hugo server from the repository:
$ cd docs-v2/ $ hugo serverView the docs at localhost:1313.