Go to file
Scott Anderson e3f8173314 updates to json.encode to address PR feedback 2019-08-26 15:43:47 -06:00
.circleci explicitly set hugo 0.55.1 in circleci/config.yml 2019-04-16 10:07:37 -06:00
assets fixed codeblock whitespace wrapping 2019-08-09 16:48:29 -06:00
content/v2.0 updates to json.encode to address PR feedback 2019-08-26 15:43:47 -06:00
data updated description of telegraf filecount plugin 2019-08-06 17:06:06 -06:00
deploy Hotfix: Updated lambda function and visualization example images 2019-06-25 09:07:48 -06:00
layouts Merge pull request #357 from influxdata/alpha-16 2019-07-25 17:09:11 -07:00
static Merge pull request #320 from influxdata/query/sql-guide 2019-07-23 11:24:10 -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 resolved merged conflicts for alpha-10 2019-05-30 13:19:35 -06:00
README.md Update README.md 2019-04-22 17:04:08 -07:00
config.toml added configuration options reference doc, resolves #142 2019-04-12 10:15:35 -06:00

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.

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.