Go to file
Scott Anderson e4259a2974 added font file extensions to s3deploy caching config 2019-01-19 08:30:43 -07:00
.circleci added sudo permissions to npm install command 2019-01-18 14:40:22 -07:00
assets updated background color on light theme 2019-01-11 14:01:45 -07:00
content/v2.0 Removed Note as visualization type 2019-01-16 10:38:56 -08:00
data added latest version checker and warning 2018-12-31 22:15:06 -07:00
deploy Fix YAML formatting in CF template 2019-01-18 23:23:20 -08:00
layouts added collapsable left nav styles and js 2019-01-11 10:21:33 -07:00
static added collapsable left nav styles and js 2019-01-11 10:21:33 -07: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 restructured readme and contribution guidelines 2019-01-09 16:08:51 -07:00
README.md Fixes link to Contributing 2019-01-18 12:29:39 -08:00
config.toml fixed theme switcher, updated config.toml 2019-01-03 14:07:02 -07: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.