Go to file
Nora ab5d5f8a60 Fixed numbering 2019-02-13 15:50:02 -08:00
.circleci testing new slack messages on deploy 2019-02-08 14:43:34 -07:00
assets more minor adjustments to left nav bullets and toggles 2019-02-13 10:25:18 -07:00
content/v2.0 Fixed numbering 2019-02-13 15:50:02 -08:00
data added latest version checker and warning 2018-12-31 22:15:06 -07:00
deploy updated ciuser permissions in cloudformation config 2019-01-25 10:54:53 -07:00
layouts added active state to left nav 2019-02-12 14:38:23 -07:00
static Added missing images 2019-02-13 14:09:08 -08: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 adjusted all page weights to new hierarchy, added page wieght info to contribution guidelines 2019-02-06 10:48:09 -07:00
README.md Fixes link to Contributing 2019-01-18 12:29:39 -08:00
config.toml added sitemap.xml generator 2019-01-23 00:02:28 -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.