GrimoireLab仪表板的面板和可视化
grimoirelab-panels的Python项目详细描述
面板
面板由包含的几个小部件组成。到目前为止 被提议为通用的面板是几个数据源的混合 在项目中可用。那些可能只集中在git上,但是 其他的如审查系统如gerrit,irc渠道,邮件 列表等
命名文件的结构应为:*对于数据源:
<data_source>[_<panel_name>].json Examples: git_<panel_name>.json gerrit_<panel_name>.json
- 对于其他不关注特定数据源的面板,我们只使用 面板名:``.json
示例:about.json overview.json git.json git_pair_programming.json gerrit.json gerrit_timing.json
To give some examples, below there is a list of some panels that can be found in this directory: * git.json: provides aggregated information about all of the gits in the analysis. * gerrit.json: provides aggregated information from all of the gerrit projects. * gerrit-backlog.json: provides specific widgets to track the backlog of the project. * mailinglists.json: provides information about the discussions that take place in the several mailing lists. * about.json: provides some widgets detailing this information and how to interact with the panels. * overview.json: provides a generic view of the dataset with some widgets that help to drill down the information from the whole list of data sources. All panels will provide widgets for filtering informartion by project, domain, organization, etc. depending on the availability of that information in the corresponding index. Widgets Naming --------------
< /P>
示例:git_top_authors示例:git_authors
Where data source could be git, gerrit, mbox, etc. Widgets Title Naming -------------------- In general, titles should follow the same naming scheme as the widget itself, substituting underscore characters by single spaces and adding capital letters. Nevertheless, **widgets title depends on the name of the panel** in which the widgets are located: - **If the panel shows information for several data sources, then the name of the data source must be included**. For example, it's the case of Data Status Panel, because it contains the same information per data source, so using data source name in title is mandatory. - **If the name of the data source is included in the title of the panel, then the name of the data source shouldn't be included in widgets' title**, except in cases where it could help understand what the widget contains.
示例:顶级作者的相同可视化将命名为:
- "git"面板中的"顶级作者",因为面板提供了上下文。
- "概述"面板中的"git top authors",我们可以有类似的 其他数据源的可视化。'
当然,这是一个一般规则,只要考虑到上下文 命名窗口小部件以了解数据源是否清晰。