influxdata / docs-v2

InfluxData Documentation that covers InfluxDB Cloud, InfluxDB OSS 2.x, InfluxDB OSS 1.x, InfluxDB Enterprise, Telegraf, Chronograf, Kapacitor, and Flux.
https://docs.influxdata.com
MIT License
73 stars 276 forks source link

More explicit guidance on custom partitioning (refinement round) #5584

Open reidkaufmann opened 2 months ago

reidkaufmann commented 2 months ago

We still have some ongoing confusion with a customer on the timeformat. We recently made good progress removing misleading examples, but we can be more clear and prominent stating there are ONLY 3 supported format strings:

Positioned right in here: image https://docs.influxdata.com/influxdb/clustered/admin/custom-partitions/define-custom-partitions/

Also suggested by Support:

I do think the documentation should have more of a call out on what time formats are supported at top. (Example time parts are only listed at bottom in the examples section). Also a flag called template-timeformat is confusing when only date parts are allowed: image

Potentially a new section Partitioning by distinct date values: image

Keep in mind, the customer may not have read the most recent iteration of the documentation, which is quite good. My only concern is that we're clear that no other time formats should be used.

reidkaufmann commented 2 months ago

FYI: I've also requested that influxctl help prevent unsupported format strings: