influxdata / influxdata/docs-v2
add documentation not to use the key-field separator
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
A tag formatted similar to
```
rule=RUN_TEST#!~#runRuleSteps
```
caused bad behavior from the character sequence `#!~#`
, but don't see any mention of those characters in the docs here:
https://docs.influxdata.com/enterprise_influxdb/v1/write_protocols/line_protocol_reference/#special-characters
However, in local dev environment I tried to replicate and found that while it does actually query correctly, the export is generated incorrectly.
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 at the linked line protocol reference, especially the Special characters section, and compare its guidance with the reported key-field separator and export behavior. Update the documentation to mention the problematic character sequence or restriction, then verify that the page clearly explains what users should avoid.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100