Improve usability of commonly used scripts
- Dominant language
- Java
- Stars
- 107
- Forks
- 29
- Avg merge
- 19h 46m
- Merged PRs (30d)
- 141
Description
### Description / Background
Many of our scripts that are intended for users take a number of command line arguments that have to be in a specific order, sometimes with optional arguments that have to be passed at the end. The only documentation available at the point of use is the usage message, which just gives names of the arguments that can be passed, and their order.
In the following issue we converted a number of scripts to an approach that includes help text, and limits the number of positional arguments:
- https://github.com/gchq/sleeper/issues/6420
We'd like to apply the same approach to the most commonly used scripts, and make them more usable. This includes the following scripts:
- `filesStatusReport.sh`
- `listTables.sh`
- `ingestJobStatusReport.sh`
- `ingestBatcherReport.sh`
- `compactionJobStatusReport.sh`
### Technical Notes / Implementation Details
See sub-issues.
Contributor guide
Research direction
Start by reading issue 6420 and the sub-issues, then inspect filesStatusReport.sh, listTables.sh, ingestJobStatusReport.sh, ingestBatcherReport.sh, and compactionJobStatusReport.sh. Compare their current usage messages and argument handling with the approach described in issue 6420. Done means the listed scripts provide help text and limit positional arguments as specified by their sub-issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100