Situation
When building deliverables in verbose output, the output can be overwhelming. Additionally, when something goes wrong it could be already gone out of sight.
Use Case
It would be helpful to structure the output in a way that it allows to:
- see which deliverable is currently being built,
- see any errors at the same time.
This would be an additional view for the traditional output with logging.
Possible Implementation
We could use the rich library (already used as a dependency). I'm currently not 100% sure how this could look like. There are many ways to group that. This needs further discussion.
As a working draft, the output screen could look like this:
[▌▌▌▌ ] sles/16.0/en-us
[▌▌▌ ] sle-ha/16.0/en-us
[▌▌▌▌▌▌▌▌] suse-ai/1.0/en-us ✅
--------------
sles/16.0/en-us:DC-foo-bar: ERROR wrong
The first pane contains a progress bar that shows all requested doctypes (=product & docset & lang). When everything was successfully built, it gets a checkmark (✅).
The second pane contains error messages. It can be validation errors, JSON problems, or any other issue that went wrong. Maybe even warnings. Everything that is needed to judge if it's a serious issue.
Further information
https://rich.readthedocs.io/en/stable/live.html
Situation
When building deliverables in verbose output, the output can be overwhelming. Additionally, when something goes wrong it could be already gone out of sight.
Use Case
It would be helpful to structure the output in a way that it allows to:
This would be an additional view for the traditional output with logging.
Possible Implementation
We could use the
richlibrary (already used as a dependency). I'm currently not 100% sure how this could look like. There are many ways to group that. This needs further discussion.As a working draft, the output screen could look like this:
The first pane contains a progress bar that shows all requested doctypes (=product & docset & lang). When everything was successfully built, it gets a checkmark (✅).
The second pane contains error messages. It can be validation errors, JSON problems, or any other issue that went wrong. Maybe even warnings. Everything that is needed to judge if it's a serious issue.
Further information
https://rich.readthedocs.io/en/stable/live.html