influxdata / influxdata/docs-v2
Proposal: avoid confusion over Flux scripts and files and `scriptID` (invokable) scripts and files
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Proposal in the making.
Decide on terminology for Flux script/file
- CLI docs use "Flux script file" to mean a file that contains "raw" Flux and is used to set the flux property for the task. The option terminology gets confusing with the advent of (invokable) script files that are referenced by tasks.
- See the Cloud API spec for tasks.
- See #4229
##### Relevant URLs
- _Provide relevant URLs_
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the CLI documentation terminology, the Cloud API spec for tasks, and related issue #4229. Determine where “Flux script file” and invokable script files are distinguished or conflated. Done means the terminology decision is agreed and the affected documentation references are consistently updated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100