influxdata / influxdata/docs-v2
Document Flux time mechanics
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
We need to provide details related to how time, timezones, and location-based time work in Flux. It should include the following:
- [ ] Update time value and timestamp examples to include timestamps with timezones (`2021-01-01T00:00:00+06:00`)
- [ ] Add information about the different methods used to specify timezones (fixed vs location-based)
- [ ] Add information about how windowing behavior when a window crosses a time shift (like daylight savings).
- [ ] Connect content to the `timezone` package.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Flux documentation pages covering time values, timestamps, timezones, and windowing. Update examples with timezone-bearing timestamps, explain fixed versus location-based timezones and window behavior across time shifts, and connect the content to the timezone package; done when all four checklist items are addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100