Difference between revisions of "Documentation/Nightly/Developers/BugTrackerConfiguration"

From Slicer Wiki
Jump to: navigation, search
m
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
This page documents the tweak and configuration details specific to Slicer bug trackers.
 
This page documents the tweak and configuration details specific to Slicer bug trackers.
  
Line 17: Line 18:
 
* http://www.mantisbt.org/manual/manual.page.descriptions.system.management.pages.manage.configuration.workflow.thresholds.php
 
* http://www.mantisbt.org/manual/manual.page.descriptions.system.management.pages.manage.configuration.workflow.thresholds.php
 
* http://www.mantisbt.org/docs/master/en/administration_guide/admin.user.access.html
 
* http://www.mantisbt.org/docs/master/en/administration_guide/admin.user.access.html
 +
 +
== Add Reporter field in the View Issues page ==
 +
 +
In Manage -> Manage Configuration -> Configuration Report
 +
 +
Then, in "Set Configuration Option":
 +
* Username: All users
 +
* Project name: Slicer4
 +
* Configuration Option: view_issues_page_columns
 +
* Type: default
 +
* Value: <code>array ( selection, edit, priority, id, sponsorship_total, bugnotes_count, attachment, category, severity, reporter_id, status, last_updated, summary ) </code>
 +
 +
{{remark|red|'''category''' should be used instead of '''category_id'''}}
 +
 +
 +
.. and click on "Set Configuration Option"
 +
 +
 +
References:
 +
* http://www.mantisbt.org/wiki/doku.php/mantisbt:customizing_columns_in_view_issues_page
 +
 +
== Allow Gravatars ==
 +
The Mantis issue tracker is enabled to use the Gravatar web service to display a user avatar in certain views.  This solves [https://issues.slicer.org/view.php?id=4219 this request in the issue tracker]. 
 +
 +
=== Requirements ===
 +
The '''user''' must register the same email used in Mantis with Gravatar.  [https://support.mantishub.com/hc/en-us/articles/204273845-Setup-your-Avatar The process is simple, and similar to what's described for MantisHub].
 +
 +
The '''Administrator''' must install the Gravatar plugin (bundled). In the configuration file, we turn on the option.
 +
<source lang="php">
 +
$g_show_avatar = ON; // defaults to OFF;
 +
</source>
 +
 +
== Set Color Scheme ==
 +
The default color scheme for the newly rolled out v2.4.1 was too faded, so we use these colors instead
 +
<source lang="php">
 +
$g_status_colors = array(
 +
        'new'          => '#ef2929', # scarlet red
 +
        'feedback'    => '#75507b', # plum
 +
        'acknowledged' => '#f57900', # orango
 +
        'confirmed'    => '#fce94f', # butter
 +
        'assigned'    => '#729fcf', # sky blue
 +
        'resolved'    => '#8ae234', # chameleon
 +
        'closed'      => '#babdb6'  # aluminum
 +
</source>
 +
 +
== Plugins ==
 +
Plugins are listed at https://www.mantisbt.org/wiki/doku.php/mantisbt:mantis_plugins and also at https://github.com/mantisbt-plugins
 +
 +
=== Bundled Plugins ===
 +
I installed the 3 bundled plugins:
 +
# Gravatar - enables user avatars; see section above
 +
# graphs plugin - it enhances the graphs displayed in the summary section such as https://issues.slicer.org/plugin.php?page=MantisGraph/status_graph.php
 +
# import/export plugin - allows Administrators to import and export issues in XML
 +
 +
=== Additional Plugins ===
 +
# The [https://github.com/mantisbt-plugins/source-integration Source Integration] plugin, along with the SourceGitHub plugin were installed and configured to integrate the slicer.org and slicer repos.  Furthermore, I configured it to add search.  A cron job is setup to periodically fetch repo updates into Mantis.
 +
 +
== Enable Markdown ==
 +
There is a configuration setting for processing markdown in the core formatting plugin.
 +
 +
# (Administrator) Navigate to the Manage Plugins page.
 +
# Then click the title for the Mantis Core Formatting plugin to access it's [https://issues.slicer.org/plugin.php?page=MantisCoreFormatting/config setting page]
 +
# Tick the box for processing Markdown and save.

Latest revision as of 02:03, 7 June 2017

Home < Documentation < Nightly < Developers < BugTrackerConfiguration


For the latest Slicer documentation, visit the read-the-docs.


This page documents the tweak and configuration details specific to Slicer bug trackers.

Allow Reporter, updater, developer to add notes even if issue is resolved or closed

In Manage -> Manage Projects -> Slicer4 -> Manage Configuration -> Configuration Report

Add a new entry:

* Username: All Users
* Project: Slicer4
* Configuration Option: update_readonly_bug_threshold
* Type: integer
* Value: 25
* Access Level: administrator

References:

Add Reporter field in the View Issues page

In Manage -> Manage Configuration -> Configuration Report

Then, in "Set Configuration Option":

  • Username: All users
  • Project name: Slicer4
  • Configuration Option: view_issues_page_columns
  • Type: default
  • Value: array ( selection, edit, priority, id, sponsorship_total, bugnotes_count, attachment, category, severity, reporter_id, status, last_updated, summary )
  1. category should be used instead of category_id


.. and click on "Set Configuration Option"


References:

Allow Gravatars

The Mantis issue tracker is enabled to use the Gravatar web service to display a user avatar in certain views. This solves this request in the issue tracker.

Requirements

The user must register the same email used in Mantis with Gravatar. The process is simple, and similar to what's described for MantisHub.

The Administrator must install the Gravatar plugin (bundled). In the configuration file, we turn on the option.

$g_show_avatar = ON; // defaults to OFF;

Set Color Scheme

The default color scheme for the newly rolled out v2.4.1 was too faded, so we use these colors instead

$g_status_colors = array(
        'new'          => '#ef2929', # scarlet red
        'feedback'     => '#75507b', # plum
        'acknowledged' => '#f57900', # orango
        'confirmed'    => '#fce94f', # butter
        'assigned'     => '#729fcf', # sky blue
        'resolved'     => '#8ae234', # chameleon
        'closed'       => '#babdb6'  # aluminum

Plugins

Plugins are listed at https://www.mantisbt.org/wiki/doku.php/mantisbt:mantis_plugins and also at https://github.com/mantisbt-plugins

Bundled Plugins

I installed the 3 bundled plugins:

  1. Gravatar - enables user avatars; see section above
  2. graphs plugin - it enhances the graphs displayed in the summary section such as https://issues.slicer.org/plugin.php?page=MantisGraph/status_graph.php
  3. import/export plugin - allows Administrators to import and export issues in XML

Additional Plugins

  1. The Source Integration plugin, along with the SourceGitHub plugin were installed and configured to integrate the slicer.org and slicer repos. Furthermore, I configured it to add search. A cron job is setup to periodically fetch repo updates into Mantis.

Enable Markdown

There is a configuration setting for processing markdown in the core formatting plugin.

  1. (Administrator) Navigate to the Manage Plugins page.
  2. Then click the title for the Mantis Core Formatting plugin to access it's setting page
  3. Tick the box for processing Markdown and save.