* 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> |
||
---|---|---|
.circleci | ||
.github | ||
.vscode | ||
api-docs | ||
assets | ||
content | ||
data | ||
deploy | ||
flux-build-scripts | ||
layouts | ||
resources | ||
shared/text | ||
static | ||
.gitignore | ||
.prettierrc.yaml | ||
.s3deploy.yml | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
alert-to-zapier.md | ||
config.staging.toml | ||
config.toml | ||
package.json | ||
yarn.lock |
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
-
Clone this repository to your local machine.
-
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:
-
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.
-
To generate the API docs, see api-docs/README.md.
-
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
-
View the docs at localhost:1313.