Project

General

Profile

EMG Redmine Quick Start Guide » History » Version 6

Amber Herold, 01/27/2010 11:03 AM

1 1 Amber Herold
h1. AMI Redmine Quick Start Guide
2 4 Amber Herold
3
{{>toc}}
4 1 Amber Herold
5 2 Amber Herold
AMI is using "Redmine":http://www.redmine.org for tracking product issues. There are 3 projects available: AMI Group, Appion and Leginon. AMI Group is only available to users that are AMI Lab members. It holds anything that is not specifically related to Appion or Leginon or is not intended for public view. Although there is not a clear division in the software code between Appion and Leginon, we use these as project names to be consistent with how the products are presented to the rest of the world. Leginon is loosely everything that has to do with image capture and Appion relates to image processing. The single svn repository holding the code for both products is available from both Redmine projects.
6 1 Amber Herold
7 6 Amber Herold
h2. 1 Register as a user
8 1 Amber Herold
9
If you have not registered, click on the "Register" link in the top right corner of the website. After submitting the information requested, an existing Redmine administrator will be notified via email that your registration is pending approval. When you are approved, Sign in using the "Sign in" link at the top right corner of the website.
10
11 6 Amber Herold
h2. 2 Select a project to view
12 1 Amber Herold
13
Select "Projects" from the top left corner of the website. You will see projects that you are a member of, as well as those that are public.
14
15 6 Amber Herold
h2. 3 Add a new issue
16 1 Amber Herold
17
* Go to the project that you want to add the issue under. Select the "New issue" tab.
18
* Select a Tracker: Bug, Feature, Support, or Task.
19
* Write a descriptive subject line.
20
* At this point you may select "Create" at the bottom of the page. If you can fill in more information, please do.
21 2 Amber Herold
* To link to another issue maintained in Redmine, type # followed by the issue number (#17). 
22
* To link to a subversion changeset, put a lower case r in front of the revision number (r234).
23 1 Amber Herold
24 6 Amber Herold
h2. 4 View issues
25 1 Amber Herold
26
* Select the "Projects" link at the top left corner of the web page. 
27
* Select "View all issues" on the right side of the page. This will display all open issues from all projects. 
28
* At the top of the screen is a "Filters" section.
29
* Select any combination of filter criteria and click "Apply" to view the results.
30
* You may save this query and run it in the future. It will show up under "Custom queries" on the right side navigation bar.
31
32 6 Amber Herold
h2. 5 Edit a wiki page
33 1 Amber Herold
34
To edit, click the "Edit" link at the top of the page. 
35 5 Amber Herold
36 1 Amber Herold
Find syntax help "here":http://www.redmine.org/wiki/redmine/RedmineTextFormatting and "here":http://redcloth.org/hobix.com/textile/.
37 5 Amber Herold
For tips and tricks that were a bit more difficult to find info on check [[Wiki Tips]].
38 1 Amber Herold
39 6 Amber Herold
h2. 6 Create a new wiki page
40 1 Amber Herold
41
To create a new wiki page, edit an existing one and include double brackets around the name of the page that you wish to create like this:
42
43
![[My new wiki page]]
44
45
It will appear as a red link when it is saved. 
46
Click on the link and add content to your new page. 
47
Remember to save it before navigating away or you will lose all your hard work!
48
More information on Wiki creation is "here":http://www.redmine.org/wiki/redmine/RedmineWikis.
49
50 6 Amber Herold
h2. 7 Add "breadcrumbs" to your wiki page
51 1 Amber Herold
52
Breadcrumbs are links that appear at the top of a wiki page that show the previous pages that you visited. 
53
To add breadcrumbs you must set up parent/child relationships for wiki pages. 
54
To set the parent of the page that you are currently viewing, select "Rename" at the top right. 
55 3 Amber Herold
Copy and paste the name of the parent page from the desired parent page's "Rename" section.
56 1 Amber Herold
57 6 Amber Herold
h2. 8 Add a Table of Contents to your wiki page
58 1 Amber Herold
59
If your wiki page is long with multiple headings, you may want a table of contents.
60
61
{{toc}} adds it to the left hand side of your page.
62
63
{{>toc}} adds it to the right hand side.