diff --git a/.ci/vale/styles/InfluxDataDocs/DateFormat.yml b/.ci/vale/styles/InfluxDataDocs/DateFormat.yml new file mode 100644 index 000000000..5dfb7810f --- /dev/null +++ b/.ci/vale/styles/InfluxDataDocs/DateFormat.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +scope: + - ~table.cell +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.ci/vale/styles/write-good/Weasel.yml b/.ci/vale/styles/write-good/Weasel.yml index e29391444..d1d90a7bc 100644 --- a/.ci/vale/styles/write-good/Weasel.yml +++ b/.ci/vale/styles/write-good/Weasel.yml @@ -3,205 +3,27 @@ message: "'%s' is a weasel word!" ignorecase: true level: warning tokens: - - absolutely - - accidentally - - additionally - - allegedly - - alternatively - - angrily - - anxiously - - approximately - - awkwardly - - badly - - barely - - beautifully - - blindly - - boldly - - bravely - - brightly - - briskly - - bristly - - bubbly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - clearly - - closely - - coldly - completely - - consequently - - correctly - - courageously - - crinkly - - cruelly - - crumbly - - cuddly - - currently - - daily - - daringly - - deadly - - definitely - - deliberately - - doubtfully - - dumbly - - eagerly - - early - - easily - - elegantly - - enormously - - enthusiastically - - equally - - especially - - eventually - - exactly - exceedingly - - exclusively + - excellent - extremely - fairly - - faithfully - - fatally - - fiercely - - finally - - fondly - - few - - foolishly - - fortunately - - frankly - - frantically - - generously - - gently - - giggly - - gladly - - gracefully - - greedily - - happily - - hardly - - hastily - - healthily - - heartily - - helpfully - - honestly - - hourly - - hungrily - - hurriedly - - immediately - - impatiently - - inadequately - - ingeniously - - innocently - - inquisitively + - huge - interestingly - - irritably - - jiggly - - joyously - - justly - - kindly + - is a number - largely - - lately - - lazily - - likely - - literally - - lonely - - loosely - - loudly - - loudly - - luckily - - madly - - many - - mentally - - mildly - - monthly - - mortally - mostly - - mysteriously - - neatly - - nervously - - nightly - - noisily - - normally - - obediently - - occasionally - - only - - openly - - painfully - - particularly - - patiently - - perfectly - - politely - - poorly - - powerfully - - presumably - - previously - - promptly - - punctually - - quarterly - - quickly - - quietly - - rapidly - - rarely - - really - - recently - - recklessly - - regularly - - remarkably + - obviously + - quite - relatively - - reluctantly - - repeatedly - - rightfully - - roughly - - rudely - - sadly - - safely - - selfishly - - sensibly - - seriously - - sharply - - shortly - - shyly + - remarkably + - several - significantly - - silently - - simply - - sleepily - - slowly - - smartly - - smelly - - smoothly - - softly - - solemnly - - sparkly - - speedily - - stealthily - - sternly - - stupidly - substantially - - successfully - - suddenly - surprisingly - - suspiciously - - swiftly - - tenderly - - tensely - - thoughtfully - - tightly - - timely - - truthfully - - unexpectedly - - unfortunately + - tiny - usually + - various + - vast - very - - victoriously - - violently - - vivaciously - - warmly - - waverly - - weakly - - wearily - - weekly - - wildly - - wisely - - worldly - - wrinkly - - yearly diff --git a/.vale.ini b/.vale.ini index 88c1fcd2f..8d4262290 100644 --- a/.vale.ini +++ b/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/cloud-dedicated/.vale.ini b/content/influxdb/cloud-dedicated/.vale.ini index 6d35f96b0..8973c692c 100644 --- a/content/influxdb/cloud-dedicated/.vale.ini +++ b/content/influxdb/cloud-dedicated/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Cloud-Dedicated, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md b/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md index 7974c595c..46129a41b 100644 --- a/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md +++ b/content/influxdb/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md @@ -33,7 +33,7 @@ table. #### Partition templates can only be applied on create You can only apply a partition template when creating a database or table. -There is no way to update a partition template on an existing resource. +You can't update a partition template on an existing resource. {{% /note %}} Use the following command flags to identify @@ -71,6 +71,9 @@ The following example creates a new `example-db` database and applies a partitio template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by week using the time format `%Y wk:%W`: + + + ```sh influxctl database create \ --template-tag room \ @@ -82,21 +85,60 @@ influxctl database create \ ## Create a table with a custom partition template -The following example creates a new `example-table` table in the `example-db` +The following example creates a new `example-table` table in the specified database and applies a partition template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by month using the time format `%Y-%m`: + + + +{{% code-placeholders "DATABASE_NAME" %}} + ```sh influxctl table create \ --template-tag room \ --template-tag sensor-type \ --template-tag-bucket customerID,500 \ --template-timeformat '%Y-%m' \ - example-db \ + DATABASE_NAME \ example-table ``` +{{% /code-placeholders %}} + +Replace the following in your command: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/cloud-dedicated/admin/databases/) + + + ## Example partition templates Given the following [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) @@ -108,7 +150,7 @@ prod,line=A,station=weld1 temp=81.9,qty=36i 1704067200000000000 ##### Partitioning by distinct tag values -| Description | Tag part(s) | Time part | Resulting partition key | +| Description | Tag parts | Time part | Resulting partition key | | :---------------------- | :---------------- | :--------- | :----------------------- | | By day (default) | | `%Y-%m-%d` | 2024-01-01 | | By day (non-default) | | `%d %b %Y` | 01 Jan 2024 | diff --git a/content/influxdb/cloud-serverless/.vale.ini b/content/influxdb/cloud-serverless/.vale.ini index 191227f55..43840007e 100644 --- a/content/influxdb/cloud-serverless/.vale.ini +++ b/content/influxdb/cloud-serverless/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Cloud-Serverless, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/clustered/.vale.ini b/content/influxdb/clustered/.vale.ini index 2095bfd0c..193ae44b3 100644 --- a/content/influxdb/clustered/.vale.ini +++ b/content/influxdb/clustered/.vale.ini @@ -9,6 +9,7 @@ Packages = Google, write-good, Hugo [*.md] BasedOnStyles = Vale, InfluxDataDocs, Clustered, Google, write-good +Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO diff --git a/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md b/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md index 9b7b7ecf1..ffd7d61c0 100644 --- a/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md +++ b/content/influxdb/clustered/admin/custom-partitions/define-custom-partitions.md @@ -33,7 +33,7 @@ table. #### Partition templates can only be applied on create You can only apply a partition template when creating a database or table. -There is no way to update a partition template on an existing resource. +You can't update a partition template on an existing resource. {{% /note %}} Use the following command flags to identify @@ -71,6 +71,9 @@ The following example creates a new `example-db` database and applies a partitio template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by week using the time format `%Y wk:%W`: + + + ```sh influxctl database create \ --template-tag room \ @@ -82,21 +85,60 @@ influxctl database create \ ## Create a table with a custom partition template -The following example creates a new `example-table` table in the `example-db` +The following example creates a new `example-table` table in the specified database and applies a partition template that partitions by distinct values of two tags (`room` and `sensor-type`), bucketed values of the `customerID` tag, and by month using the time format `%Y-%m`: + + + +{{% code-placeholders "DATABASE_NAME" %}} + ```sh influxctl table create \ --template-tag room \ --template-tag sensor-type \ --template-tag-bucket customerID,500 \ --template-timeformat '%Y-%m' \ - example-db \ + DATABASE_NAME \ example-table ``` +{{% /code-placeholders %}} + +Replace the following in your command: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb/clustered/admin/databases/) + + + ## Example partition templates Given the following [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) @@ -108,7 +150,7 @@ prod,line=A,station=weld1 temp=81.9,qty=36i 1704067200000000000 ##### Partitioning by distinct tag values -| Description | Tag part(s) | Time part | Resulting partition key | +| Description | Tag parts | Time part | Resulting partition key | | :---------------------- | :---------------- | :--------- | :----------------------- | | By day (default) | | `%Y-%m-%d` | 2024-01-01 | | By day (non-default) | | `%d %b %Y` | 01 Jan 2024 | diff --git a/test/src/prepare-content.sh b/test/src/prepare-content.sh index 6490ae585..a41d4b6d4 100644 --- a/test/src/prepare-content.sh +++ b/test/src/prepare-content.sh @@ -56,7 +56,8 @@ function substitute_placeholders { /os.getenv("MANAGEMENT_TOKEN")/! s/MANAGEMENT_TOKEN/$MANAGEMENT_TOKEN/g; /os.getenv("ORG_ID")/! s/ORG_ID/$INFLUX_ORG/g; /os.getenv("RETENTION_POLICY")/! s/RETENTION_POLICY_NAME\|RETENTION_POLICY/$INFLUX_RETENTION_POLICY/g; - s/CONFIG_NAME/CONFIG_$(shuf -i 0-100 -n1)/g;' \ + s/CONFIG_NAME/CONFIG_$(shuf -i 0-100 -n1)/g; + s/TEST_RUN/TEST_RUN_$(date +%s)/g' \ $file # v2-specific replacements.