Project Summary

This plugin creates images, HTML snippets and full documents about the project's health. These can be easily exported to be displayed in another web site (e.g. Wiki, Confluence, Liferay..).

Please see the documentation about the export of figures in external web sites. You can check also the plugin Perl documentation in the perldoc section.

Basic information

ID: ProjectSummary
Name: Project Summary
Abilities: figs, viz
Description: The Project Summary plugin creates a bunch of exportable HTML snippets, images and badges.
Parameters:
- proxy If a proxy is required to access the remote resource of this plugin, please provide its URL here. A blank field means no proxy, and the default keyword uses the proxy from environment variables, see the online documentation about proxies for more details. Example: https://user:pass@proxy.mycorp:3777.

Please note that this plugin uses the shields.io services to generate the badges. If this web site is behind a proxy, then one needs to fill the proxy field in.

Provides

Figures

badge_attr_alambic.svg A badge to display current value of main quality attribute on an external web site (uses shields.io)
badge_attr_root.svg A badge to display current value of main quality attribute on an external web site (uses shields.io)
badge_psum_attrs.html A HTML snippet to display main quality attributes and their values.
psum_attrs.html A HTML snippet to display main quality attributes and their values.
badge_qm A HTML snippet that displays main quality attributes.
badge_project_main A HTML snippet that displays the name and description of the project.
badge_qm_viz A HTML snippet that displays the quality model visualisation.
badge_downloads A HTML snippet that displays downloads for main data.
badge_plugins A HTML snippet that displays a list of plugins for the project.

Visualisation

Project Summary

Screenshot

Project Summary UI