Page MenuHomePhabricator

Improve config.yaml documentation and error verbosity
Open, Needs TriagePublic

Description

Currently, the ISA tool does not have any documentation about the config.yaml file that is required by the Flask app to set configuration variables and just throws a FileNotFoundError that just tells the user the file is missing. That behaviour will change once https://gerrit.wikimedia.org/r/c/labs/tools/Isa/+/588648 is merged.
The current idea is to include basic documentation about how to make the config.yaml file and raise a more verbose error.

Event Timeline

Gabrielchl moved this task from Backlog to Review on the ISA board.

I think , we could also include the details and steps about how to populate and get the values for the parameters of the config.yaml file.
Will it be a good idea to do so ? @QEDK @Gabrielchl