influxdata / influxdata/docs-v2
Clean up Enterprise API examples
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Once #3330 merges, we should clean up the API examples [here](https://docs.influxdata.com/enterprise_influxdb/v1.9/administration/manage/security/authorization-api/).
As a user, I want to be able to quickly cut, paste, modify the command.
The output is useful, but we should separate these to make cut and paste easier for the user.
Also, let's use `jq` instead of python, and add a note about its use.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the linked Enterprise authorization API page and review the examples after #3330 merges. Separate output from copyable commands, replace Python usage with jq, and add a note explaining jq; done means users can quickly cut, paste, and modify each command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, shell
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100