influxdata / influxdata/docs-v2

More explicit guidance on custom partitioning (refinement round)

Open
#5,584 2 comments 0 reactions 1 assignee Assigned to @jstirnaman View on GitHub
InfluxDB v3
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

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://github.com/user-attachments/assets/b8208290-f3e9-4151-a90e-3f15c76ad00f)
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](https://github.com/user-attachments/assets/ca0207a4-1453-40fe-82ed-5c368e9b64f3)

> Potentially a new section `Partitioning by distinct date values`:
![image](https://github.com/user-attachments/assets/3dc7860c-e670-40a4-98cf-6d9851c5cb0e)

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_.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.