Redmine Project Manager & Contacts User manual · Welcome to Redmine Project Manager & Contacts (....
Transcript of Redmine Project Manager & Contacts User manual · Welcome to Redmine Project Manager & Contacts (....
Redmine Project Manager & Contacts
User manual
If you want a complete guide of Redmine, please consult this link :
http://www.redmine.org/projects/redmine/wiki/Guide
Made with ♥ on the decentralized earth
@florencef for FairCoop 13/07/2018
Table of Contents1. General .................................................................................................................................................. 32. Working in a project (group ; area) ....................................................................................................... 53. Tasks, proposals, help, bug, feature, expense......................................................................................73.1. Consult a task ..................................................................................................................................... 73.2. Create a task ...................................................................................................................................... 83.3. Modify a task .................................................................................................................................... 103.4. Add time in a task ............................................................................................................................ 113.4. Validate a task .................................................................................................................................. 123.5. Add an expense ................................................................................................................................ 124. Overview, Activity, issues, time spent ................................................................................................. 135. Grantt .................................................................................................................................................. 166. Agile .................................................................................................................................................... 177. Calendar .............................................................................................................................................. 188. Wiki ..................................................................................................................................................... 198.1. Create a wiki page ............................................................................................................................ 209. Contacts database ............................................................................................................................... 219.1. Add a contact ................................................................................................................................... 229.2. Modify a contact, delete a contact .................................................................................................. 26
@florencef for FairCoop 13/07/2018
1. GeneralWelcome to Redmine Project Manager & Contacts (https://org.fair.coop/). First of all, you need to sign in : you can do it by choosing the option Register right above on the screen.
Then fill the field in and click on the Submit button:
When you have an account, you can log in (with the option sign in) :
Now you have access to the software :)
The first screen looks like this :
@florencef for FairCoop 13/07/2018
On the top of the screen, you have different information :
Home : to go back to the main screenMy page : information about your activity in the software (issues)FairCoop Ecosystem : the different areas, projects, local nodes in the softwareAdministration : tools for the adminHelp : online help (Redmine wiki)Shady mode : disableMy account : to modify information about your accountActivity : the activities you made in the softwareSign out : to sign out
Search : search option (you have a pick up list to search in one specific project if you want)
Bellow, you can choose an option : you can go to a project or a specific area.
with an overview, the members and a description of the projects
@florencef for FairCoop 13/07/2018
2. Working in a project (group ; area)
First of all, select a projet (dubble‐click on it) NB : you need to have the permission to go in that project. Not all projects are public. If you don’t have access, contact someone in the Redmine Telegram group (FC Redmine (English)). https://t.me/joinchat/C7QpPkkxczSJaU04IaFh4A
When you select a project, you will see an overview of that project with an issue tracking (list of tasks, etc.) and all the members of that project.If you have administration rights, you can add a new sub‐project to that project.
@florencef for FairCoop 13/07/2018
When you click on tasks, you will have a list of all tasks in that project. NB : you can filter your search if you want (by status or tracker).
A issue can be a task, a proposal, help, bug, Feature or an Expense.
@florencef for FairCoop 13/07/2018
3. Tasks, proposals, help, bug, feature, expense
3.1. Consult a task
When you click on a task (or proposal, help, bug, feature, expense), you will see a resume of the task.
On the top of the screen, you have different options : edit, log time, unwatch, copy, delete, validate, completed and more (export)
Edit : to edit the task and make some changesLog time :to log the time spent for this taskUnwatch : if you don’t want a notification about this task, you can choose ’unwatch’Copy : to copy the taskDelete : to delete the taskValidate : to validate the taskCompleted : to close the taskMore : to export the data from the task
When you open a task, you will see the title of the task and a description. You also can see who created the task and the date of creation. You also have the status, the priority, the assignee, the startdate and due date, % done, estimate time and spent time.You also can see the subtasks and related issues + the history.
@florencef for FairCoop 13/07/2018
3.2. Create a task
Click on new issue
You will see this screen :
@florencef for FairCoop 13/07/2018
Author : the person who creates the issue (you)Tracker : the type of issue (most of the time, you will choose ‘tasks’ but you also can choose for other types).Subject : here you need to add the title of your task (or other issue)Description : give here a description of the task (or other issue). You can add text but also links to your pads, documents, etc.Status : it is automatically on ‘new’Priority : you can choose between ‘low’, ‘normal’, ‘high’, ‘urgent’ and ‘immediate’Assignee : select the person committed to the taskDeal : not used right nowTags : tags are keywords. You can add various tags. You also can select a tag that already exists. Tags are linked at a specific project.Parent task : you can associate a parent task Start date : add the creation date of the taskDue date : add the date when the task must be finishedEstimated time : add the estimated time for the task (in hours)% Done : the percent of the work already done (you can change it when needed)Log time : add the time you spent on a task Spent time : the hours you spent on the task (you can add various times when needed)Activity : is by default always ‘development’ Comment : add a little comment about the task you did (mandatory)Voluntary work : by default the work done is voluntary, if you like to be paid, please uncheck the optionNotes : you can add some information, pads, links in here. NB : you can make the note ‘private’Files : you can add files to the task (pdf or other format)Submit : to save your task. Don’t forget to click on it :)
NB : the fields with an * are mandatory
@florencef for FairCoop 13/07/2018
3.3. Modify a task
When a task is created, you can modify it, copy it, delete it, validate it and export it.To modify a task, choose the Edit option . You also can add a file, subtasks, related issues and notes.On the buttom of the screen, you will see the history of the task :
@florencef for FairCoop 13/07/2018
3.4. Add time in a taskGo to the option log timeYou will see this screen :
Fill the different fields.NB : the activity is always 'development'the option voluntary work is selected by default.If you want, you can log time directly at the welcome screen of a project, area, group). You also can create a report.
Remark : all your logged time will appear monthly at kispagi.fair.coop, if it's not voluntary, it can be remunerated through our FC Open Coop Work protocol.
@florencef for FairCoop 13/07/2018
3.4. Validate a taskChoose the validate option
The status will change from new to validate (nb : you need to validate the tasks from others). Each task needs 2 validations or more before you can get paid. When 2 people validate a task, the status change from validate to validate+NB : if a third person validate the task, the status will change in validate (and not validate+ anymore)
3.5. Add an expense
Click on new issue (in your project) and choose ‘expense’ as tracker. Fill the different fields.
@florencef for FairCoop 13/07/2018
4. Overview, Activity, issues, time spent
The overview gives an overview by project (or sub‐project)
The activity shows an history of all activities for one project for the last month.NB : you can change the date of an issue or a note. The date is important for the statistics and other issues.
@florencef for FairCoop 13/07/2018
Issues shows all tasks, expenses, etc. related to on project (area, sub‐area).NB : you can use a filter to search in the list, you also can search bu status or other options.
@florencef for FairCoop 13/07/2018
Time spent shows the time spent in the project (area, sub‐area). NB : you can use a filter to search in the list, you also can search bu status or other options.
@florencef for FairCoop 13/07/2018
5. GranttGrantt gives a summary of all issues (tasks, expenses, bugs, propsals, helps,…) for one area or sub‐area in a chart. It helps to see if some tasks are pending or need a follow‐up. Also here, you can search in options or use a filter.
If you want, you can save the chart (click on save).
@florencef for FairCoop 13/07/2018
6. AgileThe Agile board shows the issues (tasks, proposals, expenses, etc.) from the area or sub‐area in the form of a board.
Also here, you can search in options or use a filter.
@florencef for FairCoop 13/07/2018
7. CalendarThe calendar shows all issues (tasks, proposals, expenses, etc.) from the area or sub‐area in the form of a calendar.
Also here, you can use a filter for your search.
@florencef for FairCoop 13/07/2018
8. WikiYou can add documentation, comments, etc. related to your area, sub‐area in the wiki.
New wiki page : to add a new wiki pageEdit : to modify a wiki pageWatch : to receive a notification about thisLock : to lock a wiki page (to prevent modification of the page)Rename : to rename the pageDelete : to delete the pageHistory : to see the history of the page
@florencef for FairCoop 13/07/2018
8.1. Create a wiki pageChoose the option « new wiki page » and give a title (the name of your page), click then on « next »
Type your text (or copy the text from somewhere else). You also can add hyperlinks,NB : you can add files (on the bottom of the screen) with the option « files »
Don’t forget to save your page (you can preview your page first).
NB : you can add more than one file.
@florencef for FairCoop 13/07/2018
9. Contacts databaseThe contact database is a database that helps manage the contacts (people or organisations).The contact database is linked at a project or area or subarea or group. You need to have access to the contact databse to view, add, modify and delete the contacts.
If you want to go in the database, just click on contact (on the top of the screen)
You can search for a contact, you can add a new, you can import one or export one.For the search, you can add a filter (ex. : name). You also can search by tag (right on the screen).NB : if you don't see the right colomn, click on the arrow at your right. If you don't want to see the right colomn, click again on the arrow.
Without right colomn :
@florencef for FairCoop 13/07/2018
9.1. Add a contactClick on new contact
Avatar you can add here a picture (of the contact), logo (of the organisation)Company if you want to add a organisation or a coop, select this option. You will have access to a specific screen.The other fields need to be completed if you want to add a person.
When you select the option Company, you will see this screen :
Fill the different fields.
Tags : tags are keywords or categories. You can select a tag already used in the contact database by typing the begining of the word. You also can add any tag you want. A tag may have one or more thanone words. Begin the tag with a majuscule.
@florencef for FairCoop 13/07/2018
After you enteried a contact you will see a summary :
You can add a note (a note can be information about a letter sent or a contact made, etc.). Just fill thefield and click on add note
You can add more than one note. You can modify a note (select first the note, then click on edit at theright of the screen). You can delete a note (select first the noten then click on delete at the right of the screen). The advanced option gives you the opportunity to add a date and a file (like a copy of the letter).NB : You can search in the notes. Select the option notes at the right of the screen.
@florencef for FairCoop 13/07/2018
NB : you can send an email to the contact via the option email (on the top of the screen).If you want a copy of the email in your own account, select the option Bcc and add your email adress in there.
The email will be send to the email adress of the contact and the summery of the email will be showned as note.
NB : you need to change manually the option 'relation' in the contact fiche (by editing the contact).
You can choose between : no contacted, in progress, accept faircoins, not intrested, rejected
When a contact reply, you can add their reply as note (with a link to their email or letter) and change the relation again. (Go to the contact, choose edit, change the relation. Add the note).
@florencef for FairCoop 13/07/2018
Select Advanced (type, date, file) to add the type of note (note, email, call, meeting), the date (important for statistics) and to add a file (for example the reply email).Click on to delete the file. Click on to add the note.
You can edit of delet the note by coosing the options on the right of the screen
NB : You can add more than one note.
@florencef for FairCoop 13/07/2018
9.2. Modify a contact, delete a contactSearch first the contact you want to modify or delete. Select the contact. You will have a summery of the contact.
To modify a contact, choose the option edit on the right of the screen.To delete a contact, choose the option delete on the right of the screen.
NB : you can select multiple contacts at the same time and right‐click, a popup menu will appear to apply an action to all of them, saving you time.
@florencef for FairCoop 13/07/2018