From ba63fa57a56c2d409fac907747b97c1bf3247c7b Mon Sep 17 00:00:00 2001 From: pierwill <19642016+pierwill@users.noreply.github.com> Date: Wed, 30 Oct 2019 09:01:05 -0700 Subject: [PATCH] Edit README.md - Use ordered list for instructions - Other formatting changes --- README.md | 61 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 38e80452c..9a026fc29 100644 --- a/README.md +++ b/README.md @@ -6,44 +6,45 @@ This repository contains the InfluxDB 2.x documentation published at [docs.influxdata.com](https://docs.influxdata.com). ## 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 -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, -please responsibly disclose it by contacting security@influxdata.com. -More details about security vulnerability reporting, -including our GPG key, can be found here. https://www.influxdata.com/how-to-report-security-vulnerabilities/ +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, +please responsibly disclose it by contacting security@influxdata.com. +More details about security vulnerability reporting, +including our GPG key, can be found at https://www.influxdata.com/how-to-report-security-vulnerabilities/. -## Run the docs locally -The InfluxData documentation uses [Hugo](https://gohugo.io/), a static site -generator built in Go. +## Running the docs locally -### Clone this repository -[Clone this repository](https://help.github.com/articles/cloning-a-repository/) -to your local machine. +1. [**Clone this repository**](https://help.github.com/articles/cloning-a-repository/) to your local machine. -### Install Hugo -See the Hugo documentation for information about how to -[download and install Hugo](https://gohugo.io/getting-started/installing/). +2. **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](https://nodejs.org/en/download/) -and run the following command to install the necessary tools: + 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/). -```sh -npm i -g postcss-cli autoprefixer -``` +3. **Install NodeJS & Asset Pipeline Tools** -### 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`. + 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/) + and run the following command to install the necessary tools: -Start the hugo server with: + ``` + npm i -g postcss-cli autoprefixer + ``` -```bash -hugo server -``` +4. **Start the Hugo server** -View the docs at [localhost:1313](http://localhost:1313). + 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 from the repository: + + ``` + $ cd docs-v2/ + $ hugo server + ``` + + View the docs at [localhost:1313](http://localhost:1313).