influxdata / influxdata/docs-v2
Docs misleading when a tag and field set is present
@mluu12 is already working on this.
Since Jul 28, 2021.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
The wording of the "Whitespace I" section in the InfluxDB line protocol tutorial doc, for the case when we have both a tag set and field set, is misleading, leading to viewer interpretation that whitespace is needed between each of the measurement name, tag set, field set and optional timestamp.
It would be good if the section contained examples of:
1. Fields only (docs already have this example)
2. Tags only
3. Both Tags & Fields
along with a rewrite of the paragraph:
"Separate the measurement and the field set or, if you’re including a tag set with your data point, separate the tag set and the field set with a whitespace. The whitespace is required in line protocol."
...so that a comma is always needed after the measurement name if a tag set is present, regardless of if a field set is present or not.
##### Relevant URLs
https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/
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.
Assessment
This issue has not been assessed yet.