Go to file
Jason Stirnaman f431862a4a
Fix api version (#4697)
* chore: remove unused and deprecated properties:

- Remove unused apis key.
- Remove deprecated styleguide property, replace with root-level plugins and extends.

* chore: pass api-docs path to the custom plugin:

- Pass pwd of the calling script as process.env.API_DOCS_ROOT_PATH to plugins to help resolve custom content files.
- Remove lint execution because the exit code always results in execution of the next elif condition.

* chore: simplify api-docs custom content:

- move content overrides from api-docs/openapi/content to api-docs/[version]/content.
- fix version and version numbers in links.
- update cloud and v2.6 from openapi repo.
- move content.js module to docs-content.js and docs-plugin.js.
- revert decorator functions back to taking content as a data argument.
- remove unused servers.yml definition.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-01-11 13:03:21 -07:00
.circleci Show what versions of InfluxDB Flux functions are supported in (#4219) 2022-07-19 15:14:10 -06:00
.github Update new feature issue template 2022-04-14 16:08:59 -06:00
.vscode Add compaction information (#4084) 2022-06-16 14:49:57 -07:00
api-docs Fix api version (#4697) 2023-01-11 13:03:21 -07:00
assets small icon fixes after clockface v4 (#4658) 2022-12-02 11:01:11 -07:00
content Remove all cloud native subscription content (#4663) 2023-01-11 10:11:00 -07:00
data Cli 2.6.1 release notes (#4689) 2023-01-03 15:37:07 -06:00
deploy InfluxDB v2.6.0 (#4672) 2022-12-15 16:43:27 -07:00
flux-build-scripts hotfix: update exit code of flux build script 2022-09-26 13:37:24 -06:00
layouts Flux 0.192 (#4695) 2023-01-09 16:15:08 -07:00
resources Add files via upload (#4395) 2022-10-06 13:32:02 -06:00
shared/text hotfix: fix explicit schema file examples, closes #4563 2022-10-14 14:10:39 -06:00
static InfluxDB v2.6.0 (#4672) 2022-12-15 16:43:27 -07:00
.gitignore Jts/api guides (#3862) 2022-06-15 19:15:46 -05:00
.prettierrc.yaml fix: Authorization, not Authentication, header (#3342) 2021-11-03 16:53:56 -05:00
.s3deploy.yml added font file extensions to s3deploy caching config 2019-01-19 08:30:43 -07:00
CONTRIBUTING.md InfluxDB get started (#4628) 2022-11-21 15:44:14 -07:00
LICENSE added license and issue template, moved security.md 2019-10-07 10:27:36 -06:00
README.md Install dependencies as project dependencies from NPM repo (#2476) 2021-05-24 12:11:01 -05:00
alert-to-zapier.md Add files via upload (#4395) 2022-10-06 13:32:02 -06:00
config.staging.toml InfluxDB v2.6.0 (#4672) 2022-12-15 16:43:27 -07:00
config.toml InfluxDB v2.6.0 (#4672) 2022-12-15 16:43:27 -07:00
package.json Show what versions of InfluxDB Flux functions are supported in (#4219) 2022-07-19 15:14:10 -06:00
yarn.lock Show what versions of InfluxDB Flux functions are supported in (#4219) 2022-07-19 15:14:10 -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.

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 at https://www.influxdata.com/how-to-report-security-vulnerabilities/.

Running the docs locally

  1. Clone this repository to your local machine.

  2. Install NodeJS, Yarn, Hugo, & Asset Pipeline Tools

    The InfluxData documentation uses Hugo, 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.

    To install the required dependencies and build the assets, do the following:

    1. Install NodeJS

    2. Install Yarn

    3. In your terminal, from the docs-v2 directory, install the dependencies:

      cd docs-v2
      yarn install
      

      Note: The most recent version of Hugo tested with this documentation is 0.83.1.

  3. To generate the API docs, see api-docs/README.md.

  4. 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.

    In your terminal, start the Hugo server:

    npx hugo server
    
  5. View the docs at localhost:1313.