docs-v2/CONTRIBUTING.md

1752 lines
53 KiB
Markdown
Raw Permalink Normal View History

2018-12-13 18:47:02 +00:00
# Contributing to InfluxData Documentation
## Sign the InfluxData CLA
The InfluxData Contributor License Agreement (CLA) is part of the legal framework
for the open source ecosystem that protects both you and InfluxData.
2019-10-07 17:22:54 +00:00
To make substantial contributions to InfluxData documentation, first sign the InfluxData CLA.
What constitutes a "substantial" change is at the discretion of InfluxData documentation maintainers.
[Sign the InfluxData CLA](https://www.influxdata.com/legal/cla/)
2019-10-07 17:22:54 +00:00
_**Note:** Typo and broken link fixes are greatly appreciated and do not require signing the CLA._
_If you're new to contributing or you're looking for an easy update, see [`docs-v2` good-first-issues](https://github.com/influxdata/docs-v2/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)._
2020-09-25 21:55:06 +00:00
## Make suggested updates
### Fork and clone InfluxData Documentation Repository
[Fork this repository](https://help.github.com/articles/fork-a-repo/) and
[clone it](https://help.github.com/articles/cloning-a-repository/) to your local machine.
## Install project dependencies
docs-v2 automatically runs format (Markdown, JS, and CSS) linting and code block tests for staged files that you try to commit.
For the linting and tests to run, you need to install Docker and Node.js
dependencies.
\_**Note:**
We strongly recommend running linting and tests, but you can skip them
(and avoid installing dependencies)
by including the `--no-verify` flag with your commit--for example, enter the following command in your terminal:
```sh
git commit -m "<COMMIT_MESSAGE>" --no-verify
```
### Install Node.js dependencies
To install dependencies listed in package.json:
1. Install [Node.js](https://nodejs.org/en) for your system.
2. Install [Yarn](https://yarnpkg.com/getting-started/install) for your system.
3. Run `yarn` to install dependencies (including Hugo).
4. Install the Yarn package manager and run `yarn` to install project dependencies.
`package.json` contains dependencies for linting and running Git hooks.
- **[husky](https://github.com/typicode/husky)**: manages Git hooks, including the pre-commit hook for linting and testing
- **[lint-staged](https://github.com/lint-staged/lint-staged)**: passes staged files to commands
- **[prettier](https://prettier.io/docs/en/)**: formats code, including Markdown, according to style rules for consistency
### Install Docker
Install [Docker](https://docs.docker.com/get-docker/) for your system.
docs-v2 includes Docker configurations (`compose.yaml` and Dockerfiles) for running the Vale style linter and tests for code blocks (Shell, Bash, and Python) in Markdown files.
#### Build the test dependency image
After you have installed Docker, run the following command to build the test
dependency image, `influxdata:docs-pytest`.
The tests defined in `compose.yaml` use the dependencies and execution
environment from this image.
```bash
docker build -t influxdata:docs-pytest -f Dockerfile.pytest .
```
### Run the documentation locally (optional)
To run the documentation locally, follow the instructions provided in the README.
### Make your changes
Make your suggested changes being sure to follow the [style and formatting guidelines](#style--formatting) outline below.
## Lint and test your changes
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
### Automatic pre-commit checks
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
docs-v2 uses Husky to manage Git hook scripts.
When you try to commit your changes (for example, `git commit`), Git runs
scripts configured in `.husky/pre-commit`, including linting and tests for your **staged** files.
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
### Skip pre-commit hooks
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
**We strongly recommend running linting and tests**, but you can skip them
(and avoid installing dependencies)
2024-07-03 14:38:20 +00:00
by including the `HUSKY=0` environment variable or the `--no-verify` flag with
your commit--for example:
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
```sh
git commit -m "<COMMIT_MESSAGE>" --no-verify
```
2024-07-03 14:38:20 +00:00
```sh
HUSKY=0 git commit
```
For more options, see the [Husky documentation](https://typicode.github.io/husky/how-to.html#skipping-git-hooks).
### Set up test scripts and credentials
To set up your docs-v2 instance to run tests locally, do the following:
1. **Set executable permissions on test scripts** in `./test/src`:
```sh
chmod +x ./test/src/*.sh
```
2. **Create credentials for tests**:
- Create databases, buckets, and tokens for the product(s) you're testing.
- If you don't have access to a Clustered instance, you can use your
Cloud Dedicated instance for testing in most cases. To avoid conflicts when
running tests, create separate Cloud Dedicated and Clustered databases.
3. **Create .env.test**: Copy the `./test/env.test.example` file into each
product directory to test and rename the file as `.env.test`--for example:
```sh
./content/influxdb/cloud-dedicated/.env.test
```
4. Inside each product's `.env.test` file, assign your InfluxDB credentials to
environment variables.
In addition to the usual `INFLUX_` environment variables, in your
`cloud-dedicated/.env.test` and `clustered/.env.test` files define the
following variables:
- `ACCOUNT_ID`, `CLUSTER_ID`: You can find these values in your `influxctl`
`config.toml` configuration file.
- `MANAGEMENT_TOKEN`: Use the `influxctl management create` command to generate
a long-lived management token to authenticate Management API requests
For the full list of variables you'll need to include, see the substitution
patterns in `./test/src/prepare-content.sh`.
**Warning**: The database you configure in `.env.test` and any written data may
be deleted during test runs.
**Warning**: To prevent accidentally adding credentials to the docs-v2 repo,
Git is configured to ignore `.env*` files. Don't add your `.env.test` files to Git.
Consider backing them up on your local machine in case of accidental deletion.
5. For influxctl commands to run in tests, move or copy your `config.toml` file
to the `./test` directory.
### Pre-commit linting and testing
When you try to commit your changes using `git commit` or your editor,
the project automatically runs pre-commit checks for spelling, punctuation,
and style on your staged files.
`.husky/pre-commit` script runs Git pre-commit hook commands, including
[`lint-staged`](https://github.com/lint-staged/lint-staged).
The `.lintstagedrc.mjs` lint-staged configuration maps product-specific glob
patterns to lint and test commands and passes a product-specific
`.env.test` file to a test runner Docker container.
The container then loads the `.env` file into the container's environment variables.
To test or troubleshoot testing and linting scripts and configurations before
committing, choose from the following:
- To run pre-commit scripts without actually committing, append `exit 1` to the
`.husky/pre-commit` script--for example:
```sh
./test/src/monitor-tests.sh start
npx lint-staged --relative
./test/src/monitor-tests.sh kill
exit 1
```
And then run `git commit`.
The `exit 1` status fails the commit, even if all the tasks succeed.
- Use `yarn` to run one of the lint or test scripts configured in
`package.json`--for example:
```sh
yarn run test
```
- Run `lint-staged` directly and specify options:
```sh
npx lint-staged --relative --verbose
```
The pre-commit linting configuration checks for _error-level_ problems.
An error-level rule violation fails the commit and you must do one of the following before you can commit your changes:
- fix the reported problem in the content
- edit the linter rules to permanently allow the content.
See **Configure style rules**.
- temporarily override the hook (using `git commit --no-verify`)
#### Test shell and python code blocks
[pytest-codeblocks](https://github.com/nschloe/pytest-codeblocks/tree/main) extracts code from python and shell Markdown code blocks and executes assertions for the code.
If you don't assert a value (using a Python `assert` statement), `--codeblocks` considers a non-zero exit code to be a failure.
**Note**: `pytest --codeblocks` uses Python's `subprocess.run()` to execute shell code.
You can use this to test CLI and interpreter commands, regardless of programming
language, as long as they return standard exit codes.
To make the documented output of a code block testable, precede it with the
`<!--pytest-codeblocks:expected-output-->` tag and **omit the code block language
descriptor**--for example, in your Markdown file:
##### Example markdown
```python
print("Hello, world!")
```
<!--pytest-codeblocks:expected-output-->
The next code block is treated as an assertion.
If successful, the output is the following:
```
Hello, world!
```
For commands, such as `influxctl` CLI commands, that require launching an
OAuth URL in a browser, wrap the command in a subshell and redirect the output
to `/shared/urls.txt` in the container--for example:
```sh
# Test the preceding command outside of the code block.
# influxctl authentication requires TTY interaction--
# output the auth URL to a file that the host can open.
script -c "influxctl user list " \
/dev/null > /shared/urls.txt
```
You probably don't want to display this syntax in the docs, which unfortunately
means you'd need to include the test block separately from the displayed code
block.
To hide it from users, wrap the code block inside an HTML comment.
Pytest-codeblocks will still collect and run the code block.
##### Mark tests to skip
pytest-codeblocks has features for skipping tests and marking blocks as failed.
To learn more, see the pytest-codeblocks README and tests.
#### Troubleshoot tests
### Pytest collected 0 items
Potential reasons:
- See the test discovery options in `pytest.ini`.
- For Python code blocks, use the following delimiter:
```python
# Codeblocks runs this block.
```
`pytest --codeblocks` ignores code blocks that use the following:
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
```py
# Codeblocks ignores this block.
```
### Vale style linting
docs-v2 includes Vale writing style linter configurations to enforce documentation writing style rules, guidelines, branding, and vocabulary terms.
To run Vale, use the Vale extension for your editor or the included Docker configuration.
For example, the following command runs Vale in a container and lints `*.md` (Markdown) files in the path `./content/influxdb/cloud-dedicated/write-data/` using the specified configuration for `cloud-dedicated`:
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
```sh
docker compose run -T vale --config=content/influxdb/cloud-dedicated/.vale.ini --minAlertLevel=error content/influxdb/cloud-dedicated/write-data/**/*.md
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
```
The output contains error-level style alerts for the Markdown content.
**Note**: We strongly recommend running Vale, but it's not included in the
docs-v2 pre-commit hooks](#automatic-pre-commit-checks) for now.
You can include it in your own Git hooks.
If a file contains style, spelling, or punctuation problems,
the Vale linter can raise one of the following alert levels:
- **Error**:
- Problems that can cause content to render incorrectly
- Violations of branding guidelines or trademark guidelines
- Rejected vocabulary terms
- **Warning**: General style guide rules and best practices
- **Suggestion**: Style preferences that may require refactoring or updates to an exceptions list
### Integrate Vale with your editor
To integrate Vale with VSCode:
1. Install the [Vale VSCode](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode) extension.
2. In the extension settings, set the `Vale:Vale CLI:Path` value to the path of your Vale binary (`${workspaceFolder}/node_modules/.bin/vale` for Yarn-installed Vale).
To use with an editor other than VSCode, see the [Vale integration guide](https://vale.sh/docs/integrations/guide/).
### Configure style rules
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
`<docs-v2>/.ci/vale/styles/` contains configuration files for the custom `InfluxDataDocs` style.
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
The easiest way to add accepted or rejected spellings is to enter your terms (or regular expression patterns) into the Vocabulary files at `.ci/vale/styles/config/vocabularies`.
To add accepted/rejected terms for specific products, configure a style for the product and include a `Branding.yml` configuration. As an example, see `content/influxdb/cloud-dedicated/.vale.ini` and `.ci/vale/styles/Cloud-Dedicated/Branding.yml`.
To learn more about configuration and rules, see [Vale configuration](https://vale.sh/docs/topics/config).
### Submit a pull request
Push your changes up to your forked repository, then [create a new pull request](https://help.github.com/articles/creating-a-pull-request/).
## Style & Formatting
### Markdown
Most docs-v2 documentation content uses [Markdown](https://en.wikipedia.org/wiki/Markdown).
_Some parts of the documentation, such as `./api-docs`, contain Markdown within YAML and rely on additional tooling._
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
### Semantic line feeds
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
Use [semantic line feeds](http://rhodesmill.org/brandon/2012/one-sentence-per-line/).
Separating each sentence with a new line makes it easy to parse diffs with the human eye.
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
**Diff without semantic line feeds:**
```diff
2019-02-25 22:42:04 +00:00
-Data is taking off. This data is time series. You need a database that specializes in time series. You should check out InfluxDB.
+Data is taking off. This data is time series. You need a database that specializes in time series. You need InfluxDB.
```
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
**Diff with semantic line feeds:**
```diff
2019-02-25 22:33:02 +00:00
Data is taking off.
2019-02-25 22:42:04 +00:00
This data is time series.
You need a database that specializes in time series.
-You should check out InfluxDB.
+You need InfluxDB.
```
2020-12-23 20:54:08 +00:00
### Article headings
2020-12-23 20:54:08 +00:00
Use only h2-h6 headings in markdown content.
h1 headings act as the page title and are populated automatically from the `title` frontmatter.
h2-h6 headings act as section headings.
### Image naming conventions
2020-12-23 20:54:08 +00:00
Save images using the following naming format: `project/version-context-description.png`.
For example, `influxdb/2-0-visualizations-line-graph.png` or `influxdb/2-0-tasks-add-new.png`.
Specify a version other than 2.0 only if the image is specific to that version.
## Page frontmatter
Every documentation page includes frontmatter which specifies information about the page.
Frontmatter populates variables in page templates and the site's navigation menu.
```yaml
title: # Title of the page used in the page's h1
seotitle: # Page title used in the html <head> title and used in search engine results
list_title: # Title used in article lists generated using the {{< children >}} shortcode
description: # Page description displayed in search engine results
menu:
influxdb_2_0:
name: # Article name that only appears in the left nav
parent: # Specifies a parent group and nests navigation items
weight: # Determines sort order in both the nav tree and in article lists
draft: # If true, will not render page on build
2020-12-23 20:54:08 +00:00
product/v2.x/tags: # Tags specific to each version (replace product and .x" with the appropriate product and minor version )
related: # Creates links to specific internal and external content at the bottom of the page
- /path/to/related/article
- https://external-link.com, This is an external link
external_url: # Used in children shortcode type="list" for page links that are external
2020-03-11 17:21:49 +00:00
list_image: # Image included with article descriptions in children type="articles" shortcode
list_note: # Used in children shortcode type="list" to add a small note next to listed links
list_code_example: # Code example included with article descriptions in children type="articles" shortcode
list_query_example:# Code examples included with article descriptions in children type="articles" shortcode,
# References to examples in data/query_examples
canonical: # Path to canonical page, overrides auto-gen'd canonical URL
v2: # Path to v2 equivalent page
prepend: # Prepend markdown content to an article (especially powerful with cascade)
block: # (Optional) Wrap content in a block style (note, warn, cloud)
content: # Content to prepend to article
append: # Append markdown content to an article (especially powerful with cascade)
block: # (Optional) Wrap content in a block style (note, warn, cloud)
content: # Content to append to article
InfluxDB 2.1 (#3367) * base changes for influxdb 2.1 * remove duplicates in draft * draft categories * add categories * Document wildcards in SHOW MEASUREMENTS ON queries (#3273) * InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries This applies to InfluxDB 2.1. See #3201 * latest notes * Update `influxd --store` values (#3272) * Use Unix ~ alias * Add sqlite path to file layout doc * add sqlite to filesystem diagrams * draft 2.1 release notes +questions * revert to check RNs changes in separately * latest release notes * Restructure installation docs for separate CLI package (#3280) * influxdb and cli install revamp * reorganized CLI install instructions * remove unnecessary short-code parameters * updated docs to address PR feedback * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * update linux install instructions Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * release note updates * updates * add support for annotations in OSS 2.1 (#3286) * Document support for bearer auth sytax (#3297) * 2.1 oss notebooks (#3281) * Move notebooks to OSS (addresses #2951 ) * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/manage-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add PR feedback Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Fix link in bearer auth sytax doc (#3298) * Updated CLI docs content and added version metadata (#3285) * added metadata styles and data to cli docs * added missing ui-disabled influxd config flag * added updated versions to influx cli metadata * added metadata to all cloud influx cli docs * updated influx ping in cloud to have oss only tag * Update influxd documentation for 2.1 (#3302) * update and dynamically generate links to influxd flags (#3288) * remove 2.1 config options from 2.0 * New influxd commands (#3291) * added basic influxd recovery commands * added influxd recover commands, WIP for other influxd inspect commands * updated all influxd inspect commands * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated influxd docs to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add static legend to band and graph visualizations (#3315) * update band vis to include static legend * upd graph and graph-single-stat w static legend * update 2.1 links * update to latest Flux links * fix Flux links * Influxdb 2.1 release notes (#3279) * draft release notes * latest RN changes * test * revert * for review purposes * incorporate changes from new changelog * add note about new metadata included in CLI docs * edit * more edits * add overview features list * tweak verbiage about Telegraf support * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * add link * add edits from Scott, Dan, and Will * edits from dan * highlight and distinguish CLI separation changes * add links to new API endpoints * formatting upd * edits for secrets * mv Flux location support after rsv merge conflicts * edits from Tim * update influxql link * rmv SLQ metastore link * minor updates to 2.1 release notes * prep * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> * add new Telegraf plugins to release notes * edit from Will * 2.1 upgrade and downgrade instructions (#3332) * influxd downgrade command, add upgrade instructions, closes #3331 * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daniel Moran <danxmoran@gmail.com> * udpated downgrade docs to address PR feedback * remove references to localhost:1313 Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * updated flux version in release notes, added other new items, closes #3338 (#3344) * Chore/update oss api (#3341) * Standardize the term "key-value" (#3283) * s|key/value|key-value * Use en dash in prefix to open compound "time series" * CLI 2.2 (#3269) * add -b shorthand to influx delete * add cli 2.2 release notes * add example for all-access token * edits * updates to influx auth create * edits for operator token * remove inaccurate env var * Update influx-cli.md * Update influx-cli.md * make capitalization consistent with other docs * make headers parallel * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott and Dan * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * edits to CLI * add oss-only shortcode and fix formatting * format updates * fix links * add oss-only inline * fix list * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Dan * emphasize recommendation * edit from Dan re limits and page size * edit f Sam * update release date * remove vague description * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * add cloud updates in Sept (#3210) * Fix numbering in AWS install doc (#3293) Closes #3292 * Document new API Invocable Scripts feature (was named-functions) (#3282) * feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233). * feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters. * feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet. * feat: rename example function for simplicity since there's no GET for now. * feat: add find_and_update example (#2547). * feat: add update example. Clarify, expand invoke example. Add links. (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: remove accidental commit of generated redoc-static.html * feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml. * fix: replace /functions with /scripts * feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml * feat: invocable scripts (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * feat: new section for params (#2547). * fix: swagger server url (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * feat: remove jq and function where there's no clear need. Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: add Invocable Scripts tag description. (#3296) * Fix api invocable (#3299) * fix: scripts api path. * fix: bad comma * Fix api invocable (#3306) * fix: scripts api path. * fix: bad comma * feat: add invocable scripts example for sending multiple parameter values. * fix: endpoint text. (#3308) * Fix api invocable (#3310) * fix: measurement -> point * fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest. * updated token naming and other typos, closes influxdata/DAR#244 (#3309) * Flux 0.136 (#3311) * Flux 0.136.0 release notes * Update pagerduty package for flux 0.136.0 (#3303) * Add Flux ServiceNow package (#3304) * added Flux servicenow package * Apply suggestions from code review * Enterprise dar updates (#3313) * removed references to web server in enteprise cluster docs, closes influxdata/DAR#245 * updated enterprise upgrade instructions, closes influxdata/DAR#243 * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: mjs example path (#3305) (#3316) * 3240 fix nodejs alias (#3317) * fix: mjs example path (#3305) * fix: add alias to node.js client library (#3240) * Edit description for amd_rocm_smi Telegraf plugin (#3186) * Edit description for amd_rocm_smi Telegraf plugin Edit name and description for amd_rocm_smi Telegraf plugin. Not sure if this is the only location that it needs to be udpated. * cpl minor updates Co-authored-by: Kelly <kelly@influxdata.com> * remove influxql support from v2 api, closes influxdata/DAR#246 (#3326) * Telegraf 1.20.3 (#3328) * Telegraf 1.20.3 * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * docs: update telegraf configuration.md (#3300) * docs: update telegraf configuration.md * add note about rate limits * fix: correct debian/ubuntu install instructions (#3312) * fix: correct debian/ubuntu install instructions This consolidates the Debian and Ubutnu install instructions into one section. The install instructions can be the same for both as they use the same package manager (i.e. apt). This removes the use of the now deprecated pipe to apt-key. This removes references to starting the service, as the service starts on install and does not require an extra step. Also all supported operating systems are using systemd at this point so no need to call that out seperatly. Removes an extra 'sudo' in deb instructions. * missing word * added flux 0.137.0 release notes, added vertica sql support docs (#3318) * Update _index.md (#3195) broken link for external plugin repo * Addresses #3284 (#3334) * Updates to Flux `to()` (#3260) Closes https://github.com/influxdata/DAR/issues/236. Closes #3258. Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Fix shim and other link (#3336) * Update Kapacitor security docs (#3325) Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Include TLS setup in Enterprise post-install steps (#3271) - Rename TLS guide file. - Use term "TLS" in title and introduction of TLS guide. Closes #3270. Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux 0.138.0 and 0.139.0 (#3335) * added release notes for flux 0.138 and 0.139 and related updates * updated spec with related implementation issue * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated to address PR feedback, added related links to int, uint, and bitwise docs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * hotfix load data link * add aliases and fix load data link in oss * API Ref docs processing (#3337) * chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml. Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future. Add an OpenAPI CLI docs-plugin with content and decorators. * chore: update api-docs/README.md * fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup. * chore: update cloud contract. * chore: update oss API contract. * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com> * edit from Tim: update v2.0 to v2.1 in API section * fix 2.1 links * Fix/api ref 2.1 (#3363) * fix: cloud-specific v1compat auth examples. * fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links. * fix: update API auth descriptions. add API ref v2.1. Update links in openapi content. * fix: updates URLs to v2.1 in API ref docs * add verify-tsm to 2.1 release notes * Clockface updates for 2.1 and Cloud (#3364) * versioned old icomoon font * updated all existing icons with versioned style * Revert "updated all existing icons with versioned style" This reverts commit 79b6cdf539542a5420ab3988b7ada9a0db497a23. * versioned icon shortcode * update icons and new styles for clockface v3 * updated nav-icon shortcode and styles * updated account nav icon styles * misc updates * general style updates * updated oss versions on the homepage * fixed tick card colors on homepage Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>
2021-11-08 17:48:11 +00:00
metadata: [] # List of metadata messages to include under the page h1
updated_in: # Product and version the referenced feature was updated in (displayed as a unique metadata)
```
2020-12-23 20:54:08 +00:00
### Title usage
##### `title`
The `title` frontmatter populates each page's HTML `h1` heading tag.
It shouldn't be overly long, but should set the context for users coming from outside sources.
##### `seotitle`
The `seotitle` frontmatter populates each page's HTML `title` attribute.
Search engines use this in search results (not the page's h1) and therefore it should be keyword optimized.
##### `list_title`
The `list_title` frontmatter determines an article title when in a list generated
by the [`{{< children >}}` shortcode](#generate-a-list-of-children-articles).
##### `menu > name`
The `name` attribute under the `menu` frontmatter determines the text used in each page's link in the site navigation.
It should be short and assume the context of its parent if it has one.
#### Page Weights
To ensure pages are sorted both by weight and their depth in the directory
structure, pages should be weighted in "levels."
All top level pages are weighted 1-99.
The next level is 101-199.
Then 201-299 and so on.
_**Note:** `_index.md` files should be weighted one level up from the other `.md` files in the same directory._
2020-12-23 20:54:08 +00:00
### Related content
2020-12-23 20:54:08 +00:00
Use the `related` frontmatter to include links to specific articles at the bottom of an article.
- If the page exists inside of this documentation, just include the path to the page.
It will automatically detect the title of the page.
- If the page exists inside of this documentation, but you want to customize the link text,
include the path to the page followed by a comma, and then the custom link text.
The path and custom text must be in that order and separated by a comma and a space.
- If the page exists outside of this documentation, include the full URL and a title for the link.
The link and title must be in that order and separated by a comma and a space.
```yaml
related:
- /v2.0/write-data/quick-start
- /v2.0/write-data/quick-start, This is custom text for an internal link
- https://influxdata.com, This is an external link
```
### Canonical URLs
2020-12-23 20:54:08 +00:00
Search engines use canonical URLs to accurately rank pages with similar or identical content.
The `canonical` HTML meta tag identifies which page should be used as the source of truth.
By default, canonical URLs are automatically generated for each page in the InfluxData
documentation using the latest version of the current product and the current path.
Use the `canonical` frontmatter to override the auto-generated canonical URL.
_**Note:** The `canonical` frontmatter supports the [`{{< latest >}}` shortcode](#latest-links)._
```yaml
canonical: /path/to/canonical/doc/
# OR
canonical: /{{< latest "influxdb" "v2" >}}/path/to/canonical/doc/
```
### v2 equivalent documentation
2020-12-23 20:54:08 +00:00
To display a notice on a 1.x page that links to an equivalent 2.0 page,
add the following frontmatter to the 1.x page:
```yaml
v2: /influxdb/v2.0/get-started/
```
### Prepend and append content to a page
Use the `prepend` and `append` frontmatter to add content to the top or bottom of a page.
Each has the following fields:
- **block:** _(Optional)_ block style to wrap content in (note, warn, cloud, or enterprise)
- **content:** _**(Required)**_ markdown content to add.
```yaml
append:
block: note
content: |
#### This is example markdown content
This is just an example note block that gets appended to the article.
```
Use this frontmatter with [cascade](#cascade) to add the same content to
all children pages as well.
```yaml
cascade:
append:
block: note
content: |
#### This is example markdown content
This is just an example note block that gets appended to the article.
```
2020-12-23 20:54:08 +00:00
### Cascade
2020-12-23 20:54:08 +00:00
To automatically apply frontmatter to a page and all of its children, use the
[`cascade` frontmatter](https://gohugo.io/content-management/front-matter/#front-matter-cascade)
built in into Hugo.
```yaml
title: Example page
description: Example description
cascade:
layout: custom-layout
```
`cascade` applies the frontmatter to all children unless the child already includes
those frontmatter keys. Frontmatter defined on the page overrides frontmatter
2020-12-23 20:54:08 +00:00
"cascaded" from a parent.
## Shortcodes
### Notes and warnings
Shortcodes are available for formatting notes and warnings in each article:
```md
{{% note %}}
Insert note markdown content here.
{{% /note %}}
{{% warn %}}
Insert warning markdown content here.
{{% /warn %}}
```
### Enterprise Content
For sections content that relate specifically to InfluxDB Enterprise, use the `{{% enterprise %}}` shortcode.
```md
{{% enterprise %}}
Insert enterprise-specific markdown content here.
{{% /enterprise %}}
```
#### Enterprise name
The name used to refer to InfluxData's enterprise offering is subject to change.
To facilitate easy updates in the future, use the `enterprise-name` shortcode
when referencing the enterprise product.
This shortcode accepts a `"short"` parameter which uses the "short-name".
```
This is content that references {{< enterprise-name >}}.
This is content that references {{< enterprise-name "short" >}}.
```
Product names are stored in `data/products.yml`.
#### Enterprise link
References to InfluxDB Enterprise are often accompanied with a link to a page where
visitors can get more information about the Enterprise offering.
This link is subject to change.
Use the `enterprise-link` shortcode when including links to more information about
InfluxDB Enterprise.
```
Find more info [here][{{< enterprise-link >}}]
```
### InfluxDB Cloud Content
For sections of content that relate specifically to InfluxDB Cloud, use the `{{% cloud %}}` shortcode.
```md
{{% cloud %}}
Insert cloud-specific markdown content here.
{{% /cloud %}}
```
#### InfluxDB Cloud name
The name used to refer to InfluxData's cloud offering is subject to change.
To facilitate easy updates in the future, use the `cloud-name` short-code when
referencing the cloud product.
This shortcode accepts a `"short"` parameter which uses the "short-name".
```
This is content that references {{< cloud-name >}}.
This is content that references {{< cloud-name "short" >}}.
```
Product names are stored in `data/products.yml`.
#### InfluxDB Cloud link
References to InfluxDB Cloud are often accompanied with a link to a page where
visitors can get more information.
This link is subject to change.
Use the `cloud-link` shortcode when including links to more information about
InfluxDB Cloud.
```
Find more info [here][{{< cloud-link >}}]
```
2020-08-19 19:53:38 +00:00
### Latest links
2020-08-19 19:53:38 +00:00
Each of the InfluxData projects have different "latest" versions.
Use the `{{< latest >}}` shortcode to populate link paths with the latest version
for the specified project.
```md
[Link to latest Telegraf](/{{< latest "telegraf" >}}/path/to/doc/)
```
To constrain the latest link to a major version, include a second argument with
the major version:
```md
[Link to latest InfluxDB 1.x](/{{< latest "influxdb" "v1" >}}/path/to/doc/)]
```
2020-08-19 19:53:38 +00:00
`{{< latest "telegraf" >}}` is replaced with `telegraf/v1.15` (or whatever the latest version is).
`{{< latest "influxdb" "v1" >}}` is replaced with `influxdb/v1.8` (or whatever the latest v1.x version is).
2020-08-19 19:53:38 +00:00
Use the following for project names:
- influxdb
- telegraf
- chronograf
- kapacitor
- enterprise_influxdb
**Note**: Include a leading slash before the latest shortcode and a trailing slash after in all link paths:
```md
/{{< latest "telegraf" >}}/
2020-08-19 19:53:38 +00:00
```
### Latest patch version
Use the `{{< latest-patch >}}` shortcode to add the latest patch version of a product.
By default, this shortcode parses the product and minor version from the URL.
To specify a specific product and minor version, use the `product` and `version` arguments.
Easier to maintain being you update the version number in the `data/products.yml` file instead of updating individual links and code examples.
```md
{{< latest-patch >}}
{{< latest-patch product="telegraf" >}}
{{< latest-patch product="chronograf" version="1.7" >}}
```
### Latest influx CLI version
Use the `{{< latest-cli >}}` shortcode to add the latest version of the `influx`
CLI supported by the minor version of InfluxDB.
By default, this shortcode parses the minor version from the URL.
To specify a specific minor version, use the `version` argument.
Maintain CLI version numbers in the `data/products.yml` file instead of updating individual links and code examples.
```md
{{< latest-cli >}}
{{< latest-cli version="2.1" >}}
```
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
### API endpoint
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
Use the `{{< api-endpoint >}}` shortcode to generate a code block that contains
a colored request method, a specified API endpoint, and an optional link to
the API reference documentation.
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
Provide the following arguments:
- **method**: HTTP request method (get, post, patch, put, or delete)
- **endpoint**: API endpoint
- **api-ref**: Link the endpoint to a specific place in the API documentation
InfluxDB Clustered documentation (#5126) * WIP base changes for clustered docs * WIP clustered docs * Add new influxdb/host shortcode and implement it in 3.0 docs (#5077) * add new influxdb/host shortcode and implement it in 3.0 docs * remove oss- cloud-only shortcodes from serverless * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * updated urls js to PR suggestion * Updated JavaScript, templates, and styles for Clustered URLs (#5079) * updated js, templates, and styles for clustered urls * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * restructure product dropdown template to be more extensible * fixed more page template bugs * fixed references to cloud in clustered * updated docsearch templates * added early access flagging and cta-link shortcode * minor content updates in clustered * updated staging config * fixed typo in clustered description * ported influxctl 2.0.1 to clustered * ported get started changes to clustered * ported 3.0 admin docs to clustered * port null tag content to clustered * ported influxctl note to clustered * ported query reorg changes to clustered * updated early access to limited availability, updated clustered landing content * ported new content to clustered * ported new content to clustered * updated cta on clustered landing page * Updated notifications and added InfluxDB Clustered announcement notification (#5125) * updated notifications, added clustered announcement notification * updated cta in clustered notification * updated influxctl profile configs * update clustered search attributes * updated learn more link in clustered notification * Apply suggestions from code review * fixed typos * fixed typos --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 12:21:47 +00:00
- **influxdb_host**: Specify which InfluxDB product host to use
_if the `endpoint` contains the `influxdb/host` shortcode_.
Uses the current InfluxDB product as default.
Supports the following product values:
- oss
- cloud
- serverless
- dedicated
- clustered
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
```md
{{< api-endpoint method="get" endpoint="/api/v2/tasks" api-ref="/influxdb/cloud/api/#operation/GetTasks">}}
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
```
InfluxDB Clustered documentation (#5126) * WIP base changes for clustered docs * WIP clustered docs * Add new influxdb/host shortcode and implement it in 3.0 docs (#5077) * add new influxdb/host shortcode and implement it in 3.0 docs * remove oss- cloud-only shortcodes from serverless * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * updated urls js to PR suggestion * Updated JavaScript, templates, and styles for Clustered URLs (#5079) * updated js, templates, and styles for clustered urls * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * restructure product dropdown template to be more extensible * fixed more page template bugs * fixed references to cloud in clustered * updated docsearch templates * added early access flagging and cta-link shortcode * minor content updates in clustered * updated staging config * fixed typo in clustered description * ported influxctl 2.0.1 to clustered * ported get started changes to clustered * ported 3.0 admin docs to clustered * port null tag content to clustered * ported influxctl note to clustered * ported query reorg changes to clustered * updated early access to limited availability, updated clustered landing content * ported new content to clustered * ported new content to clustered * updated cta on clustered landing page * Updated notifications and added InfluxDB Clustered announcement notification (#5125) * updated notifications, added clustered announcement notification * updated cta in clustered notification * updated influxctl profile configs * update clustered search attributes * updated learn more link in clustered notification * Apply suggestions from code review * fixed typos * fixed typos --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 12:21:47 +00:00
```md
{{< api-endpoint method="get" endpoint="{{< influxdb/host >}}/api/v2/tasks" influxdb_host="cloud">}}
```
### Tabbed Content
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
To create "tabbed" content (content that is changed by a users' selection), use the following three shortcodes in combination:
`{{< tabs-wrapper >}}`
This shortcode creates a wrapper or container for the tabbed content.
All UI interactions are limited to the scope of each container.
If you have more than one "group" of tabbed content in a page, each needs its own `tabs-wrapper`.
This shortcode must be closed with `{{< /tabs-wrapper >}}`.
**Note**: The `<` and `>` characters used in this shortcode indicate that the contents should be processed as HTML.
`{{% tabs %}}`
This shortcode creates a container for buttons that control the display of tabbed content.
It should contain simple markdown links with anonymous anchors (`#`).
The link text is used as the button text.
This shortcode must be closed with `{{% /tabs %}}`.
**Note**: The `%` characters used in this shortcode indicate that the contents should be processed as Markdown.
The `{{% tabs %}}` shortcode has an optional `style` argument that lets you
assign CSS classes to the tags HTML container. The following classes are available:
- **small**: Tab buttons are smaller and don't scale to fit the width.
- **even-wrap**: Prevents uneven tab widths when tabs are forced to wrap.
`{{% tab-content %}}`
This shortcode creates a container for a content block.
Each content block in the tab group needs to be wrapped in this shortcode.
**The number of `tab-content` blocks must match the number of links provided in the `tabs` shortcode**
This shortcode must be closed with `{{% /tab-content %}}`.
**Note**: The `%` characters used in this shortcode indicate that the contents should be processed as Markdown.
#### Example tabbed content group
```md
{{< tabs-wrapper >}}
{{% tabs %}}
[Button text for tab 1](#)
[Button text for tab 2](#)
{{% /tabs %}}
{{% tab-content %}}
Markdown content for tab 1.
{{% /tab-content %}}
{{% tab-content %}}
Markdown content for tab 2.
{{% /tab-content %}}
{{< /tabs-wrapper >}}
```
#### Tabbed code blocks
Shortcodes are also available for tabbed code blocks primarily used to give users
the option to choose between different languages and syntax.
The shortcode structure is the same as above, but the shortcode names are different:
`{{< code-tabs-wrapper >}}`
`{{% code-tabs %}}`
`{{% code-tab-content %}}`
````md
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Flux](#)
[InfluxQL](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```js
data = from(bucket: "example-bucket")
|> range(start: -15m)
|> filter(fn: (r) =>
r._measurement == "mem" and
r._field == "used_percent"
)
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```sql
SELECT "used_percent"
FROM "telegraf"."autogen"."mem"
WHERE time > now() - 15m
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
````
#### Link to tabbed content
To link to tabbed content, click on the tab and use the URL parameter shown.
It will have the form `?t=`, plus a string.
For example:
```
[Windows installation](/influxdb/v2.0/install/?t=Windows)
```
2020-11-25 22:39:25 +00:00
### Required elements
2020-11-25 22:39:25 +00:00
Use the `{{< req >}}` shortcode to identify required elements in documentation with
orange text and/or asterisks. By default, the shortcode outputs the text, "Required," but
you can customize the text by passing a string argument with the shortcode.
```md
{{< req >}}
```
**Output:** Required
```md
{{< req "This is Required" >}}
```
**Output:** This is required
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
If using other named arguments like `key` or `color`, use the `text` argument to
customize the text of the required message.
```md
{{< req text="Required if ..." color="blue" type="key" >}}
```
2020-11-25 22:39:25 +00:00
#### Required elements in a list
2020-11-25 22:39:25 +00:00
When identifying required elements in a list, use `{{< req type="key" >}}` to generate
a "\* Required" key before the list. For required elements in the list, include
2020-11-25 22:39:25 +00:00
{{< req "\*" >}} before the text of the list item. For example:
```md
{{< req type="key" >}}
- {{< req "\*" >}} **This element is required**
- {{< req "\*" >}} **This element is also required**
- **This element is NOT required**
```
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
#### Change color of required text
Kapacitor 1.6.0 (#2756) * base changes and cleanup for kapa 1.6 * Kapacitor 1.6.0 jstirnaman (#2684) * update: add kapacitor/v1/users to API doc (#2617). * fix: spelling * update: cleanup user API. * Apply suggestions from code review Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/kapacitor/v1.6/working/api.md * Update content/kapacitor/v1.6/working/api.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor 1.6.0 release notes (#2682) * Fix headings in Kapacitor release notes * Add 1.6.0 release notes Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Kapacitor Flux tasks (#2687) * kapacitor flux task setup * added crud docs for kapacitor flux tasks * added kapacitor flux task cli commands * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/kapacitor/v1.6/working/flux/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Kapacitor TrickleNode (#2694) * closes #2691 * WIP TrickleNode * add Trickle chaining methods * remove unused back-to-top links in kapacitor docs * Kapacitor 1.6 new configuration settings (#2693) * kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions * Kapacitor Zenoss event handler (#2695) * added zenoss event handler to kapacitor, closes #2271 * updated descriptions and removed defaults from zenoss event handler * updated kapacitor release notes * Updated Kapacitor Kafka event handler partitioning options (#2697) * updated kafka partitioning behavior, closes #2263 * fixed typos in kapacitor kafka content * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * added kafka link to release notes * Kapacitor API updates (#2718) * clean up kapacitor api headings * add flux task api endpoints to kapacitor api doc * Kapacitor authorization and authentication (#2717) * ported and revamped kapacitor authentication content, closes #2690 * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * updated comment in kapacitor auth example * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated edge.js * Add default kapacitor.conf locations (#2782) * added default kapacitor config locations, closes #2779 * Apply suggestions from code review * updated data for kapacitor 1.6.0 changelog Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 20:57:05 +00:00
Use the `color` argument to change the color of required text.
The following colors are available:
- blue
- green
- magenta
```md
{{< req color="magenta" text="This is required" >}}
```
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
### Page navigation buttons
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
Use the `{{< page-nav >}}` shortcode to add page navigation buttons to a page.
These are useful for guiding users through a set of docs that should be read in sequential order.
The shortcode has the following parameters:
- **prev:** path of the previous document _(optional)_
- **next:** path of the next document _(optional)_
- **prevText:** override the button text linking to the previous document _(optional)_
- **nextText:** override the button text linking to the next document _(optional)_
- **keepTab:** include the currently selected tab in the button link _(optional)_
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
The shortcode generates buttons that link to both the previous and next documents.
By default, the shortcode uses either the `list_title` or the `title` of the linked
document, but you can use `prevText` and `nextText` to override button text.
```md
<!-- Simple example -->
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{ page-nav prev="/path/to/prev/" next="/path/to/next" >}}
<!-- Override button text -->
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{ page-nav prev="/path/to/prev/" prevText="Previous" next="/path/to/next" nextText="Next" >}}
<!-- Add currently selected tab to button link -->
{{ page-nav prev="/path/to/prev/" next="/path/to/next" keepTab=true>}}
```
### Keybinds
Use the `{{< keybind >}}` shortcode to include OS-specific keybindings/hotkeys.
The following parameters are available:
- mac
- linux
- win
- all
- other
```md
<!-- Provide keybinding for one OS and another for all others -->
{{< keybind mac="⇧⌘P" other="Ctrl+Shift+P" >}}
<!-- Provide a keybind for all OSs -->
{{< keybind all="Ctrl+Shift+P" >}}
<!-- Provide unique keybindings for each OS -->
{{< keybind mac="⇧⌘P" linux="Ctrl+Shift+P" win="Ctrl+Shift+Alt+P" >}}
```
### Diagrams
Use the `{{< diagram >}}` shortcode to dynamically build diagrams.
The shortcode uses [mermaid.js](https://github.com/mermaid-js/mermaid) to convert
simple text into SVG diagrams.
For information about the syntax, see the [mermaid.js documentation](https://mermaid-js.github.io/mermaid/#/).
```md
{{< diagram >}}
flowchart TB
This --> That
That --> There
{{< /diagram >}}
```
### File system diagrams
Use the `{{< filesystem-diagram >}}` shortcode to create a styled file system
diagram using a Markdown unordered list.
##### Example filesystem diagram shortcode
```md
{{< filesystem-diagram >}}
- Dir1/
- Dir2/
- ChildDir/
- Child
- Child
- Dir3/
{{< /filesystem-diagram >}}
```
### High-resolution images
In many cases, screenshots included in the docs are taken from high-resolution (retina) screens.
Because of this, the actual pixel dimension is 2x larger than it needs to be and is rendered 2x bigger than it should be.
The following shortcode automatically sets a fixed width on the image using half of its actual pixel dimension.
This preserves the detail of the image and renders it at a size where there should be little to no "blur"
cause by browser image resizing.
```html
{{< img-hd src="/path/to/image" alt="Alternate title" />}}
```
###### Notes
- This should only be used on screenshots takes from high-resolution screens.
- The `src` should be relative to the `static` directory.
- Image widths are limited to the width of the article content container and will scale accordingly,
even with the `width` explicitly set.
### Truncated content blocks
In some cases, it may be appropriate to shorten or truncate blocks of content.
Use cases include long examples of output data or tall images.
The following shortcode truncates blocks of content and allows users to opt into
to seeing the full content block.
```md
{{% truncate %}}
Truncated markdown content here.
{{% /truncate %}}
```
### Expandable accordion content blocks
Use the `{{% expand "Item label" %}}` shortcode to create expandable, accordion-style content blocks.
Each expandable block needs a label that users can click to expand or collapse the content block.
Pass the label as a string to the shortcode.
```md
{{% expand "Label 1" %}}
Markdown content associated with label 1.
{{% /expand %}}
{{% expand "Label 2" %}}
Markdown content associated with label 2.
{{% /expand %}}
{{% expand "Label 3" %}}
Markdown content associated with label 3.
{{% /expand %}}
```
Use the optional `{{< expand-wrapper >}}` shortcode around a group of `{{% expand %}}`
shortcodes to ensure proper spacing around the expandable elements:
```md
{{< expand-wrapper >}}
{{% expand "Label 1" %}}
Markdown content associated with label 1.
{{% /expand %}}
{{% expand "Label 2" %}}
Markdown content associated with label 2.
{{% /expand %}}
{{< /expand-wrapper >}}
```
### Captions
Use the `{{% caption %}}` shortcode to add captions to images and code blocks.
Captions are styled with a smaller font size, italic text, slight transparency,
and appear directly under the previous image or code block.
```md
{{% caption %}}
Markdown content for the caption.
{{% /caption %}}
```
### Generate a list of children articles
Section landing pages often contain just a list of articles with links and descriptions for each.
This can be cumbersome to maintain as content is added.
To automate the listing of articles in a section, use the `{{< children >}}` shortcode.
```md
{{< children >}}
```
The children shortcode can also be used to list only "section" articles (those with their own children),
or only "page" articles (those with no children) using the `show` argument:
```md
{{< children show="sections" >}}
<!-- OR -->
{{< children show="pages" >}}
```
_By default, it displays both sections and pages._
Use the `type` argument to specify the format of the children list.
```md
{{< children type="functions" >}}
```
The following list types are available:
- **articles:** lists article titles as headers with the description or summary
of the article as a paragraph. Article headers link to the articles.
- **list:** lists children article links in an unordered list.
- **anchored-list:** lists anchored children article links in an unordered list
meant to act as a page navigation and link to children header.
- **functions:** a special use-case designed for listing Flux functions.
#### Include a "Read more" link
To include a "Read more" link with each child summary, set `readmore=true`.
_Only the `articles` list type supports "Read more" links._
```md
{{< children readmore=true >}}
```
#### Include a horizontal rule
To include a horizontal rule after each child summary, set `hr=true`.
_Only the `articles` list type supports horizontal rules._
```md
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{< children hr=true >}}
```
#### Include a code example with a child summary
Use the `list_code_example` frontmatter to provide a code example with an article
in an articles list.
````yaml
list_code_example: |
```sh
This is a code example
```
````
#### Organize and include native code examples
To include text from a file in `/shared/text/`, use the
`{{< get-shared-text >}}` shortcode and provide the relative path and filename.
This is useful for maintaining and referencing sample code variants in their
native file formats.
1. Store code examples in their native formats at `/shared/text/`.
```md
/shared/text/example1/example.js
/shared/text/example1/example.py
```
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
2. Include the files--for example, in code tabs:
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
````md
{{% code-tabs-wrapper %}}
{{% code-tabs %}}
[Javascript](#js)
[Python](#py)
{{% /code-tabs %}}
{{% code-tab-content %}}
```js
{{< get-shared-text "example1/example.js" >}}
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```py
{{< get-shared-text "example1/example.py" >}}
```
{{% /code-tab-content %}}
{{% /code-tabs-wrapper %}}
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
````
#### Include specific files from the same directory
To include the text from one file in another file in the same
directory, use the `{{< get-leaf-text >}}` shortcode.
The directory that contains both files must be a
Hugo [_Leaf Bundle_](https://gohugo.io/content-management/page-bundles/#leaf-bundles),
a directory that doesn't have any child directories.
In the following example, `api` is a leaf bundle. `content` isn't.
```md
content
|
|--- api
| query.pdmc
| query.sh
| \_index.md
```
##### query.pdmc
```md
# Query examples
```
##### query.sh
```md
curl https://localhost:8086/query
```
To include `query.sh` and `query.pdmc` in `api/_index.md`, use the following code:
````md
{{< get-leaf-text "query.pdmc" >}}
# Curl example
```sh
{{< get-leaf-text "query.sh" >}}
```
````
Avoid using the following file extensions when naming included text files since Hugo interprets these as markup languages:
`.ad`, `.adoc`, `.asciidoc`, `.htm`, `.html`, `.markdown`, `.md`, `.mdown`, `.mmark`, `.pandoc`, `.pdc`, `.org`, or `.rst`.
#### Reference a query example in children
To include a query example with the children in your list, update `data/query_examples.yml`
with the example code, input, and output, and use the `list_query_example`
frontmatter to reference the corresponding example.
```yaml
list_query_example: cumulative_sum
```
#### Children frontmatter
Each children list `type` uses [frontmatter properties](#page-frontmatter) when generating the list of articles.
The following table shows which children types use which frontmatter properties:
| Frontmatter | articles | list | functions |
| :------------------- | :------: | :--: | :-------: |
| `list_title` | ✓ | ✓ | ✓ |
| `description` | ✓ | | |
| `external_url` | ✓ | ✓ | |
| `list_image` | ✓ | | |
| `list_note` | | ✓ | |
| `list_code_example` | ✓ | | |
| `list_query_example` | ✓ | | |
### Inline icons
The `icon` shortcode allows you to inject icons in paragraph text.
It's meant to clarify references to specific elements in the InfluxDB user interface.
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
This shortcode supports Clockface (the UI) v2 and v3.
Specify the version to use as the second argument. The default version is `v3`.
```
InfluxDB 2.1 (#3367) * base changes for influxdb 2.1 * remove duplicates in draft * draft categories * add categories * Document wildcards in SHOW MEASUREMENTS ON queries (#3273) * InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries This applies to InfluxDB 2.1. See #3201 * latest notes * Update `influxd --store` values (#3272) * Use Unix ~ alias * Add sqlite path to file layout doc * add sqlite to filesystem diagrams * draft 2.1 release notes +questions * revert to check RNs changes in separately * latest release notes * Restructure installation docs for separate CLI package (#3280) * influxdb and cli install revamp * reorganized CLI install instructions * remove unnecessary short-code parameters * updated docs to address PR feedback * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * update linux install instructions Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * release note updates * updates * add support for annotations in OSS 2.1 (#3286) * Document support for bearer auth sytax (#3297) * 2.1 oss notebooks (#3281) * Move notebooks to OSS (addresses #2951 ) * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/manage-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add PR feedback Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Fix link in bearer auth sytax doc (#3298) * Updated CLI docs content and added version metadata (#3285) * added metadata styles and data to cli docs * added missing ui-disabled influxd config flag * added updated versions to influx cli metadata * added metadata to all cloud influx cli docs * updated influx ping in cloud to have oss only tag * Update influxd documentation for 2.1 (#3302) * update and dynamically generate links to influxd flags (#3288) * remove 2.1 config options from 2.0 * New influxd commands (#3291) * added basic influxd recovery commands * added influxd recover commands, WIP for other influxd inspect commands * updated all influxd inspect commands * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated influxd docs to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add static legend to band and graph visualizations (#3315) * update band vis to include static legend * upd graph and graph-single-stat w static legend * update 2.1 links * update to latest Flux links * fix Flux links * Influxdb 2.1 release notes (#3279) * draft release notes * latest RN changes * test * revert * for review purposes * incorporate changes from new changelog * add note about new metadata included in CLI docs * edit * more edits * add overview features list * tweak verbiage about Telegraf support * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * add link * add edits from Scott, Dan, and Will * edits from dan * highlight and distinguish CLI separation changes * add links to new API endpoints * formatting upd * edits for secrets * mv Flux location support after rsv merge conflicts * edits from Tim * update influxql link * rmv SLQ metastore link * minor updates to 2.1 release notes * prep * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> * add new Telegraf plugins to release notes * edit from Will * 2.1 upgrade and downgrade instructions (#3332) * influxd downgrade command, add upgrade instructions, closes #3331 * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daniel Moran <danxmoran@gmail.com> * udpated downgrade docs to address PR feedback * remove references to localhost:1313 Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * updated flux version in release notes, added other new items, closes #3338 (#3344) * Chore/update oss api (#3341) * Standardize the term "key-value" (#3283) * s|key/value|key-value * Use en dash in prefix to open compound "time series" * CLI 2.2 (#3269) * add -b shorthand to influx delete * add cli 2.2 release notes * add example for all-access token * edits * updates to influx auth create * edits for operator token * remove inaccurate env var * Update influx-cli.md * Update influx-cli.md * make capitalization consistent with other docs * make headers parallel * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott and Dan * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * edits to CLI * add oss-only shortcode and fix formatting * format updates * fix links * add oss-only inline * fix list * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Dan * emphasize recommendation * edit from Dan re limits and page size * edit f Sam * update release date * remove vague description * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * add cloud updates in Sept (#3210) * Fix numbering in AWS install doc (#3293) Closes #3292 * Document new API Invocable Scripts feature (was named-functions) (#3282) * feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233). * feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters. * feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet. * feat: rename example function for simplicity since there's no GET for now. * feat: add find_and_update example (#2547). * feat: add update example. Clarify, expand invoke example. Add links. (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: remove accidental commit of generated redoc-static.html * feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml. * fix: replace /functions with /scripts * feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml * feat: invocable scripts (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * feat: new section for params (#2547). * fix: swagger server url (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * feat: remove jq and function where there's no clear need. Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: add Invocable Scripts tag description. (#3296) * Fix api invocable (#3299) * fix: scripts api path. * fix: bad comma * Fix api invocable (#3306) * fix: scripts api path. * fix: bad comma * feat: add invocable scripts example for sending multiple parameter values. * fix: endpoint text. (#3308) * Fix api invocable (#3310) * fix: measurement -> point * fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest. * updated token naming and other typos, closes influxdata/DAR#244 (#3309) * Flux 0.136 (#3311) * Flux 0.136.0 release notes * Update pagerduty package for flux 0.136.0 (#3303) * Add Flux ServiceNow package (#3304) * added Flux servicenow package * Apply suggestions from code review * Enterprise dar updates (#3313) * removed references to web server in enteprise cluster docs, closes influxdata/DAR#245 * updated enterprise upgrade instructions, closes influxdata/DAR#243 * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: mjs example path (#3305) (#3316) * 3240 fix nodejs alias (#3317) * fix: mjs example path (#3305) * fix: add alias to node.js client library (#3240) * Edit description for amd_rocm_smi Telegraf plugin (#3186) * Edit description for amd_rocm_smi Telegraf plugin Edit name and description for amd_rocm_smi Telegraf plugin. Not sure if this is the only location that it needs to be udpated. * cpl minor updates Co-authored-by: Kelly <kelly@influxdata.com> * remove influxql support from v2 api, closes influxdata/DAR#246 (#3326) * Telegraf 1.20.3 (#3328) * Telegraf 1.20.3 * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * docs: update telegraf configuration.md (#3300) * docs: update telegraf configuration.md * add note about rate limits * fix: correct debian/ubuntu install instructions (#3312) * fix: correct debian/ubuntu install instructions This consolidates the Debian and Ubutnu install instructions into one section. The install instructions can be the same for both as they use the same package manager (i.e. apt). This removes the use of the now deprecated pipe to apt-key. This removes references to starting the service, as the service starts on install and does not require an extra step. Also all supported operating systems are using systemd at this point so no need to call that out seperatly. Removes an extra 'sudo' in deb instructions. * missing word * added flux 0.137.0 release notes, added vertica sql support docs (#3318) * Update _index.md (#3195) broken link for external plugin repo * Addresses #3284 (#3334) * Updates to Flux `to()` (#3260) Closes https://github.com/influxdata/DAR/issues/236. Closes #3258. Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Fix shim and other link (#3336) * Update Kapacitor security docs (#3325) Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Include TLS setup in Enterprise post-install steps (#3271) - Rename TLS guide file. - Use term "TLS" in title and introduction of TLS guide. Closes #3270. Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux 0.138.0 and 0.139.0 (#3335) * added release notes for flux 0.138 and 0.139 and related updates * updated spec with related implementation issue * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated to address PR feedback, added related links to int, uint, and bitwise docs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * hotfix load data link * add aliases and fix load data link in oss * API Ref docs processing (#3337) * chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml. Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future. Add an OpenAPI CLI docs-plugin with content and decorators. * chore: update api-docs/README.md * fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup. * chore: update cloud contract. * chore: update oss API contract. * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com> * edit from Tim: update v2.0 to v2.1 in API section * fix 2.1 links * Fix/api ref 2.1 (#3363) * fix: cloud-specific v1compat auth examples. * fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links. * fix: update API auth descriptions. add API ref v2.1. Update links in openapi content. * fix: updates URLs to v2.1 in API ref docs * add verify-tsm to 2.1 release notes * Clockface updates for 2.1 and Cloud (#3364) * versioned old icomoon font * updated all existing icons with versioned style * Revert "updated all existing icons with versioned style" This reverts commit 79b6cdf539542a5420ab3988b7ada9a0db497a23. * versioned icon shortcode * update icons and new styles for clockface v3 * updated nav-icon shortcode and styles * updated account nav icon styles * misc updates * general style updates * updated oss versions on the homepage * fixed tick card colors on homepage Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>
2021-11-08 17:48:11 +00:00
{{< icon "icon-name" "v2" >}}
```
Below is a list of available icons (some are aliases):
- add-cell
- add-label
- alert
- calendar
- chat
- checkmark
- clone
- cloud
- cog
- config
- copy
- dashboard
- dashboards
- data-explorer
2019-10-07 17:22:54 +00:00
- delete
- download
- duplicate
- edit
- expand
- export
2019-10-07 17:22:54 +00:00
- eye
- eye-closed
- eye-open
- feedback
- fullscreen
- gear
- graph
2019-10-07 17:22:54 +00:00
- hide
- influx
- influx-icon
- nav-admin
- nav-config
- nav-configuration
- nav-dashboards
- nav-data-explorer
- nav-organizations
- nav-orgs
- nav-tasks
- note
2020-12-02 22:10:59 +00:00
- notebook
- notebooks
- org
- orgs
- pause
- pencil
- play
- plus
- refresh
- remove
- replay
- save-as
- search
- settings
- tasks
2019-10-07 17:22:54 +00:00
- toggle
- trash
- trashcan
- triangle
2019-10-07 17:22:54 +00:00
- view
- wrench
- x
2019-02-28 22:30:28 +00:00
### InfluxDB UI left navigation icons
2019-02-28 22:30:28 +00:00
In many cases, documentation references an item in the left nav of the InfluxDB UI.
2019-11-01 17:25:25 +00:00
Provide a visual example of the navigation item using the `nav-icon` shortcode.
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
This shortcode supports Clockface (the UI) v2 and v3.
Specify the version to use as the second argument. The default version is `v3`.
2019-02-28 22:30:28 +00:00
```
InfluxDB 2.1 (#3367) * base changes for influxdb 2.1 * remove duplicates in draft * draft categories * add categories * Document wildcards in SHOW MEASUREMENTS ON queries (#3273) * InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries This applies to InfluxDB 2.1. See #3201 * latest notes * Update `influxd --store` values (#3272) * Use Unix ~ alias * Add sqlite path to file layout doc * add sqlite to filesystem diagrams * draft 2.1 release notes +questions * revert to check RNs changes in separately * latest release notes * Restructure installation docs for separate CLI package (#3280) * influxdb and cli install revamp * reorganized CLI install instructions * remove unnecessary short-code parameters * updated docs to address PR feedback * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * update linux install instructions Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * release note updates * updates * add support for annotations in OSS 2.1 (#3286) * Document support for bearer auth sytax (#3297) * 2.1 oss notebooks (#3281) * Move notebooks to OSS (addresses #2951 ) * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/manage-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add PR feedback Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Fix link in bearer auth sytax doc (#3298) * Updated CLI docs content and added version metadata (#3285) * added metadata styles and data to cli docs * added missing ui-disabled influxd config flag * added updated versions to influx cli metadata * added metadata to all cloud influx cli docs * updated influx ping in cloud to have oss only tag * Update influxd documentation for 2.1 (#3302) * update and dynamically generate links to influxd flags (#3288) * remove 2.1 config options from 2.0 * New influxd commands (#3291) * added basic influxd recovery commands * added influxd recover commands, WIP for other influxd inspect commands * updated all influxd inspect commands * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated influxd docs to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add static legend to band and graph visualizations (#3315) * update band vis to include static legend * upd graph and graph-single-stat w static legend * update 2.1 links * update to latest Flux links * fix Flux links * Influxdb 2.1 release notes (#3279) * draft release notes * latest RN changes * test * revert * for review purposes * incorporate changes from new changelog * add note about new metadata included in CLI docs * edit * more edits * add overview features list * tweak verbiage about Telegraf support * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * add link * add edits from Scott, Dan, and Will * edits from dan * highlight and distinguish CLI separation changes * add links to new API endpoints * formatting upd * edits for secrets * mv Flux location support after rsv merge conflicts * edits from Tim * update influxql link * rmv SLQ metastore link * minor updates to 2.1 release notes * prep * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> * add new Telegraf plugins to release notes * edit from Will * 2.1 upgrade and downgrade instructions (#3332) * influxd downgrade command, add upgrade instructions, closes #3331 * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daniel Moran <danxmoran@gmail.com> * udpated downgrade docs to address PR feedback * remove references to localhost:1313 Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * updated flux version in release notes, added other new items, closes #3338 (#3344) * Chore/update oss api (#3341) * Standardize the term "key-value" (#3283) * s|key/value|key-value * Use en dash in prefix to open compound "time series" * CLI 2.2 (#3269) * add -b shorthand to influx delete * add cli 2.2 release notes * add example for all-access token * edits * updates to influx auth create * edits for operator token * remove inaccurate env var * Update influx-cli.md * Update influx-cli.md * make capitalization consistent with other docs * make headers parallel * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott and Dan * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * edits to CLI * add oss-only shortcode and fix formatting * format updates * fix links * add oss-only inline * fix list * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Dan * emphasize recommendation * edit from Dan re limits and page size * edit f Sam * update release date * remove vague description * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * add cloud updates in Sept (#3210) * Fix numbering in AWS install doc (#3293) Closes #3292 * Document new API Invocable Scripts feature (was named-functions) (#3282) * feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233). * feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters. * feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet. * feat: rename example function for simplicity since there's no GET for now. * feat: add find_and_update example (#2547). * feat: add update example. Clarify, expand invoke example. Add links. (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: remove accidental commit of generated redoc-static.html * feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml. * fix: replace /functions with /scripts * feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml * feat: invocable scripts (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * feat: new section for params (#2547). * fix: swagger server url (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * feat: remove jq and function where there's no clear need. Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: add Invocable Scripts tag description. (#3296) * Fix api invocable (#3299) * fix: scripts api path. * fix: bad comma * Fix api invocable (#3306) * fix: scripts api path. * fix: bad comma * feat: add invocable scripts example for sending multiple parameter values. * fix: endpoint text. (#3308) * Fix api invocable (#3310) * fix: measurement -> point * fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest. * updated token naming and other typos, closes influxdata/DAR#244 (#3309) * Flux 0.136 (#3311) * Flux 0.136.0 release notes * Update pagerduty package for flux 0.136.0 (#3303) * Add Flux ServiceNow package (#3304) * added Flux servicenow package * Apply suggestions from code review * Enterprise dar updates (#3313) * removed references to web server in enteprise cluster docs, closes influxdata/DAR#245 * updated enterprise upgrade instructions, closes influxdata/DAR#243 * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: mjs example path (#3305) (#3316) * 3240 fix nodejs alias (#3317) * fix: mjs example path (#3305) * fix: add alias to node.js client library (#3240) * Edit description for amd_rocm_smi Telegraf plugin (#3186) * Edit description for amd_rocm_smi Telegraf plugin Edit name and description for amd_rocm_smi Telegraf plugin. Not sure if this is the only location that it needs to be udpated. * cpl minor updates Co-authored-by: Kelly <kelly@influxdata.com> * remove influxql support from v2 api, closes influxdata/DAR#246 (#3326) * Telegraf 1.20.3 (#3328) * Telegraf 1.20.3 * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * docs: update telegraf configuration.md (#3300) * docs: update telegraf configuration.md * add note about rate limits * fix: correct debian/ubuntu install instructions (#3312) * fix: correct debian/ubuntu install instructions This consolidates the Debian and Ubutnu install instructions into one section. The install instructions can be the same for both as they use the same package manager (i.e. apt). This removes the use of the now deprecated pipe to apt-key. This removes references to starting the service, as the service starts on install and does not require an extra step. Also all supported operating systems are using systemd at this point so no need to call that out seperatly. Removes an extra 'sudo' in deb instructions. * missing word * added flux 0.137.0 release notes, added vertica sql support docs (#3318) * Update _index.md (#3195) broken link for external plugin repo * Addresses #3284 (#3334) * Updates to Flux `to()` (#3260) Closes https://github.com/influxdata/DAR/issues/236. Closes #3258. Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Fix shim and other link (#3336) * Update Kapacitor security docs (#3325) Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Include TLS setup in Enterprise post-install steps (#3271) - Rename TLS guide file. - Use term "TLS" in title and introduction of TLS guide. Closes #3270. Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux 0.138.0 and 0.139.0 (#3335) * added release notes for flux 0.138 and 0.139 and related updates * updated spec with related implementation issue * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated to address PR feedback, added related links to int, uint, and bitwise docs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * hotfix load data link * add aliases and fix load data link in oss * API Ref docs processing (#3337) * chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml. Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future. Add an OpenAPI CLI docs-plugin with content and decorators. * chore: update api-docs/README.md * fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup. * chore: update cloud contract. * chore: update oss API contract. * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com> * edit from Tim: update v2.0 to v2.1 in API section * fix 2.1 links * Fix/api ref 2.1 (#3363) * fix: cloud-specific v1compat auth examples. * fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links. * fix: update API auth descriptions. add API ref v2.1. Update links in openapi content. * fix: updates URLs to v2.1 in API ref docs * add verify-tsm to 2.1 release notes * Clockface updates for 2.1 and Cloud (#3364) * versioned old icomoon font * updated all existing icons with versioned style * Revert "updated all existing icons with versioned style" This reverts commit 79b6cdf539542a5420ab3988b7ada9a0db497a23. * versioned icon shortcode * update icons and new styles for clockface v3 * updated nav-icon shortcode and styles * updated account nav icon styles * misc updates * general style updates * updated oss versions on the homepage * fixed tick card colors on homepage Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>
2021-11-08 17:48:11 +00:00
{{< nav-icon "tasks" "v2" >}}
2019-02-28 22:30:28 +00:00
```
The following case insensitive values are supported:
2019-10-07 17:22:54 +00:00
- admin, influx
- data-explorer, data explorer
2020-12-02 22:10:59 +00:00
- notebooks, books
2019-02-28 22:30:28 +00:00
- dashboards
- tasks
2019-10-07 17:22:54 +00:00
- monitor, alerts, bell
- cloud, usage
2021-11-10 00:00:25 +00:00
- data, load data, load-data
2019-10-07 17:22:54 +00:00
- settings
- feedback
2019-02-28 22:30:28 +00:00
### Flexbox-formatted content blocks
CSS Flexbox formatting lets you create columns in article content that adjust and
flow based on the viewable width.
In article content, this helps if you have narrow tables that could be displayed
side-by-side, rather than stacked vertically.
Use the `{{< flex >}}` shortcode to create the Flexbox wrapper.
Use the `{{% flex-content %}}` shortcode to identify each column content block.
```md
{{< flex >}}
{{% flex-content %}}
Column 1
{{% /flex-content %}}
{{% flex-content %}}
Column 2
{{% /flex-content %}}
{{< /flex >}}
```
`{{% flex-content %}}` has an optional width argument that determines the maximum
width of the column.
```md
{{% flex-content "half" %}}
```
The following options are available:
- half _(Default)_
- third
- quarter
### Tooltips
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
Use the `{{< tooltip >}}` shortcode to add tooltips to text.
The **first** argument is the text shown in the tooltip.
The **second** argument is the highlighted text that triggers the tooltip.
```md
I like {{< tooltip "Butterflies are awesome!" "butterflies" >}}.
```
Strategies to improve query performance: operations, number and size … (#5215) * Strategies to improve query performance: operations, number and size of parquet files Fixes #5108 - Add query performance strategies to optimize-queries * Apply suggestions from code review * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * chore(v3): WIP query perf Fixes #5108 * chore(v3): WIP: Query performance * chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems. * WIP: optimize queries - how to read a query plan, operators * WIP: Read a query plan example 2 * WIP: moved how to read a query plan to its own page. * WIP(v3): operators * chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN * chore(v3): WIP read a query plan - explain tree format and reorganize * WIP: query plan - Adds Query Plan reference - Completes Analyze a Query Plan, pending cleanup, continue at :471 - Added image from Nga's blog - Updates EXPLAIN doc - TODO: Create public docs for https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(spelling): Vale config changes - Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually. - Move InfluxData spelling ignore list into the style. - Reorganize custom (product) spelling lists to comply with Vale 3.x - Add InfluxDB v3 terms * chore(v3): Reorg of query troubleshooting and optimizing docs - Adds query-data/troubleshoot-and-optimize - Splits optimize docs into troubleshoot and optimize docs - Moves Flight response doc to flight-responses.md * chore: Fixes broken links, typos, missing content, etc. - Fixes various errors and style violations reported by Vale. - Fixes broken links and missing content in glossaries. - Fixes missing and extraneous whitespace. * Apply suggestions from code review * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md * chore(clustered): Query plan: Apply review suggestions Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> * feature(v3): Analyze a query plan: - Apply code formatting to plan implementor names - Simplify some points - Add links * add query plan html diagram (#5365) * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): finish the EXPLAIN descriptions and examples * chore(tests): Setup a python venv in test containers * fix(ci): Vale vocab * fix(v3): Punctuation typo * chore(ci): Update README * fix(v3): Apply review suggestions and capitalization Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix(v3): Add note to optimize page and revise troubleshoot * fix(v3): optimize-queries link --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 23:40:38 +00:00
The rendered output is "I like butterflies" with "butterflies" highlighted.
When you hover over "butterflies," a tooltip appears with the text: "Butterflies are awesome!"
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
### Flux sample data tables
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
The Flux `sample` package provides basic sample datasets that can be used to
illustrate how Flux functions work. To quickly display one of the raw sample
datasets, use the `{{% flux/sample %}}` shortcode.
The `flux/sample` shortcode has the following arguments that can be specified
by name or positionally.
#### set
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
Sample dataset to output. Use either `set` argument name or provide the set
as the first argument. The following sets are available:
- float
- int
- uint
- string
- bool
- numericBool
#### includeNull
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
Specify whether or not to include _null_ values in the dataset.
Use either `includeNull` argument name or provide the boolean value as the second argument.
#### includeRange
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
Specify whether or not to include time range columns (`_start` and `_stop`) in the dataset.
This is only recommended when showing how functions that require a time range
(such as `window()`) operate on input data.
Use either `includeRange` argument name or provide the boolean value as the third argument.
##### Example Flux sample data shortcodes
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
```md
<!-- No arguments, defaults to "float" set without nulls -->
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{% flux/sample %}}
<!-- Output the "string" set without nulls or time range columns -->
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{% flux/sample set="string" includeNull=false %}}
<!-- Output the "int" set with nulls but without time range columns -->
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{% flux/sample "int" true %}}
<!-- Output the "int" set with nulls and time range columns -->
<!-- The following shortcode examples render the same -->
Flux restructure (#3141) * initial changes for flux restructure * added all aliases * added introduced date to all flux functions * marked linearBins and logarithmicBins as draft * migrated flux stdlib to new flux section, added version range to article template * fixed list-all-functions shortcode * duplicated and reordered flux spec, added page-nav shortcode, closes #1870 * added filtering functionality to list-all-functions shortcode * added function tags * Stdlib reorg (#2130) * consolidated influxdb packages * stdlib rename and reorg * reorg existing contrib docs * added keep-url to http.get example * reorg built-in directory, add function types docs * updated links * updated all related links * fixed reference links in influxdb docs * updated all internal flux links * updated flux links in influxdb * one last link update * restyle product dropdown * update flux links in influxdb 1.7 and 1.8 * fixed shortcode call * updated task options in flux options doc * Flux 'interpolate' package (#2148) * add interpolate package, closes #1649 * added missing page description to interpolate package doc * removed unnecessary space from interpolate description * updated interpolate package description * ported from() note to new flux section * New list filter javascript (#2185) * generalized list filtering for telegraf plugins and flux functions * added flux tags, updated filter list functionality * added more flux tags * added new experimental functions * updated derivative params * ported over new experimental functions * fixed bad copy-pasta * ported new notification endpoints into new flux docs * updated flux function categories * ported flux changes from master * fixed product dropdown * fixed regexp.findString example * ported flux 0.109 changes * updated array package aliases and supported version * ported new functions into flux dir * added aliases to interpolate package * ported flux v0.114 packages * added enterpise logic to url selector modal * fix minor typo * Update Flux param type convention (#2515) * fix minor typo * WIP new flux data type convention * wip more param type updates * cleaned up function type specs * ported flux 0.115.0 packages and functions * ported tickscript package * ported today function * added aliases to tickscript pkg * updated timedMovingAverage params example * updated to function with remote creds * port flux 0.118 changes over * port flux changes into flux-restructure * ported changes from flux 0.123.0 and updated flux function docs * updated contrib package summary * updated function definition of schema.tagValues * ported recent flux changes to the restructure branch * port changes from master * Flux get started (#3036) * Flux group keys demo (#2553) * interactive group key example * added js and shortcode for group key demo * updated group key demo to address PR feedback * shortened sample data set * Flux get started intro and data model (#2619) * starting flux intro content, resolved merge conflicts * WIP flux get started docs * WIP flux get started * flux get started intro and data model * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Update content/flux/v0.x/get-started/data-model.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback in flux get started * updated flux docs landing page * more updates to flux landing page Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux query basics (#2887) * WIP flux query basics * WIP flux query basics * WIP flux query basics * WIP flux query basics * wrap up content for flux query basics * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * properly close code block on flux query basics * Flux – query data (#2891) * added query data sources with flux and query influxdb * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/query-data/influxdb.md * Query Prometheus with Flux (#2893) * query prometheus with flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Query CSV data with Flux (#2895) * query csv data with flux * address PR feedback * Update content/flux/v0.x/query-data/csv.md * update flux query data sources landing page * updated flux query data doc formats and links * Query SQL databases (#2922) * WIP query sql guides * query SQL data sources, closes #1738 * updated related link on sql.from * added link to stream of tables and updated text * updated connection string text * updated query sql landing page and children hr styles * updated sql query docs to address PR feedback * added missing colon * Query Google Cloud Bigtable with Flux (#2928) * Query Google Cloud Bigtable with Flux * updated doc structure of query bigtable doc * fixed typo in bigquery doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with Flux data types (#2967) * scaffolding for flux types, work with strings * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * removed note about interpolation vs concatenation * updated wording of variable type association * generalized type inference * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * WIP work with ints * reverted int content * updated strings doc to address PR feedback * added description to data types landing page * Apply suggestions from code review * Update content/flux/v0.x/data-types/basic/string.md * updated composite front-matter * Work with time types in Flux (#2974) * work with time types in flux, closes #2260 * updated time type doc * fixed type in time type description * fixed typo * updated work with time doc * fixed typos * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated time type doc to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with booleans (#2975) * work with boolean types * updated working with booleans * updated verbiage * added related links * Update content/flux/v0.x/data-types/basic/boolean.md * Work with bytes types (#2976) * work with bytes types * added toc to bytes type doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated work with bytes doc * fixed typo * added related links Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Work with durations (#2977) * work with durations in flux * added keywords to duration doc to improve searchability * minor updates to duration type doc * updated verbiage * added related links and removed toDuration from menu * Update content/flux/v0.x/data-types/basic/duration.md * Work with null types (#2978) * WIP null types * work with null types in flux * updated null types doc * Update content/flux/v0.x/data-types/basic/null.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with floats (#2979) * work with floats in flux * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review * updated floats type doc * Update content/flux/v0.x/data-types/basic/float.md * updated verbiage * added related links * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with integers (#2980) * WIP work with ints * work with integers * work with integers * updated float to int behavior, added related links, closes #2973 * added toc to ints doc * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/flux/v0.x/data-types/basic/integer.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with uintegers (#2981) * WIP work with uints * work with uints * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed minor type * Work with records (#2982) * work with records in flux * updated record type doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with arrays (#2983) * work with arrays * added array.from example, added related links * Work with dictionaries (#2984) * WIP work with dicts * work with dictionaries * added related links to dict package * added introduced version to dict package * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * added sample dict output Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Work with functions (#2985) * work with functions * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * revamped type landing pages * marked union types as draft * miscellaneous updates * Work with regular expression (#3024) * work with regular expression types, closes #2573, closes influxdata/flux#3741 * add context for quoteMeta function * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix latest links in page descriptions * updated influxdb links * Flux syntax basics (#3033) * flux syntax basics * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * updated function description * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * Update content/flux/v0.x/get-started/syntax-basics.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * added table param to transformations, closes #2392 (#3039) * updated flux function links * update algolia configuration to fix search, closes #1902 (#3042) * ported notes in the from function doc * Flux package options (#3083) * add now option to universe package * added missing package options, closes #2464 * addressed PR feedback * Flux transformation input/output examples (#3103) * added flux/sample shortcode * standardize flux package titles and list titles * added start and stop columns as an option with flux/sample shortcode * minor updates to stdlib * WIP add input and output examples to flux transformations * WIP removed sample data demo from universe index page * WIP function input and output examples * WIP flux input output examples * WIP flux input output examples * flux transformation input and output examples * Add Flux 'sampledata' package (#3088) * add flux sampledata package * updated sampledata example titles * Write data with Flux (#3084) * WIP write to sql data sources * write to sql data sources * added write data to influxdb with flux doc * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * made sql headings specific to each db * updated write to influxdb * added tag to influxdb to example * restructred influxdb write examples as code tabs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * fixed list on influxdb write with flux page * Flux move changelog (#3117) * updated flux redirects in edge.js * move flux changelog into Flux restructure * add flux redirects to edge.js * removed extra parentheses from monitor.notify examples, closes #2505 * updated flux release notes with flux 0.129.0 * moved from and to into the influxdata/influxdb package * updated notes on to and from docs * added flux card to homepage * added flux-0.130.0 to flux release notes * flux link cleanup * updated experimental message, closes #3097 (#3128) * Remove Flux stdlib and language from InfluxDB (#3133) * remove flux stdlib and lang from influxdb, update flux get-started, closes #2132 * flux link cleanup * cleaned up prometheus verbiage, updated flux data type links * function cleanup * fixed sidenav toggle button * updated group key links, added aliases for flux landing page * fixed broken links, commented out prometheus content, updated flux types names * added flux links to the left nav * fixed flux links in kapacitor docs * temporarily disable search (#3134) * merged master and updated telegraf plugins Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-09-16 22:19:21 +00:00
{{% flux/sample set="int" includeNull=true includeRange=true %}}
{{% flux/sample "int" true true %}}
```
### Duplicate OSS content in Cloud
Docs for InfluxDB OSS and InfluxDB Cloud share a majority of content.
To prevent duplication of content between versions, use the following shortcodes:
- `{{< duplicate-oss >}}`
- `{{% oss-only %}}`
- `{{% cloud-only %}}`
#### duplicate-oss
The `{{< duplicate-oss >}}` shortcode copies the page content of the file located
at the identical file path in the most recent InfluxDB OSS version.
The Cloud version of this markdown file should contain the frontmatter required
for all pages, but the body content should just be the `{{< duplicate-oss >}}` shortcode.
#### oss-only
Wrap content that should only appear in the OSS version of the doc with the `{{% oss-only %}}` shortcode.
Use the shortcode on both inline and content blocks:
```md
{{% oss-only %}}This is inline content that only renders in the InfluxDB OSS docs{{% /oss-only %}}
{{% oss-only %}}
This is a multi-paragraph content block that spans multiple paragraphs and will
only render in the InfluxDB OSS documentation.
**Note:** Notice the blank newline after the opening short-code tag.
This is necessary to get the first sentence/paragraph to render correctly.
{{% /oss-only %}}
- {{% oss-only %}}This is a list item that will only render in InfluxDB OSS docs.{{% /oss-only %}}
- {{% oss-only %}}
This is a multi-paragraph list item that will only render in the InfluxDB OSS docs.
**Note:** Notice shortcode is _inside_ of the line item.
There also must be blank newline after the opening short-code tag.
This is necessary to get the first sentence/paragraph to render correctly.
{{% /oss-only %}}
1. Step 1
2. {{% oss-only %}}This is a list item that will only render in InfluxDB OSS docs.{{% /oss-only %}}
3. {{% oss-only %}}
This is a list item that contains multiple paragraphs or nested list items and will only render in the InfluxDB OSS docs.
**Note:** Notice shortcode is _inside_ of the line item.
There also must be blank newline after the opening short-code tag.
This is necessary to get the first sentence/paragraph to render correctly.
{{% /oss-only %}}
```
#### cloud-only
Wrap content that should only appear in the Cloud version of the doc with the `{{% cloud-only %}}` shortcode.
Use the shortcode on both inline and content blocks:
```md
{{% cloud-only %}}This is inline content that only renders in the InfluxDB Cloud docs{{% /cloud-only %}}
{{% cloud-only %}}
This is a multi-paragraph content block that spans multiple paragraphs and will
only render in the InfluxDB Cloud documentation.
**Note:** Notice the blank newline after the opening short-code tag.
This is necessary to get the first sentence/paragraph to render correctly.
{{% /cloud-only %}}
- {{% cloud-only %}}This is a list item that will only render in InfluxDB Cloud docs.{{% /cloud-only %}}
- {{% cloud-only %}}
This is a list item that contains multiple paragraphs or nested list items and will only render in the InfluxDB Cloud docs.
**Note:** Notice shortcode is _inside_ of the line item.
There also must be blank newline after the opening short-code tag.
This is necessary to get the first sentence/paragraph to render correctly.
{{% /cloud-only %}}
1. Step 1
2. {{% cloud-only %}}This is a list item that will only render in InfluxDB Cloud docs.{{% /cloud-only %}}
3. {{% cloud-only %}}
This is a multi-paragraph list item that will only render in the InfluxDB Cloud docs.
**Note:** Notice shortcode is _inside_ of the line item.
There also must be blank newline after the opening short-code tag.
This is necessary to get the first sentence/paragraph to render correctly.
{{% /cloud-only %}}
```
InfluxDB 2.1 (#3367) * base changes for influxdb 2.1 * remove duplicates in draft * draft categories * add categories * Document wildcards in SHOW MEASUREMENTS ON queries (#3273) * InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries This applies to InfluxDB 2.1. See #3201 * latest notes * Update `influxd --store` values (#3272) * Use Unix ~ alias * Add sqlite path to file layout doc * add sqlite to filesystem diagrams * draft 2.1 release notes +questions * revert to check RNs changes in separately * latest release notes * Restructure installation docs for separate CLI package (#3280) * influxdb and cli install revamp * reorganized CLI install instructions * remove unnecessary short-code parameters * updated docs to address PR feedback * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * update linux install instructions Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * release note updates * updates * add support for annotations in OSS 2.1 (#3286) * Document support for bearer auth sytax (#3297) * 2.1 oss notebooks (#3281) * Move notebooks to OSS (addresses #2951 ) * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/manage-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add PR feedback Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Fix link in bearer auth sytax doc (#3298) * Updated CLI docs content and added version metadata (#3285) * added metadata styles and data to cli docs * added missing ui-disabled influxd config flag * added updated versions to influx cli metadata * added metadata to all cloud influx cli docs * updated influx ping in cloud to have oss only tag * Update influxd documentation for 2.1 (#3302) * update and dynamically generate links to influxd flags (#3288) * remove 2.1 config options from 2.0 * New influxd commands (#3291) * added basic influxd recovery commands * added influxd recover commands, WIP for other influxd inspect commands * updated all influxd inspect commands * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated influxd docs to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add static legend to band and graph visualizations (#3315) * update band vis to include static legend * upd graph and graph-single-stat w static legend * update 2.1 links * update to latest Flux links * fix Flux links * Influxdb 2.1 release notes (#3279) * draft release notes * latest RN changes * test * revert * for review purposes * incorporate changes from new changelog * add note about new metadata included in CLI docs * edit * more edits * add overview features list * tweak verbiage about Telegraf support * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * add link * add edits from Scott, Dan, and Will * edits from dan * highlight and distinguish CLI separation changes * add links to new API endpoints * formatting upd * edits for secrets * mv Flux location support after rsv merge conflicts * edits from Tim * update influxql link * rmv SLQ metastore link * minor updates to 2.1 release notes * prep * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> * add new Telegraf plugins to release notes * edit from Will * 2.1 upgrade and downgrade instructions (#3332) * influxd downgrade command, add upgrade instructions, closes #3331 * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daniel Moran <danxmoran@gmail.com> * udpated downgrade docs to address PR feedback * remove references to localhost:1313 Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * updated flux version in release notes, added other new items, closes #3338 (#3344) * Chore/update oss api (#3341) * Standardize the term "key-value" (#3283) * s|key/value|key-value * Use en dash in prefix to open compound "time series" * CLI 2.2 (#3269) * add -b shorthand to influx delete * add cli 2.2 release notes * add example for all-access token * edits * updates to influx auth create * edits for operator token * remove inaccurate env var * Update influx-cli.md * Update influx-cli.md * make capitalization consistent with other docs * make headers parallel * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott and Dan * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * edits to CLI * add oss-only shortcode and fix formatting * format updates * fix links * add oss-only inline * fix list * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Dan * emphasize recommendation * edit from Dan re limits and page size * edit f Sam * update release date * remove vague description * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * add cloud updates in Sept (#3210) * Fix numbering in AWS install doc (#3293) Closes #3292 * Document new API Invocable Scripts feature (was named-functions) (#3282) * feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233). * feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters. * feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet. * feat: rename example function for simplicity since there's no GET for now. * feat: add find_and_update example (#2547). * feat: add update example. Clarify, expand invoke example. Add links. (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: remove accidental commit of generated redoc-static.html * feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml. * fix: replace /functions with /scripts * feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml * feat: invocable scripts (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * feat: new section for params (#2547). * fix: swagger server url (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * feat: remove jq and function where there's no clear need. Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: add Invocable Scripts tag description. (#3296) * Fix api invocable (#3299) * fix: scripts api path. * fix: bad comma * Fix api invocable (#3306) * fix: scripts api path. * fix: bad comma * feat: add invocable scripts example for sending multiple parameter values. * fix: endpoint text. (#3308) * Fix api invocable (#3310) * fix: measurement -> point * fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest. * updated token naming and other typos, closes influxdata/DAR#244 (#3309) * Flux 0.136 (#3311) * Flux 0.136.0 release notes * Update pagerduty package for flux 0.136.0 (#3303) * Add Flux ServiceNow package (#3304) * added Flux servicenow package * Apply suggestions from code review * Enterprise dar updates (#3313) * removed references to web server in enteprise cluster docs, closes influxdata/DAR#245 * updated enterprise upgrade instructions, closes influxdata/DAR#243 * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: mjs example path (#3305) (#3316) * 3240 fix nodejs alias (#3317) * fix: mjs example path (#3305) * fix: add alias to node.js client library (#3240) * Edit description for amd_rocm_smi Telegraf plugin (#3186) * Edit description for amd_rocm_smi Telegraf plugin Edit name and description for amd_rocm_smi Telegraf plugin. Not sure if this is the only location that it needs to be udpated. * cpl minor updates Co-authored-by: Kelly <kelly@influxdata.com> * remove influxql support from v2 api, closes influxdata/DAR#246 (#3326) * Telegraf 1.20.3 (#3328) * Telegraf 1.20.3 * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * docs: update telegraf configuration.md (#3300) * docs: update telegraf configuration.md * add note about rate limits * fix: correct debian/ubuntu install instructions (#3312) * fix: correct debian/ubuntu install instructions This consolidates the Debian and Ubutnu install instructions into one section. The install instructions can be the same for both as they use the same package manager (i.e. apt). This removes the use of the now deprecated pipe to apt-key. This removes references to starting the service, as the service starts on install and does not require an extra step. Also all supported operating systems are using systemd at this point so no need to call that out seperatly. Removes an extra 'sudo' in deb instructions. * missing word * added flux 0.137.0 release notes, added vertica sql support docs (#3318) * Update _index.md (#3195) broken link for external plugin repo * Addresses #3284 (#3334) * Updates to Flux `to()` (#3260) Closes https://github.com/influxdata/DAR/issues/236. Closes #3258. Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Fix shim and other link (#3336) * Update Kapacitor security docs (#3325) Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Include TLS setup in Enterprise post-install steps (#3271) - Rename TLS guide file. - Use term "TLS" in title and introduction of TLS guide. Closes #3270. Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux 0.138.0 and 0.139.0 (#3335) * added release notes for flux 0.138 and 0.139 and related updates * updated spec with related implementation issue * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated to address PR feedback, added related links to int, uint, and bitwise docs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * hotfix load data link * add aliases and fix load data link in oss * API Ref docs processing (#3337) * chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml. Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future. Add an OpenAPI CLI docs-plugin with content and decorators. * chore: update api-docs/README.md * fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup. * chore: update cloud contract. * chore: update oss API contract. * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com> * edit from Tim: update v2.0 to v2.1 in API section * fix 2.1 links * Fix/api ref 2.1 (#3363) * fix: cloud-specific v1compat auth examples. * fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links. * fix: update API auth descriptions. add API ref v2.1. Update links in openapi content. * fix: updates URLs to v2.1 in API ref docs * add verify-tsm to 2.1 release notes * Clockface updates for 2.1 and Cloud (#3364) * versioned old icomoon font * updated all existing icons with versioned style * Revert "updated all existing icons with versioned style" This reverts commit 79b6cdf539542a5420ab3988b7ada9a0db497a23. * versioned icon shortcode * update icons and new styles for clockface v3 * updated nav-icon shortcode and styles * updated account nav icon styles * misc updates * general style updates * updated oss versions on the homepage * fixed tick card colors on homepage Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>
2021-11-08 17:48:11 +00:00
#### All-Caps
InfluxDB 2.1 (#3367) * base changes for influxdb 2.1 * remove duplicates in draft * draft categories * add categories * Document wildcards in SHOW MEASUREMENTS ON queries (#3273) * InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries This applies to InfluxDB 2.1. See #3201 * latest notes * Update `influxd --store` values (#3272) * Use Unix ~ alias * Add sqlite path to file layout doc * add sqlite to filesystem diagrams * draft 2.1 release notes +questions * revert to check RNs changes in separately * latest release notes * Restructure installation docs for separate CLI package (#3280) * influxdb and cli install revamp * reorganized CLI install instructions * remove unnecessary short-code parameters * updated docs to address PR feedback * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review * update linux install instructions Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * release note updates * updates * add support for annotations in OSS 2.1 (#3286) * Document support for bearer auth sytax (#3297) * 2.1 oss notebooks (#3281) * Move notebooks to OSS (addresses #2951 ) * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/manage-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/clean-data.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/overview.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/influxdb/v2.1/notebooks/create-notebook.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add PR feedback Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Fix link in bearer auth sytax doc (#3298) * Updated CLI docs content and added version metadata (#3285) * added metadata styles and data to cli docs * added missing ui-disabled influxd config flag * added updated versions to influx cli metadata * added metadata to all cloud influx cli docs * updated influx ping in cloud to have oss only tag * Update influxd documentation for 2.1 (#3302) * update and dynamically generate links to influxd flags (#3288) * remove 2.1 config options from 2.0 * New influxd commands (#3291) * added basic influxd recovery commands * added influxd recover commands, WIP for other influxd inspect commands * updated all influxd inspect commands * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated influxd docs to address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Add static legend to band and graph visualizations (#3315) * update band vis to include static legend * upd graph and graph-single-stat w static legend * update 2.1 links * update to latest Flux links * fix Flux links * Influxdb 2.1 release notes (#3279) * draft release notes * latest RN changes * test * revert * for review purposes * incorporate changes from new changelog * add note about new metadata included in CLI docs * edit * more edits * add overview features list * tweak verbiage about Telegraf support * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * add link * add edits from Scott, Dan, and Will * edits from dan * highlight and distinguish CLI separation changes * add links to new API endpoints * formatting upd * edits for secrets * mv Flux location support after rsv merge conflicts * edits from Tim * update influxql link * rmv SLQ metastore link * minor updates to 2.1 release notes * prep * Update content/influxdb/v2.1/reference/release-notes/influxdb.md Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Scott Anderson <scott@influxdata.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> * add new Telegraf plugins to release notes * edit from Will * 2.1 upgrade and downgrade instructions (#3332) * influxd downgrade command, add upgrade instructions, closes #3331 * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daniel Moran <danxmoran@gmail.com> * udpated downgrade docs to address PR feedback * remove references to localhost:1313 Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * updated flux version in release notes, added other new items, closes #3338 (#3344) * Chore/update oss api (#3341) * Standardize the term "key-value" (#3283) * s|key/value|key-value * Use en dash in prefix to open compound "time series" * CLI 2.2 (#3269) * add -b shorthand to influx delete * add cli 2.2 release notes * add example for all-access token * edits * updates to influx auth create * edits for operator token * remove inaccurate env var * Update influx-cli.md * Update influx-cli.md * make capitalization consistent with other docs * make headers parallel * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott and Dan * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Daniel Moran <danxmoran@gmail.com> * edits to CLI * add oss-only shortcode and fix formatting * format updates * fix links * add oss-only inline * fix list * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/security/tokens/create-token.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Dan * emphasize recommendation * edit from Dan re limits and page size * edit f Sam * update release date * remove vague description * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/v2.0/reference/cli/influx/auth/create.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud/reference/release-notes/influx-cli.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * edits from Scott Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> * add cloud updates in Sept (#3210) * Fix numbering in AWS install doc (#3293) Closes #3292 * Document new API Invocable Scripts feature (was named-functions) (#3282) * feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233). * feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters. * feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet. * feat: rename example function for simplicity since there's no GET for now. * feat: add find_and_update example (#2547). * feat: add update example. Clarify, expand invoke example. Add links. (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * fix: remove accidental commit of generated redoc-static.html * feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml. * fix: replace /functions with /scripts * feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml * feat: invocable scripts (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * feat: new section for params (#2547). * fix: swagger server url (#2547) * Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * feat: remove jq and function where there's no clear need. Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: add Invocable Scripts tag description. (#3296) * Fix api invocable (#3299) * fix: scripts api path. * fix: bad comma * Fix api invocable (#3306) * fix: scripts api path. * fix: bad comma * feat: add invocable scripts example for sending multiple parameter values. * fix: endpoint text. (#3308) * Fix api invocable (#3310) * fix: measurement -> point * fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest. * updated token naming and other typos, closes influxdata/DAR#244 (#3309) * Flux 0.136 (#3311) * Flux 0.136.0 release notes * Update pagerduty package for flux 0.136.0 (#3303) * Add Flux ServiceNow package (#3304) * added Flux servicenow package * Apply suggestions from code review * Enterprise dar updates (#3313) * removed references to web server in enteprise cluster docs, closes influxdata/DAR#245 * updated enterprise upgrade instructions, closes influxdata/DAR#243 * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> * fix: mjs example path (#3305) (#3316) * 3240 fix nodejs alias (#3317) * fix: mjs example path (#3305) * fix: add alias to node.js client library (#3240) * Edit description for amd_rocm_smi Telegraf plugin (#3186) * Edit description for amd_rocm_smi Telegraf plugin Edit name and description for amd_rocm_smi Telegraf plugin. Not sure if this is the only location that it needs to be udpated. * cpl minor updates Co-authored-by: Kelly <kelly@influxdata.com> * remove influxql support from v2 api, closes influxdata/DAR#246 (#3326) * Telegraf 1.20.3 (#3328) * Telegraf 1.20.3 * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Address PR feedback Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * docs: update telegraf configuration.md (#3300) * docs: update telegraf configuration.md * add note about rate limits * fix: correct debian/ubuntu install instructions (#3312) * fix: correct debian/ubuntu install instructions This consolidates the Debian and Ubutnu install instructions into one section. The install instructions can be the same for both as they use the same package manager (i.e. apt). This removes the use of the now deprecated pipe to apt-key. This removes references to starting the service, as the service starts on install and does not require an extra step. Also all supported operating systems are using systemd at this point so no need to call that out seperatly. Removes an extra 'sudo' in deb instructions. * missing word * added flux 0.137.0 release notes, added vertica sql support docs (#3318) * Update _index.md (#3195) broken link for external plugin repo * Addresses #3284 (#3334) * Updates to Flux `to()` (#3260) Closes https://github.com/influxdata/DAR/issues/236. Closes #3258. Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Fix shim and other link (#3336) * Update Kapacitor security docs (#3325) Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Include TLS setup in Enterprise post-install steps (#3271) - Rename TLS guide file. - Use term "TLS" in title and introduction of TLS guide. Closes #3270. Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Flux 0.138.0 and 0.139.0 (#3335) * added release notes for flux 0.138 and 0.139 and related updates * updated spec with related implementation issue * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * updated to address PR feedback, added related links to int, uint, and bitwise docs Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * hotfix load data link * add aliases and fix load data link in oss * API Ref docs processing (#3337) * chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml. Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future. Add an OpenAPI CLI docs-plugin with content and decorators. * chore: update api-docs/README.md * fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup. * chore: update cloud contract. * chore: update oss API contract. * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com> * edit from Tim: update v2.0 to v2.1 in API section * fix 2.1 links * Fix/api ref 2.1 (#3363) * fix: cloud-specific v1compat auth examples. * fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links. * fix: update API auth descriptions. add API ref v2.1. Update links in openapi content. * fix: updates URLs to v2.1 in API ref docs * add verify-tsm to 2.1 release notes * Clockface updates for 2.1 and Cloud (#3364) * versioned old icomoon font * updated all existing icons with versioned style * Revert "updated all existing icons with versioned style" This reverts commit 79b6cdf539542a5420ab3988b7ada9a0db497a23. * versioned icon shortcode * update icons and new styles for clockface v3 * updated nav-icon shortcode and styles * updated account nav icon styles * misc updates * general style updates * updated oss versions on the homepage * fixed tick card colors on homepage Co-authored-by: Kelly <kelly@influxdata.com> Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com> Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com> Co-authored-by: Greg <2653109+glinton@users.noreply.github.com> Co-authored-by: Daniel Moran <danxmoran@gmail.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Co-authored-by: Joshua Powers <powersj@influxdata.com> Co-authored-by: bgilmore-iot <85192039+bgilmore-iot@users.noreply.github.com>
2021-11-08 17:48:11 +00:00
Clockface v3 introduces many buttons with text formatted as all-caps.
Use the `{{< caps >}}` shortcode to format text to match those buttons.
```md
Click {{< caps >}}Add Data{{< /caps >}}
```
#### Code callouts
Use the `{{< code-callout >}}` shortcode to highlight and emphasize a specific
piece of code (for example, a variable, placeholder, or value) in a code block.
Provide the string to highlight in the code block.
Include a syntax for the codeblock to properly style the called out code.
````md
{{< code-callout "03a2bbf46249a000" >}}
```sh
http://localhost:8086/orgs/03a2bbf46249a000/...
```
{{< /code-callout >}}
````
#### InfluxDB University banners
Use the `{{< influxdbu >}}` shortcode to add an InfluxDB University banner that
points to the InfluxDB University site or a specific course.
Use the default banner template, a predefined course template, or fully customize
the content of the banner.
```html
<!-- Default banner -->
{{< influxdbu >}}
<!-- Predefined course banner -->
{{< influxdbu "influxdb-101" >}}
<!-- Custom banner -->
{{< influxdbu title="Course title" summary="Short course summary." action="Take
the course" link="https://university.influxdata.com/" >}}
```
##### Course templates
Use one of the following course templates:
- influxdb-101
- telegraf-102
- flux-103
##### Custom banner content
Use the following shortcode parameters to customize the content of the InfluxDB
University banner:
- **title**: Course or banner title
- **summary**: Short description shown under the title
- **action**: Text of the button
- **link**: URL the button links to
### Reference content
The InfluxDB documentation is "task-based," meaning content primarily focuses on
what a user is **doing**, not what they are **using**.
However, there is a need to document tools and other things that don't necessarily
fit in the task-based style.
This is referred to as "reference content."
Reference content is styled just as the rest of the InfluxDB documentation.
The only difference is the `menu` reference in the page's frontmatter.
When defining the menu for reference content, use the following pattern:
```yaml
# Pattern
menu:
2020-08-06 17:48:47 +00:00
<project>_<major-version-number>_<minor-version-number>_ref:
# ...
# Example
menu:
influxdb_2_0_ref:
# ...
```
## InfluxDB URLs
2020-04-22 17:23:49 +00:00
When a user selects an InfluxDB product and region, example URLs in code blocks
throughout the documentation are updated to match their product and region.
InfluxDB URLs are configured in `/data/influxdb_urls.yml`.
2020-09-04 18:26:51 +00:00
By default, the InfluxDB URL replaced inside of code blocks is `http://localhost:8086`.
2020-04-22 17:23:49 +00:00
Use this URL in all code examples that should be updated with a selected provider and region.
For example:
````
2020-04-22 17:23:49 +00:00
```sh
# This URL will get updated
2020-09-04 18:26:51 +00:00
http://localhost:8086
2020-04-22 17:23:49 +00:00
# This URL will NOT get updated
http://example.com
```
````
2020-04-22 17:23:49 +00:00
2020-09-04 18:26:51 +00:00
If the user selects the **US West (Oregon)** region, all occurrences of `http://localhost:8086`
2020-04-22 17:23:49 +00:00
in code blocks will get updated to `https://us-west-2-1.aws.cloud2.influxdata.com`.
### Exempt URLs from getting updated
To exempt a code block from being updated, include the `{{< keep-url >}}` shortcode
just before the code block.
````
{{< keep-url >}}
```
// This URL won't get updated
2020-09-04 18:26:51 +00:00
http://localhost:8086
```
````
2020-07-12 04:25:25 +00:00
### Code examples only supported in InfluxDB Cloud
2020-07-12 04:25:25 +00:00
Some functionality is only supported in InfluxDB Cloud and code examples should
only use InfluxDB Cloud URLs. In these cases, use `https://cloud2.influxdata.com`
as the placeholder in the code block. It will get updated on page load and when
users select a Cloud region in the URL select modal.
````
2020-07-12 04:25:25 +00:00
```sh
# This URL will get updated
https://cloud2.influxdata.com
```
````
2020-07-12 04:25:25 +00:00
InfluxDB Clustered documentation (#5126) * WIP base changes for clustered docs * WIP clustered docs * Add new influxdb/host shortcode and implement it in 3.0 docs (#5077) * add new influxdb/host shortcode and implement it in 3.0 docs * remove oss- cloud-only shortcodes from serverless * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * updated urls js to PR suggestion * Updated JavaScript, templates, and styles for Clustered URLs (#5079) * updated js, templates, and styles for clustered urls * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * restructure product dropdown template to be more extensible * fixed more page template bugs * fixed references to cloud in clustered * updated docsearch templates * added early access flagging and cta-link shortcode * minor content updates in clustered * updated staging config * fixed typo in clustered description * ported influxctl 2.0.1 to clustered * ported get started changes to clustered * ported 3.0 admin docs to clustered * port null tag content to clustered * ported influxctl note to clustered * ported query reorg changes to clustered * updated early access to limited availability, updated clustered landing content * ported new content to clustered * ported new content to clustered * updated cta on clustered landing page * Updated notifications and added InfluxDB Clustered announcement notification (#5125) * updated notifications, added clustered announcement notification * updated cta in clustered notification * updated influxctl profile configs * update clustered search attributes * updated learn more link in clustered notification * Apply suggestions from code review * fixed typos * fixed typos --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 12:21:47 +00:00
### Automatically populate InfluxDB host placeholder
InfluxDB Clustered documentation (#5126) * WIP base changes for clustered docs * WIP clustered docs * Add new influxdb/host shortcode and implement it in 3.0 docs (#5077) * add new influxdb/host shortcode and implement it in 3.0 docs * remove oss- cloud-only shortcodes from serverless * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * updated urls js to PR suggestion * Updated JavaScript, templates, and styles for Clustered URLs (#5079) * updated js, templates, and styles for clustered urls * Apply suggestions from code review Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * restructure product dropdown template to be more extensible * fixed more page template bugs * fixed references to cloud in clustered * updated docsearch templates * added early access flagging and cta-link shortcode * minor content updates in clustered * updated staging config * fixed typo in clustered description * ported influxctl 2.0.1 to clustered * ported get started changes to clustered * ported 3.0 admin docs to clustered * port null tag content to clustered * ported influxctl note to clustered * ported query reorg changes to clustered * updated early access to limited availability, updated clustered landing content * ported new content to clustered * ported new content to clustered * updated cta on clustered landing page * Updated notifications and added InfluxDB Clustered announcement notification (#5125) * updated notifications, added clustered announcement notification * updated cta in clustered notification * updated influxctl profile configs * update clustered search attributes * updated learn more link in clustered notification * Apply suggestions from code review * fixed typos * fixed typos --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 12:21:47 +00:00
The InfluxDB host placeholder that gets replaced by custom domains differs
between each InfluxDB product/version.
Use the `influxdb/host` shortcode to automatically render the correct
host placeholder value for the current product. You can also pass a single
argument to specify a specific InfluxDB product to use.
Supported argument values:
- oss
- cloud
- cloud-tsm
- cloud-serverless
- serverless
- cloud-dedicated
- dedicated
- clustered
```
{{< host/influxdb >}}
{{< host/influxdb "serverless" >}}
```
## New Versions of InfluxDB
Version bumps occur regularly in the documentation.
Each minor version has its own directory with unique content.
Patch versions within a minor version are updated in place.
To add a new minor version, go through the steps below.
_This example assumes v2.0 is the most recent version and v2.1 is the new version._
1. Ensure your `master` branch is up to date:
```sh
git checkout master
git pull
```
2. Create a new branch for the new minor version:
```sh
git checkout -b influxdb-2.1
```
3. Duplicate the most recent version's content directory:
```sh
# From the root of the project
cp content/influxdb/v2.0 content/influxdb/v2.1
```
4. Find and replace all instances of the old version number with the new version
**(only within the new version directory)**.
Be sure to find and replace both the following forms of the version number:
```
v2.0 -> v2.1
v2_0 -> v2_1
```
5. Add the new product and version tag taxonomy to the `config.toml` in the root of the project.
```toml
[taxonomies]
"influxdb/v2.0/tag" = "influxdb/v2.0/tags"
"influxdb/v2.1/tag" = "influxdb/v2.1/tags"
```
6. Update the `latest_version` in `data/products.yml`:
```yaml
latest_version: v2.1
```
2019-10-07 17:22:54 +00:00
7. Copy the InfluxDB `swagger.yml` specific to the new version into the
`/api-docs/v<version-number>/` directory.
8. Commit the changes and push the new branch to GitHub.
These changes lay the foundation for the new version.
All other changes specific to the new version should be merged into this branch.
Once the necessary changes are in place and the new version is released,
merge the new branch into `master`.
2020-12-23 20:54:08 +00:00
## InfluxDB API documentation
2020-12-23 20:54:08 +00:00
InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full
InfluxDB API documentation when documentation is deployed.
Redoc generates HTML documentation using the InfluxDB `swagger.yml`.
For more information about generating InfluxDB API documentation, see the
[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-docs#readme).