Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align nomenclature with Kibana upstream #366

Open
dplanella opened this issue May 23, 2019 · 1 comment
Open

Align nomenclature with Kibana upstream #366

dplanella opened this issue May 23, 2019 · 1 comment

Comments

@dplanella
Copy link

dplanella commented May 23, 2019

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):

Kibiter 6.1.x Kibana 6.1.x Notes
Widget Visualization Upstream documentation
Panel Dashboard Upstream documentation. Referred to as dashboards on https://bitergia.com/products/dashboards/
Dashboard N/A 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
Copy link
Contributor

I do share this idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants