influxdata / influxdata/docs-v2
Some example queries do not work with Windows Powershell
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Windows Powershell parses out double quotes (`"`) automatically, and in order for them to work correctly they need to be escaped (`\"`). There are a handful of places in the docs where sample CLI commands are shown, and the double quotes would not work correctly on powershell. I'm not sure if escaping them in the examples, or just mentioning that powershell needs quotes escaped is the solution but as it is now, some examples will error if copy-pasted
##### Relevant URLs
- An example of a sample query that will not work in powershell: https://docs.influxdata.com/influxdb/v2.4/reference/cli/influx/query/#query-influxdb-with-a-flux-string
- A community thread related to this: https://community.influxdata.com/t/influx-2-1-cli-on-windows-powershell/23181/5
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the linked reference page at docs.influxdata.com/influxdb/v2.4/reference/cli/influx/query/#query-influxdb-with-a-flux-string, then search the documentation for other sample CLI commands containing double quotes. Determine whether the examples or surrounding guidance should address PowerShell escaping; done means the affected examples work when copy-pasted in PowerShell.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100