groupApplication for roadmaps management
TypeXAR
CategoryApplication
Developed by

Teodor Caras

Active Installs1
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Roadmaps application allows for easier creation of roadmaps through templates. 

It also provides with two macros. One for displaying capacities and one for displaying roadmap items.

Roadmaps

A roadmap can be created inside the Roadmaps space.

Template page of a Roadmap

Each roadmap will have the following fields:

Field nameField type
Start DateDate
End DateDate
StatusStatic List - Select (Not started / In progress / Finished)
CapacityText area
Short ScopeText area
Detailed ScopeContent

On the front page of the space, you can visualize all the created roadmaps through a live table.
The table allows sorting after the title, starting or ending dates of the roadmaps as well as their status.

Livetable of roadmaps found of the home page of Roadmaps space.

Roadmap Item Macro

The purpose of this macro is to display an existing task. These tasks can be assigned to multiple users.

Usage of the roadmap item macro.

{{roadmapitem assignee="XWiki.Admin" project="Cloud" url="https://jira.site.com/browse/TASK-14" status="inProgressStill" description="Do this task that is a good task. Pretty great task. 5/7 will do" optional="true"}}
  ## Content as needed
{{/roadmapitem}}

{{roadmapitem assignee="XWiki.Admin" project="Some Project" url="https://jira.site.com/browse/TASK-13" status="highPriority" description="Implement that functionality that is desired for the other functionality that will ultimately help with that last functionality." optional="false"}}
  ## Content as needed
{{/roadmapitem}}

The structure of one item is the following:

Field nameField Description
AssigneesThe users that will work on this task
ProjectThe project this task belongs to
UrlThe URL of the task, be it JIRA, Git or something else.
StatusThe status of the task
DescriptionA short description of the task
OptionalWether this mandatory or nice to have
ContentAdditional description of this task

Roadmap Status

The Roadmap Status field can customized by the admin of the wiki. Inside the Administration Page → Other → Roadmap one can add different statuses and assign icons to each and every one of them.

The Roadmap section inside the Administer Page

Capacity Macro

In the capacity section, you can use the capacity macro to display the availability of each employee for the current roadmap. One such usage could look as the following:

Display of a usage of roadmaps capacity macro

{{capacity user="XWiki.Admin" percentage="75" additionalInfo="Project 2"/}}

One capacity holds the following information:

Field nameField Description
UserThe user whose capacity we will display
PercentageThe availability of the user during the current roadmap
AdditionalInfoAny additional info with regards to the capacity. It can either be the other projects the user will be working on (the remaining percentage) or a note with regards to his availability

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.2

v1.1

v1.0

Dependencies

Dependencies for this extension (org.xwiki.contrib.roadmap:application-roadmap-ui 1.2):

Tags:
    

Get Connected