GForge AS User Manual
Version 5.4 © 2005-2007 GForge Group, LLC – All Rights Reserved
GForge Group, L.L.C. ♦ 1200 Valley West Drive ♦ Suite 304 to 325 ♦ West Des Moines, Iowa 50266 ♦ USA Phone: 408.837.0106 ♦ www.gforgegroup.com♦ Fax: 504.910.3655
Copyright © 2005-2007, GForge Group, LLC. All rights reserved. Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. All other marks are the property of their respective owners. While this information is presented in good faith and believed to be accurate, GForge Group, LLC does not guarantee satisfactory results from reliance upon such information. Nothing contained herein is to be construed as a warranty or guarantee, express or implied, regarding the performance, merchantability, fitness or any other matter with respect to the products, nor as a recommendation to use any product or process in conflict with any patent. GForge Group, LLC reserves the right, without notice, to alter or improve the designs or specifications of the products described herein.
GForge User Manual ii ©2007 GForge Group, L.L.C. Table of Contents
Table of Contents
Section 1 – Introduction to GForge...... 1-1 1.1 GForge Modules...... 1-2 1.1.1 Professional Services ...... 1-2 1.2 Registering a New GForge User ...... 1-3 1.2.1 Adding a New User...... 1-5 1.2.2 Logging In and Out of GForge ...... 1-7 1.3 Contacting GForge Group...... 1-11 Section 2 – Home...... 2-1 2.1 Getting Started...... 2-2 2.2 Translations ...... 2-2 2.3 Eclipse, Visual Studio, MS Project Plugins, and Documentation...... 2-2 2.4 Running a Public Website or OSS Project ...... 2-2 2.5 Recent News...... 2-2 2.6 Activity...... 2-2 2.7 Recently Registered Projects...... 2-3 2.8 Top Project Downloads...... 2-3 2.9 Support and Docs...... 2-3 2.10 Site Search...... 2-4 Section 3 – My Stuff...... 3-1 3.1 My Queue...... 3-1 3.1.1 Adding Tracker Items to Your My Queue...... 3-1 3.1.2 Deleting Tracker Items From Your My Queue...... 3-2 3.1.3 Saving Your Tracker Items in My Queue...... 3-2 3.2 My Stuff Tracker Items and Projects ...... 3-2 3.2.1 Assigned Tracker Items Tab...... 3-2 3.2.2 Submitted Tracker Items Tab ...... 3-3 3.2.3 Projects Tab ...... 3-4 3.3 My Account...... 3-5 3.4 Change Password...... 3-6 3.5 Change E-Mail...... 3-7 3.6 Plugins...... 3-7 3.6.1 Edit SSH Keys ...... 3-8 3.7 Register Project...... 3-8 3.8 Monitoring...... 3-11 3.9 Dashboard...... 3-12 3.10 Activity...... 3-13 3.11 Gantt View...... 3-14 3.12 Monitored Forums ...... 3-15 3.13 User Wiki...... 3-16 3.14 Files...... 3-16 3.14.1 Adding a New User File ...... 3-17 3.14.2 Deleting a User File...... 3-18
GForge User Manual iii ©2007 GForge Group, L.L.C. Table of Contents
Section 4 – Users...... 4-1 4.1 User Summary...... 4-2 4.2 User Projects...... 4-2 4.3 User Wiki ...... 4-3 4.4 Files ...... 4-3 Section 5 – Projects ...... 5-1 5.1 Trove Categorization...... 5-2 Section 6 – Snippets ...... 6-1 6.1 Viewing Code Snippets...... 6-2 6.2 Adding a New Code Snippet...... 6-3 6.3 Editing a Code Snippet...... 6-5 6.4 Deleting a Code Snippet...... 6-6 Section 7 – Project Summary...... 7-1 7.1 Recent News...... 7-1 7.2 Activity...... 7-2 7.3 Description ...... 7-2 7.4 Developer Info...... 7-2 7.5 Project Hierarchy...... 7-2 7.6 Trove Categorization...... 7-2 7.7 Request to Join a Project ...... 7-2 Section 8 – Reporting...... 8-1 8.1 Project Development Roadmap Report...... 8-1 8.1.1 Using the Development Roadmap Report ...... 8-2 8.2 Project Activity Report...... 8-2 8.3 Project Page Views Report...... 8-3 8.4 Tracker Report...... 8-4 8.5 Time Tracking Report ...... 8-5 8.6 Downloads Report...... 8-8 8.7 CruiseControl Build Report...... 8-10 8.8 Commits Report ...... 8-11 Section 9 – Search ...... 9-1 Section 10 – Forums...... 10-1 10.1 Using a Forum...... 10-2 10.1.1 Changing the Number of Forums to View ...... 10-3 10.1.2 Starting a New Thread...... 10-3 10.1.3 Viewing Forums as Flat Files or as Threaded ...... 10-4 10.1.4 Viewing a Forum...... 10-5 10.1.5 Replying to a Forum Thread...... 10-5 10.1.6 Editing a Forum Thread...... 10-5 10.1.7 Deleting a Forum Message Thread...... 10-5 10.2 Monitoring a Forum...... 10-6 10.2.1 Stopping a Forum Monitor ...... 10-6 10.3 Archive...... 10-7 10.4 Save Place...... 10-7
GForge User Manual iv ©2007 GForge Group, L.L.C. Table of Contents
Section 11 – Tracker ...... 11-1 11.1 Viewing Tracker Items Assigned to You...... 11-2 11.2 Viewing Tracker Items in a Project and the Summary...... 11-3 11.3 Adding a New Tracker Item ...... 11-4 11.4 Editing a Tracker Item ...... 11-5 11.4.1 Messages Tab ...... 11-8 11.4.2 Files Tab ...... 11-8 11.4.3 Changes Tab ...... 11-9 11.4.4 Commits Tab ...... 11-10 11.4.5 Dependencies Tab ...... 11-10 11.4.6 Duplicates Tab...... 11-11 11.4.7 Associations Tab ...... 11-12 11.4.8 Time Tracking Tab...... 11-13 11.5 Moving a Tracker Issue or Task ...... 11-14 11.6 Deleting a Tracker Item ...... 11-15 11.7 Cloning a Tracker Item ...... 11-15 11.8 Merging a Tracker Issue or Task ...... 11-16 11.9 Tracker Query...... 11-16 11.9.1 Adding a Tracker Query...... 11-17 11.9.2 Editing a Tracker Query ...... 11-19 11.9.3 Running a Tracker Query ...... 11-19 11.9.4 Deleting a Tracker Query ...... 11-19 11.9.5 Exporting a Tracker Query...... 11-19 11.10 E-Mail Gateway...... 11-20 11.11 Monitoring a Tracker...... 11-21 11.11.1 Stopping Tracker Monitor ...... 11-21 11.12 Tracker Workflow Rules...... 11-21 11.13 Mass Updating Fields in Tracker...... 11-22 Section 12 – Document Manager...... 12-1 12.1 Viewing Existing Documents ...... 12-1 12.1.1 Viewing Historical Document Details...... 12-2 12.1.2 Versions Tab...... 12-2 12.1.3 Associations Tab ...... 12-3 12.2 Adding a New Document...... 12-4 12.2.1 Submitting a New Version of a Document...... 12-5 12.3 Monitoring a Document...... 12-5 12.3.1 Stopping a Document Monitor ...... 12-5 Section 13 – News...... 13-1 13.1 Viewing News Articles...... 13-2 13.1.1 Start New Thread...... 13-2 13.2 Monitoring News...... 13-3 13.2.1 Stopping a News Article Monitor...... 13-3
GForge User Manual v ©2007 GForge Group, L.L.C. Table of Contents
Section 14 – Files ...... 14-1 14.1 Viewing a File Package ...... 14-1 14.1.1 Notes Tab...... 14-2 14.1.2 Changes Tab ...... 14-2 14.1.3 Files Tab ...... 14-3 14.1.4 Associated Tracker Items Tab ...... 14-3 14.1.5 Associations Tab ...... 14-4 14.1.6 Monitoring a File Package...... 14-5 14.1.7 Stopping File Package Monitoring...... 14-5 Section 15 – Mailing Lists...... 15-1 15.1 Subscribing to a Mailing List...... 15-1 15.2 Viewing the List...... 15-4 15.3 Viewing the List Archive...... 15-5 15.4 Posting to a List ...... 15-6 15.5 Visiting a Subscriber List...... 15-7 15.6 Unsubscribing from a List ...... 15-7 15.7 Lost Mailing List Password ...... 15-8 15.8 Editing Your List Membership Configuration...... 15-8 15.8.1 Viewing your Mailing List Subscriptions ...... 15-12 15.9 Viewing All Mailing Lists ...... 15-13 Section 16 – SVN (Subversion) ...... 16-1 16.1 Access Info...... 16-2 16.2 Browsing the SVN Repository...... 16-2 16.3 Statistics ...... 16-3 16.4 Linking a Commit to a Tracker Item ...... 16-3 Section 17 – CVS (Concurrent Versioning System)...... 17-1 17.1 Access Info...... 17-2 17.2 Browsing the CVS Repository...... 17-3 17.3 Statistics ...... 17-3 17.4 Linking a Commit to a Tracker Item ...... 17-4 17.5 CVS over SSH for Linux ...... 17-4 17.5.1 Configuring CVS over SSH for Linux ...... 17-4 17.5.2 Testing CVS over SSH for Linux...... 17-7 17.5.3 Checking Out a File using SSH...... 17-8 17.5.4 Committing the File using SSH to CVS...... 17-10 Section 18 – CruiseControl ...... 18-1 18.1 Viewing Build History...... 18-2 Section 19 – Visual Studio Add-in ...... 19-1 Section 20 – Eclipse Add-in...... 20-1 Section 21 – MS Project...... 21-1 21.1 Reassigning a Task in MS Project to another GForge User ...... 21-3 21.1.1 Remapping a Resource ...... 21-4
GForge User Manual vi ©2007 GForge Group, L.L.C. Table of Contents
Section 22 – ClearCase ...... 22-1 22.1 Access Info...... 22-1 Section 23 – Visual Source Safe ...... 23-1 23.1 Access Info...... 23-1 Section 24 – Perforce ...... 24-1 24.1 Access Info...... 24-1 24.2 Linking a Commit to a Tracker Item ...... 24-2 Section 25 – Wiki...... 25-1 25.1 Associations ...... 25-3 25.1.1 Adding a Wiki Association...... 25-3 25.1.2 Deleting a Wiki Association...... 25-4 25.2 Wiki Versions...... 25-4 25.2.1 Adding a New Version ...... 25-4 25.2.2 Viewing Differences between Wiki Versions ...... 25-4 25.3 Monitoring a Wiki Page...... 25-5 25.3.1 Stopping a Wiki Page Monitor ...... 25-5 Index...... I-1
GForge User Manual vii ©2007 GForge Group, L.L.C. Introduction to GForge
Section 1 – Introduction to GForge
GForge assists in the management of the entire development life cycle using Collaborative Development Environment (CDE) tools to assist your team in working together, using message forums and mailing lists, including tools to create and control access to Source Code Management (SCM) repositories. GForge automatically creates a repository and controls access to it depending on the role security settings of the Project.
GForge allows you to organize and manage any number of software development Projects. GForge is perfect for managing large teams of software engineers even when they are scattered among multiple geographical locations.
GForge is used by thousands of companies and government agencies around the world. Because GForge ensures proven reliability, ease of use, and global penetration, it is an excellent choice whenever an organization needs to manage a software Project of any size. With the trend towards distributed and offshore development, GForge is uniquely positioned to provide coordination and support to this new development paradigm. Refer to Figure 1-1.
Figure 1-1. GForge Modules
GForge User Manual 1-1 ©2007 GForge Group, L.L.C. Introduction to GForge
1.1 GForge Modules Additional GForge modules include: ♦ Home page with overall GForge information. ♦ Personal user’s My Stuff detailing your Projects. ♦ Project Summary Tree detailing Projects. ♦ Site wide Search capabilities for users, Projects, and binary searches within MS Word and PDF documents. ♦ Code Snippets for reuse of previously developed code. ♦ Forums for group interaction. ♦ Issue Tracker with “unlimited” numbers of categories, text fields, and such. ♦ Task management via the Trackers. ♦ Reporting detailing, time, Trackers, Project activity, pages vied per day, downloads, commits, and builds. ♦ Mailing Lists provided via a GForge version of GNU Mailman. ♦ Document Management. ♦ News announcements. ♦ Files uploaded and each version. ♦ Wiki allows everyone to collaborate on the content and modify the pages created by the Project Administrator. ♦ Source Code Management (SCM) to check in and out code for Perforce, Visual Safe Source, Clear Case, CVS (Concurrent Versioning System), and Subversion (SVN). ♦ Manage File Releases for each build of the Project.
1.1.1 Professional Services The GForge Project is supported and maintained by the GForge Group including: ♦ Installations – The CDE system depends on multiple different software components. We can install GForge more completely and less expensively than your staff. ♦ Customer Maintenance and Support – We offer second-level support and upgrades to your GForge installation. ♦ On-line Training – GForge Learning Services provides Macromedia Flash-based on-line training that is available 24 hours a day, 7 days a week. This allows you to learn based on your schedule and at your pace. All of the videos are narrated. ♦ Integration Solutions – The GForge Group can integrate CDE into your existing development process and corporate network, such as Timberbox, Mozillza, WebDav, and XML SOAP API. ♦ Development of Customized Solutions – The GForge Group can customize the CDE faster and cleaner than other organizations, ensuring that you will not get trapped in a hacked version of GForge that cannot be upgraded. ♦ Lightweight Directory Access Protocol (LDAP) – Administrator authentication for network integration.
GForge User Manual 1-2 ©2007 GForge Group, L.L.C. Introduction to GForge
♦ Appliances – The GForge Appliances can be plugged into your network to provide an instant collaboration environment. Collaboration station plug and play servers can include your CDE site pre-installed and pre-configured to your specifications. ♦ Hosting Services – GForge can host your CDE solutions at a minimal cost. Refer to GForge Group Professional Services at www.gforge.org for additional information.
1.2 Registering a New GForge User There are two possibilities when registering a new user. Registration is dependent on whether Lightweight Directory Access Protocol (LDAP) authentication is implemented for network integration. User registration includes: ♦ Non-LDAP User Registration – Typical non-corporate user. Requires filling out the New Account Registration form, responding to confirmation e-mail, and logging in. ♦ LDAP User Registration – Typical corporate user. Login and account creation automatically occurs without e-mail confirmation. To register a new GForge user: 1. Connect to the Internet. 2. Launch your browser. 3. Enter the hostname of your server in the URL Address field of your browser and click
Figure 1-2. Register new account
The Add New User screen displays with your user data fields. Refer to Figure 1-5 on page 1-5. 5. Enter your information. Fields marked with an asterisks (*) are required. Refer to Registering a New GForge User on page 1-3. 6. Click the Submit button. Note: GForge requires pop-ups to be enabled.
GForge User Manual 1-3 ©2007 GForge Group, L.L.C. Introduction to GForge
Figure 1-3. New Account E-mail Confirmation