While working with Kibiter via Bitergia, we've been struggling with using the right names to refer to the web UI components.
Some names are exclusive to Kibiter (e.g. widget), whereas others (e.g. Dashboard) have different meanings in Kibiter and Kibana. There are some hints as to the differences in the Sigils README, but there is not a canonical list with the definitions.
To add to the confusion, the Kibiter UI uses the Kibana terms (e.g. Visualization instead of Widget).
These are the terms we've been able to figure out so far (please feel free to correct where there is a mismatch):
A whole set of panels. I believe this corresponds to the top-level navigation menus on the Bitergia platform (e.g. "Git", "Community", "Data status", etc.)
A proposal would be to update the documentation to align the terms to upstream.
The benefits for users would be less confusion, easier learning curve, and the ability to use Kibana upstream documentation directly. The benefits for maintainers would be the removal of the differences with upstream, preventing a mismatch between UI and documentation.
canasdiaz
commented
1 year ago
While working with Kibiter via Bitergia, we've been struggling with using the right names to refer to the web UI components.
Some names are exclusive to Kibiter (e.g. widget), whereas others (e.g. Dashboard) have different meanings in Kibiter and Kibana. There are some hints as to the differences in the Sigils README, but there is not a canonical list with the definitions.
To add to the confusion, the Kibiter UI uses the Kibana terms (e.g. Visualization instead of Widget).
These are the terms we've been able to figure out so far (please feel free to correct where there is a mismatch):
A proposal would be to update the documentation to align the terms to upstream.
The benefits for users would be less confusion, easier learning curve, and the ability to use Kibana upstream documentation directly. The benefits for maintainers would be the removal of the differences with upstream, preventing a mismatch between UI and documentation.