docs-v2/README.md

68 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2019-10-09 19:05:04 +00:00
<p align="center">
<img src="/static/img/influx-logo-cubo-dark.png" width="200">
</p>
2019-04-23 00:04:08 +00:00
# InfluxDB 2.0 Documentation
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
2019-04-23 00:04:08 +00:00
This repository contains the InfluxDB 2.x documentation published at [docs.influxdata.com](https://docs.influxdata.com).
2018-12-13 18:47:02 +00:00
## Contributing
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
We welcome and encourage community contributions.
For information about contributing to the InfluxData documentation, see [Contribution guidelines](CONTRIBUTING.md).
2019-09-05 20:03:57 +00:00
## Reporting a Vulnerability
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
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/.
2019-09-05 20:03:57 +00:00
## Running the docs locally
1. [**Clone this repository**](https://help.github.com/articles/cloning-a-repository/) to your local machine.
2018-12-13 18:47:02 +00:00
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
2. **Install NodeJS, Yarn, Hugo, & Asset Pipeline Tools**
2018-12-13 18:47:02 +00:00
The InfluxData documentation uses [Hugo](https://gohugo.io/), a static site generator built in Go. The site uses Hugo's asset pipeline, which requires the extended version of Hugo along with NodeJS tools like PostCSS, to build and process stylesheets and JavaScript.
2018-12-19 21:36:12 +00:00
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
To install the required dependencies and build the assets, do the following:
2018-12-13 18:47:02 +00:00
1. [Install NodeJS](https://nodejs.org/en/download/)
2. [Install Yarn](https://classic.yarnpkg.com/en/docs/install/)
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
3. In your terminal, from the `docs-v2` directory, install the dependencies:
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
```sh
cd docs-v2
yarn install
```
2018-12-13 18:47:02 +00:00
_**Note:** The most recent version of Hugo tested with this documentation is **0.123.8**._
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
3. To generate the API docs, see [api-docs/README.md](api-docs/README.md).
2018-12-13 18:47:02 +00:00
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
4. **Start the Hugo server**
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
Hugo provides a local development server that generates the HTML pages, builds the static assets, and serves them at `localhost:1313`.
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
In your terminal, start the Hugo server:
Install dependencies as project dependencies from NPM repo (#2476) * Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474) * Replaced global hugo and yarn installs with project-level yarn install. * Replaced npm package.lock with yarn.lock (#2474). * enhancement: update README with instructions for installing NODE.JS dependencies. (#2474) * updated api doc generator script to use npx * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update README.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update package.json Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: indentation. (#2476) * update: Added separate dependencies list for api-docs. - Moved redoc-cli to a separate package.json in api-docs. Excluded api-docs/node_modules from generate-api-docs.sh. - Updated redoc-cli argument sequence to agree with their docs. - Updated READMEs. - Fixed typos. * update: add api-docs > yarn install to .circleci * Added language and consistency to code block. Specify where to run the command. Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 17:11:01 +00:00
```sh
npx hugo server
```
5. View the docs at [localhost:1313](http://localhost:1313).
### Alternative: Use docker compose
1. Clone this repository to your local machine. See how to [clone a repository](https://help.github.com/articles/cloning-a-repository/).
2. Follow the instructions to [install Docker Desktop](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/) to your local machine.
3. Use Docker Compose to start the Hugo server in development mode--for example, enter the following command in your terminal:
```sh
docker compose up local-dev
```
4. View the docs at [localhost:1313](http://localhost:1313).