8129c5b4c5
* feature(cloud-iox): add cloud-iox API reference content. * feature(api): revise tagging, add cloud-iox API: - Closes #4788. - Generates cloud-iox/api. - Changes handling of tags and x-tagGroups. - Configures custom All Endpoints list for cloud-iox. - Simplifies the nav with other grouping tags. Any custom x-tagGroups configured in [platform]/content/tag-groups.yml take precedence over those already defined in the spec. If you assign a list of tags to 'All endpoints' x-tagGroup, the decorator will use that list and remove Operations not tagged with those tags. If you assign an empty array([]) to the 'All endpoints' x-tagGroup, the decorator will list all resource-like tags. TODO: document in CONTRIBUTING. TODO: unset x-tagGroups from openapi. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(api): unintended deletion of API operations --------- 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-v2directory, install the dependencies:cd docs-v2 yarn installNote: 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.