Go to file
Scott Anderson 399e3aa781 hotfix - added config options page description 2019-04-12 17:10:38 -06:00
.circleci added flexible stable version messages, minify html on build 2019-03-22 15:14:03 -06:00
assets Merge branch 'master' into alpha-8 2019-04-12 11:22:33 -06:00
content/v2.0 hotfix - added config options page description 2019-04-12 17:10:38 -06:00
data updated and added new enterprise shortcodes, updated contribution guidelines 2019-03-27 09:17:23 -06:00
deploy updated ciuser permissions in cloudformation config 2019-01-25 10:54:53 -07:00
layouts updated feedback icon in the alpha feedback message 2019-04-12 15:17:54 -06:00
static updated UI images for alpha-8, updated label management docs, resolves #138 2019-04-10 10:14:48 -06:00
.gitignore Initial cloudformation template to deploy docs 2019-01-17 13:59:44 -08:00
.s3deploy.yml added font file extensions to s3deploy caching config 2019-01-19 08:30:43 -07:00
CONTRIBUTING.md updated contribution guidelines with new icon options 2019-04-10 09:11:25 -06:00
README.md Fixes link to Contributing 2019-01-18 12:29:39 -08:00
config.toml added configuration options reference doc, resolves #142 2019-04-12 10:15:35 -06:00

README.md

InfluxDB v2.0 Documentation

This is the repository contains the InfluxDB v2.x documentation that will be accessible at docs.influxdata.com.

Contributing

We welcome and encourage community contributions to the InfluxData See our Contribution guidelines for information about contributing to the InfluxData documentation.

Run the docs locally

The InfluxData documentation uses Hugo, a static site generator built in Go.

Clone this repository

Clone this repository to your local machine.

Install Hugo

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 with:

hugo server

View the docs at localhost:1313.