Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

PMA Comments

The dashboard for the PolarSys Maturity Assessment framework allows projects to write and publish comments. These can typically give more insights on the project's customs and conventions, or explain why a metric has an especially high or low value. A common example is for developer mailing lists, which are sometimes used as announcement lists.


Usage

The main entry point for managing comments is located at http://dashboard.polarsys.org/comments . Any action on comments needs a login and password, which have been sent to projects' contact person. Logins are for individuals, so if you believe that you or someone else needs access just ask for a new login. One individual can access several projects, if needed.

Comments can also be added/edited/deleted from the project's dashboard page. A confirmation is asked for every action, and comments are backuped every day. Any action is immediately made visible to the world when committed.

If you encounter any problem with the system (bug, usability issue, etc.) please feel free to contact the team. We're here to help!


Architecture

The system is written in Perl and uses the Mojolicious web framework. All Perl and data files are stored in the PMA's git repository at BitBucket (access required). All comments are stored in json files (one json file per project), with a unique ID (timestamp), the author, the node of the quality model the comment is attached to, and the comment itself.

The system is based on a REST-API like structure and provides the following URLs to view, add, edit or delete comments:


Authentication

One must be authenticated to add, edit or delete comments on a project. Users are declared in the users.json file at the root of the mojolicious directory.

Data files

All comments are stored in the /projects/<project_id> directory. The file is named <project_id>_comments.json, and its structure is as follows:

{
  "name":"modeling.sirius",
  "comments":[
    {
      "user":"boris",
      "date":"Wed Aug 26 05:43:11 2015",
      "author":"Boris Baldassari",
      "mnemo":"QM_QUALITY",
      "id":1440582191,
      "text":"Sample comment for Sirius."
    }
  ]
}

Back to the top