Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore(ci): Add vale script, configuration, and fixes (#5081) 

- Adds VSCode directory-specific configurations for Vale
- Adds a simple shell script to run Vale for dedicated, serverless, and telegraf.
- Adds vocab and spelling configuration.
- Fixes some spelling and style errors in serverless and dedicated.
pull/5080/head^2
Jason Stirnaman 2023-08-11 13:50:31 -05:00 committed by GitHub
parent d3be011e3d
commit 9404fda2f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
30 changed files with 100 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.ci/vale/styles/InfluxDataDocs/Branding.yml
View File

@ -6,4 +6,6 @@ ignorecase: true
swap:
# NOTE: The left-hand (bad) side can match the right-hand (good) side; Vale
# will ignore any alerts that match the intended form.
"java[ -]?scripts?": JavaScript
"FlightSQL": Flight SQL
"java[ -]?scripts?": JavaScript
"SQL Alchemy": SQLAlchemy

2
.ci/vale/styles/InfluxDataDocs/Spelling.yml
View File

@ -6,4 +6,6 @@ scope:
- ~table.cell
ignore:
# Located at StylesPath/ignore1.txt
- InfluxDataDocs/Terms/configuration-terms.txt
- InfluxDataDocs/Terms/query-functions.txt

11
.ci/vale/styles/InfluxDataDocs/Terms/configuration-terms.txt Normal file
View File

@ -0,0 +1,11 @@
batchBucket
batchInterval
commentPrefix
destinationBucket
destinationHost
destinationOrg
destinationToken
quoteChar
retentionRules
sourceBucket
src

2
.ci/vale/styles/Vocab/Cloud-Dedicated/accept.txt
View File

@ -0,0 +1,2 @@
cloud-dedicated
Cloud Dedicated

2
.ci/vale/styles/Vocab/Cloud-Serverless/accept.txt
View File

@ -0,0 +1,2 @@
cloud-serverless
Cloud Serverless

31
.ci/vale/styles/Vocab/InfluxData/accept.txt
View File

@ -10,19 +10,21 @@ bundlers?
CLI
Clockface
[Cc]loud
cloud-dedicated
Cloud Dedicated
cloud-name
cloud-serverless
Cloud Serverless
conda
csv
CSV
Data Explorer
[Dd]ownsampl.*
dashboarding
datasource
dateTime
[Dd]ownsampl.*\b
dotenv
enum
Flight
FlightQuery
Grafana
gzip(ped)?
homogenous
hostname
hostUrl
hostURL
@ -41,10 +43,16 @@ lat
locf
[Ll]ogstash
lon
lookahead
lookbehind
namespace
noaa
NOAA
npm
OAuth
pandas
performant
pushdown
pyarrow
Py.*\b
pyinflux
@ -54,13 +62,22 @@ rp
serializer
[Ss]erverless
Splunk
SQLAlchemy
stdout
subquer(y|ies)
substring
Superset
svg
tagset
[Tt]elegraf
[Tt]ombstoned
tsm|TSM
uint|UINT
uinteger
unescaped
unix
urls
venv
Webpack
xpath
XPath
XPath

10
.ci/vale/vale.sh Normal file
View File

@ -0,0 +1,10 @@
# Lint cloud-dedicated
docspath=.
contentpath=$docspath/content
vale --config=$contentpath/influxdb/cloud-dedicated/.vale.ini --output=line --relative --minAlertLevel=error $contentpath/influxdb/cloud-dedicated
# Lint cloud-serverless
vale --config=$contentpath/influxdb/cloud-serverless/.vale.ini --output=line --relative --minAlertLevel=error $contentpath/influxdb/cloud-serverless
# Lint telegraf
# vale --config=$docspath/.vale.ini --output=line --relative --minAlertLevel=error $contentpath/telegraf

18
.vscode/settings.json vendored
View File

@ -1,18 +1,4 @@
{
"cSpell.words": [
"CLOCKFACE",
"compactible",
"dbrp",
"downsample",
"eastus",
"icomoon",
"Invokable",
"Miyazakisky",
"orgname",
"Rienmann",
"seotitle",
"Signup",
"westeurope",
"xsmall"
],
"vale.valeCLI.config": " \"${workspaceFolder}/.vale.ini\"",
"vale.valeCLI.minAlertLevel": "warning",
}

4
content/influxdb/cloud-dedicated/.vale.ini
View File

@ -9,4 +9,6 @@ Packages = Google, Hugo
[*.md]
BasedOnStyles = InfluxDataDocs, Google
Google.Headings = NO
Google.Ellipses = NO
Google.Headings = NO
Google.WordList = NO

4
content/influxdb/cloud-dedicated/.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,4 @@
{
"vale.valeCLI.config": "${workspaceFolder}/content/influxdb/cloud-dedicated/.vale.ini",
"vale.valeCLI.minAlertLevel": "warning",
}

2
content/influxdb/cloud-dedicated/process-data/visualize/grafana.md
View File

@ -183,7 +183,7 @@ query {{% cloud-name %}}:
- **Database**: Provide a default database name to query.
- **User**: Provide an arbitrary string.
_This credential is ingored when querying {{% cloud-name %}}, but it cannot be empty._
_This credential is ignored when querying {{% cloud-name %}}, but it cannot be empty._
- **Password**: Provide an InfluxDB [database token](/influxdb/cloud-dedicated/admin/tokens/)
with read access to the databases you want to query.

2
content/influxdb/cloud-dedicated/process-data/visualize/superset.md
View File

@ -193,7 +193,7 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
- **Username**: admin
- **Password**: admin
3. Optional: Create a new admin user with a unique password.
3. Optional: Create an admin user with a unique password.
1. In the Superset UI, click **Settings** in the top right
and select **List Users**.

2
content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md
View File

@ -74,7 +74,7 @@ location based on your operating system:
#### Profile configuration file locations
| Operating system | Profile configuration filepath |
| Operating system | Profile configuration path |
| :--------------- | :---------------------------------------------------- |
| Linux | `~/.config/influxctl/config.toml` |
| macOS | `~/Library/Application Support/influxctl/config.toml` |

2
content/influxdb/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md
View File

@ -73,7 +73,7 @@ a client](#initialize-a-client) and interacting with a Flight SQL server.
__init__(self, host=None, token=None, metadata=None, features=None)
```
Initializes and returns a `FlightSQLClient` instance for interating with the server.
Initializes and returns a `FlightSQLClient` instance for interacting with the server.
## Initialize a client

2
content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md
View File

@ -118,7 +118,7 @@ After you've imported the client library, you're ready to [get started writing d
The client library includes an example browser app that writes to your InfluxDB instance.
1. Clone the [influxdb-client-js](https://github.com/influxdata/influxdb-client-js) repo.
1. Clone the [influxdb-client-js](https://github.com/influxdata/influxdb-client-js) repository.
2. Navigate to the `examples` directory:

6
content/influxdb/cloud-dedicated/reference/influxql/_index.md
View File

@ -103,7 +103,7 @@ Identifiers are tokens that refer to
The rules are as follows:
- Double-quoted identifiers can contain any Unicode character except for a new line.
- Double-quoted identifiers can also contain escaped `"` characters (i.e. `\"`).
- Double-quoted identifiers can also contain escaped `"` characters (that is, `\"`)
- Double-quoted identifiers can include InfluxQL [keywords](#keywords).
- Unquoted identifiers must start with an upper or lowercase ASCII character or "_".
- Unquoted identifiers may contain only ASCII letters, decimal digits, and "_".
@ -185,7 +185,7 @@ float_lit = int_lit "." int_lit .
#### Strings
String literals must be surrounded by single quotes.
Strings may contain `'` characters as long as they are escaped (i.e., `\'`).
Strings may contain `'` characters as long as they are escaped (that is, , `\'`)
```
string_lit = `'` { unicode_char } `'` .
@ -309,7 +309,7 @@ Since InfluxQL doesn't support joins, the cost of an InfluxQL query is typically
A query plan generated by `EXPLAIN` contains the following elements:
- expression
- auxillary fields
- auxiliary fields
- number of shards
- number of series
- cached values

4
content/influxdb/cloud-dedicated/reference/influxql/math-operators.md
View File

@ -189,9 +189,9 @@ InfluxQL does not know how wide your bitfield is, so cannot implement a suitable
bitwise-not operator.
For example, if your bitfield is 8 bits wide, then the integer 1 represents the bits `0000 0001`.
The bitwise-not of this should return the bits `1111 1110`, i.e. the integer 254.
The bitwise-not of this should return the bits `1111 1110` (that is, the integer 254)
However, if your bitfield is 16 bits wide, then the integer 1 represents the bits `0000 0000 0000 0001`.
The bitwise-not of this should return the bits `1111 1111 1111 1110`, i.e. the integer 65534.
The bitwise-not of this should return the bits `1111 1111 1111 1110` (that is, the integer 65534)
#### Solution

8
content/influxdb/cloud-dedicated/write-data/use-telegraf/configure/_index.md
View File

@ -90,7 +90,7 @@ Replace the following:
The InfluxDB output plugin configuration contains the following options:
##### urls
##### `urls`
An array of URL strings.
To write to {{% cloud-name %}}, include your {{% cloud-name %}} cluster URL using the HTTPS protocol:
@ -99,17 +99,17 @@ To write to {{% cloud-name %}}, include your {{% cloud-name %}} cluster URL usin
["https://cluster-id.influxdb.io"]
```
##### token
##### `token`
Your {{% cloud-name %}} [database token](/influxdb/cloud-dedicated/admin/tokens/) with _write_ permission to the database.
In the examples, **`INFLUX_TOKEN`** is an environment variable assigned to a [database token](/influxdb/cloud-dedicated/admin/tokens/) that has _write_ permission to the database.
##### organization
##### `organization`
For {{% cloud-name %}}, set this to an empty string (`""`).
##### bucket
##### `bucket`
The name of the {{% cloud-name %}} database to write data to.

4
content/influxdb/cloud-serverless/.vale.ini
View File

@ -9,4 +9,6 @@ Packages = Google, Hugo
[*.md]
BasedOnStyles = InfluxDataDocs, Google
Google.Headings = NO
Google.Ellipses = NO
Google.Headings = NO
Google.WordList = NO

4
content/influxdb/cloud-serverless/.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,4 @@
{
"vale.valeCLI.config": "${workspaceFolder}/content/influxdb/cloud-serverless/.vale.ini",
"vale.valeCLI.minAlertLevel": "warning",
}

2
content/influxdb/cloud-serverless/process-data/visualize/grafana.md
View File

@ -189,7 +189,7 @@ To query {{% cloud-name %}} with InfluxQL, first map database and retention poli
- **Database**: Provide a default database (bucket) name to query.
- **User**: Provide an arbitrary string.
_This credential is ingored when querying {{% cloud-name %}}, but it cannot be empty._
_This credential is ignored when querying {{% cloud-name %}}, but it cannot be empty._
- **Password**: Provide an [API token](/influxdb/cloud-serverless/admin/tokens/)
with read access to the buckets you want to query.

2
content/influxdb/cloud-serverless/process-data/visualize/superset.md
View File

@ -189,7 +189,7 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
- **Username**: admin
- **Password**: admin
3. Optional: Create a new admin user with a unique password.
3. Optional: Create an admin user with a unique password.
1. In the Superset UI, click **Settings** in the top right
and select **List Users**.

2
content/influxdb/cloud-serverless/reference/cli/influx/remote/create.md
View File

@ -1,6 +1,6 @@
---
title: influx remote create
description: Create a new remote InfluxDB connection for replicating data.
description: Create a remote InfluxDB connection for replicating data.
menu:
influxdb_cloud_serverless:
name: influx remote create

2
content/influxdb/cloud-serverless/reference/cli/influx/replication/create.md
View File

@ -1,6 +1,6 @@
---
title: influx replication create
description: Create a new InfluxDB replication stream.
description: Create an InfluxDB replication stream.
menu:
influxdb_cloud_serverless:
name: influx replication create

2
content/influxdb/cloud-serverless/reference/client-libraries/flight/python-flightsql-dbapi.md
View File

@ -71,7 +71,7 @@ a client](#initialize-a-client) and interacting with a Flight SQL server.
__init__(self, host=None, token=None, metadata=None, features=None)
```
Initializes and returns a `FlightSQLClient` instance for interating with the server.
Initializes and returns a `FlightSQLClient` instance for interacting with the server.
## Initialize a client

2
content/influxdb/cloud-serverless/reference/client-libraries/v2/javascript/browser.md
View File

@ -118,7 +118,7 @@ After you've imported the client library, you're ready to [get started writing d
The client library includes an example browser app that writes to your InfluxDB instance.
1. Clone the [influxdb-client-js](https://github.com/influxdata/influxdb-client-js) repo.
1. Clone the [influxdb-client-js](https://github.com/influxdata/influxdb-client-js) repository.
2. Navigate to the `examples` directory:

6
content/influxdb/cloud-serverless/reference/influxql/_index.md
View File

@ -103,7 +103,7 @@ Identifiers are tokens that refer to
The rules are as follows:
- Double-quoted identifiers can contain any Unicode character except for a new line.
- Double-quoted identifiers can also contain escaped `"` characters (i.e. `\"`).
- Double-quoted identifiers can also contain escaped `"` characters (that is, `\"`)
- Double-quoted identifiers can include InfluxQL [keywords](#keywords).
- Unquoted identifiers must start with an upper or lowercase ASCII character or "_".
- Unquoted identifiers may contain only ASCII letters, decimal digits, and "_".
@ -185,7 +185,7 @@ float_lit = int_lit "." int_lit .
#### Strings
String literals must be surrounded by single quotes.
Strings may contain `'` characters as long as they are escaped (i.e., `\'`).
Strings may contain `'` characters as long as they are escaped (that is, , `\'`)
```
string_lit = `'` { unicode_char } `'` .
@ -309,7 +309,7 @@ Since InfluxQL doesn't support joins, the cost of an InfluxQL query is typically
A query plan generated by `EXPLAIN` contains the following elements:
- expression
- auxillary fields
- auxiliary fields
- number of shards
- number of series
- cached values

4
content/influxdb/cloud-serverless/reference/influxql/math-operators.md
View File

@ -189,9 +189,9 @@ InfluxQL does not know how wide your bitfield is, so cannot implement a suitable
bitwise-not operator.
For example, if your bitfield is 8 bits wide, then the integer 1 represents the bits `0000 0001`.
The bitwise-not of this should return the bits `1111 1110`, i.e. the integer 254.
The bitwise-not of this should return the bits `1111 1110` (that is, the integer 254)
However, if your bitfield is 16 bits wide, then the integer 1 represents the bits `0000 0000 0000 0001`.
The bitwise-not of this should return the bits `1111 1111 1111 1110`, i.e. the integer 65534.
The bitwise-not of this should return the bits `1111 1111 1111 1110` (that is, the integer 65534)
#### Solution

2
content/influxdb/cloud-serverless/write-data/migrate-data/migrate-tsm-to-iox.md
View File

@ -64,7 +64,7 @@ to complete the migration.
_See [Add secrets](/influxdb/cloud/security/secrets/add/) for more information._
3. [Create a bucket](/influxdb/cloud/organizations/buckets/create-bucket/)
**to store temporary migration metadata**.
4. [Create a new task](/influxdb/cloud/process-data/manage-tasks/create-task/)
4. [Create a task](/influxdb/cloud/process-data/manage-tasks/create-task/)
using the provided [migration task](#migration-task).
Update the necessary [migration configuration options](#configure-the-migration).
5. _(Optional)_ Set up [migration monitoring](#monitor-the-migration-progress).

8
content/influxdb/cloud-serverless/write-data/use-telegraf/configure/_index.md
View File

@ -88,7 +88,7 @@ Replace the following:
The InfluxDB output plugin configuration contains the following options:
##### urls
##### `urls`
An array of URL strings.
To write to {{% cloud-name %}}, include your {{% cloud-name %}} region URL using the HTTPS protocol:
@ -97,17 +97,17 @@ To write to {{% cloud-name %}}, include your {{% cloud-name %}} region URL using
["https://cloud2.influxdata.com"]
```
##### token
##### `token`
Your {{% cloud-name %}} [API token](/influxdb/cloud-serverless/admin/tokens/) with _write_ permission to the database.
In the examples, `INFLUX_TOKEN` is an environment variable assigned to a [API token](/influxdb/cloud-serverless/admin/tokens/) that has _write_ permission to the database.
##### organization
##### `organization`
For {{% cloud-name %}}, set this to an empty string (`""`).
##### bucket
##### `bucket`
The name of the {{% cloud-name %}} bucket to write data to.