docs-v2 icon indicating copy to clipboard operation
docs-v2 copied to clipboard

More explicit guidance on custom partitioning (refinement round)

Open reidkaufmann opened this issue 1 year ago • 2 comments

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:

  • %Y-%m-%d for daily
  • %Y-%m for monthly
  • %Y for yearly

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 avatar Aug 30 '24 14:08 reidkaufmann

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

reidkaufmann avatar Aug 30 '24 15:08 reidkaufmann

Related: https://github.com/influxdata/DAR/issues/463

jstirnaman avatar Jan 06 '25 22:01 jstirnaman