2019-04-23 00:04:08 +00:00
# InfluxDB 2.0 Documentation
This repository contains the InfluxDB 2.x documentation published at [docs.influxdata.com ](https://docs.influxdata.com ).
2018-12-13 18:47:02 +00:00
2019-01-09 23:08:51 +00:00
## Contributing
2019-04-23 00:04:08 +00:00
We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see [Contribution guidelines ](CONTRIBUTING.md ).
2019-01-09 23:08:51 +00:00
2019-09-05 20:03:57 +00:00
## 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 here. https://www.influxdata.com/how-to-report-security-vulnerabilities/
2018-12-13 18:47:02 +00:00
## Run the docs locally
2019-01-09 23:08:51 +00:00
The InfluxData documentation uses [Hugo ](https://gohugo.io/ ), a static site
generator built in Go.
### Clone this repository
[Clone this repository ](https://help.github.com/articles/cloning-a-repository/ )
to your local machine.
2018-12-13 18:47:02 +00:00
### Install Hugo
2019-01-09 23:08:51 +00:00
See the Hugo documentation for information about how to
[download and install Hugo ](https://gohugo.io/getting-started/installing/ ).
2018-12-13 18:47:02 +00:00
2018-12-19 21:40:52 +00:00
### Install NodeJS & Asset Pipeline Tools
2019-01-09 23:08:51 +00:00
This project uses tools written in NodeJS to build and process stylesheets and javascript.
In order for assets to build correctly, [install NodeJS ](https://nodejs.org/en/download/ )
and run the following command to install the necessary tools:
2018-12-19 21:36:12 +00:00
```sh
npm i -g postcss-cli autoprefixer
```
2018-12-13 18:47:02 +00:00
### Start the hugo server
2019-01-09 23:08:51 +00:00
Hugo provides a local development server that generates the HTML pages, builds
the static assets, and serves them at `localhost:1313` .
2018-12-13 18:47:02 +00:00
Start the hugo server with:
```bash
hugo server
```
View the docs at [localhost:1313 ](http://localhost:1313 ).