Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Edit README.md 

- Use ordered list for instructions
- Other formatting changes
pull/570/head
pierwill 2019-10-30 09:01:05 -07:00
parent e8941ae6c9
commit ba63fa57a5
1 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -6,44 +6,45 @@
This repository contains the InfluxDB 2.x documentation published at [docs.influxdata.com](https://docs.influxdata.com). This repository contains the InfluxDB 2.x documentation published at [docs.influxdata.com](https://docs.influxdata.com).
## Contributing ## Contributing
We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see [Contribution guidelines](CONTRIBUTING.md). We welcome and encourage community contributions.
For information about contributing to the InfluxData documentation, see [Contribution guidelines](CONTRIBUTING.md).
## Reporting a Vulnerability ## Reporting a Vulnerability
InfluxData takes security and our users' trust very seriously. 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, 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. please responsibly disclose it by contacting security@influxdata.com.
More details about security vulnerability reporting, More details about security vulnerability reporting,
including our GPG key, can be found here. https://www.influxdata.com/how-to-report-security-vulnerabilities/ including our GPG key, can be found at https://www.influxdata.com/how-to-report-security-vulnerabilities/.
## Run the docs locally ## Running the docs locally
The InfluxData documentation uses [Hugo](https://gohugo.io/), a static site
generator built in Go.
### Clone this repository 1. [**Clone this repository**](https://help.github.com/articles/cloning-a-repository/) to your local machine.
[Clone this repository](https://help.github.com/articles/cloning-a-repository/)
to your local machine.
### Install Hugo 2. **Install Hugo**
See the Hugo documentation for information about how to
[download and install Hugo](https://gohugo.io/getting-started/installing/). The InfluxData documentation uses [Hugo](https://gohugo.io/), a static site generator built in Go.
See the Hugo documentation for information about how to [download and install Hugo](https://gohugo.io/getting-started/installing/).
3. **Install NodeJS & Asset Pipeline Tools**
### Install NodeJS & Asset Pipeline Tools
This project uses tools written in NodeJS to build and process stylesheets and javascript. 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/) In order for assets to build correctly, [install NodeJS](https://nodejs.org/en/download/)
and run the following command to install the necessary tools: and run the following command to install the necessary tools:
```sh ```
npm i -g postcss-cli autoprefixer npm i -g postcss-cli autoprefixer
``` ```
### Start the hugo server 4. **Start the Hugo server**
Hugo provides a local development server that generates the HTML pages, builds Hugo provides a local development server that generates the HTML pages, builds
the static assets, and serves them at `localhost:1313`. the static assets, and serves them at `localhost:1313`.
Start the hugo server with: Start the Hugo server from the repository:
```bash ```
hugo server $ cd docs-v2/
$ hugo server
``` ```
View the docs at [localhost:1313](http://localhost:1313). View the docs at [localhost:1313](http://localhost:1313).