• No results found

ACOS Forge 1.3 User Guide

N/A
N/A
Protected

Academic year: 2021

Share "ACOS Forge 1.3 User Guide"

Copied!
45
0
0

Loading.... (view fulltext now)

Full text

(1)

ACOS Forge 1.3 User Guide

Abstract

Table 1.

Classification:

USER GUIDE

Alcatel-Lucent Community Of Sharing

ACOS Forge

Reference:

3DN 01003 0026 TCZZA VALIDATED

Edition:

3

Date:

2009-12-11

Appraisal Authority

Company Alcatel-Lucent/CPG/CTO

Function Product Manager

Name Alain Giraud

Originator

Company Alcatel-Lucent/CPG/CTO

Function Development Manager

(2)

ACOS Forge 1.3 User Guide

Revision History

Revision 1.1 13 Mar 2009 A. Peyrat, M-E Vargenau Internal version for review of ACOS Forge 1.3-M1

Revision 01 26 Mar 2009 A. Peyrat, M-E Vargenau Validated edition, changes from internal review

Revision 2.1 6 May 2009 A. Peyrat, M-E Vargenau Internal version for review of ACOS Forge 1.3

Revision 02 18 May 2009 A. Peyrat

Validated edition, changes from internal review

Revision 3 18 September 2009 A. Peyrat

(3)
(4)

Table of Contents

... 1

1. Introduction ... 1

2. Getting Started ... 2

2.1. Forge homepage ... 2

2.2. Registering as a new user ... 2

2.3. Registering a new project ... 3

2.4. Login ... 3

2.5. Logout ... 4

2.6. Listing and Selecting Public Projects ... 4

3. User specific functions ... 4

3.1. User Homepage ... 4

3.2. Modifying User settings ... 5

3.3. Changing the language ... 5

3.4. Diary and Notes ... 5

3.5. User Profile ... 5 4. Project functions ... 5 4.1. Project Summary ... 5 4.2. Project Activity ... 6 4.3. Project Admin ... 6 4.4. Forums ... 9 4.5. Tracker ... 12 4.6. Mailing Lists ... 18 4.7. Task Manager ... 19 4.8. Documents ... 21 4.9. Surveys ... 23 4.10. News ... 24 4.11. Source Code ... 25

4.12. File Release System ... 25

4.13. Wiki ... 28

4.14. Blocks ... 28

5. Site-wide functions ... 30

5.1. Introduction ... 30

5.2. Searching in the site ... 30

5.3. Projects ... 30

6. Extensions ... 31

6.1. Sharing working documents (Webdav workspace) ... 31

6.2. Creating a homepage for the project website ... 37

7. Extensions ... 37

7.1. Software Configuration Management (SCM) ... 37

(5)

List of Tables

(6)

1. Introduction

This manual is available as a a pdf document [user_guide.pdf] for offline reading or printing or as an online help using the 'GET HELP' link located or the top right corner of each pages.

The manual is divided in 6 chapters: Chapter 1. Introduction

This chapter introduces the document. Chapter 2. Getting Started

This chapter explains how to register as a new user, how to register a new project, how to login and how to logout.

Chapter 3. User specific functions

This chapter describes the functions that are relative to the user's section.

This section describes the user's homepage, how to modify user settings, how to handle user ratings, skill profiles and Diary and Notes.

Chapter 4. Project specific functions

This chapter explains the project specific functions. Project Summary

This section describes the Project Summary page for your project. Project Administration

This section describes the Administration of the project. The Project Administrator function is accessible only to the Project Administrators.

Forums

This section describes the use and administration of the Discussion Forums. Tracker

This section describes how to use the Tracker to track bugs, patches, support requests. Mailing Lists

This section describes the creation or maintenance of mailing lists for your project. Task Manager

This section describes how to use the Task Manager to track activities. Documents

This section describes the Document Manager. Surveys

This section describes how to set up Surveys for your project. News

This section describes how to add and release News for your project. Subversion

This section describes how to manage Subversion repositories for your project. File release System

This section describes how to publish new releases of your project. Wiki

(7)

Blocks

This section describes how to use HTML blocks to customize the appearance of project pages. Chapter 5. Site-wide functions

This chapter explains how to register as a new user, how to register a new project, how to login and how to logout.

Trove Map

This section describes the Project Classification System. Chapter 6. Extensions

This chapter explains how to register as a new user, how to register a new project, how to login and how to logout.

Software Configuration Management (SCM)

This section describes how to perform synchronisation between Clearcase and the SCM tool used (Subversion).

Changes and defects Tracking

This section describes how to perform synchronisation between IBM ClearDDTS and the tracker system used.

Sharing working documents (Webdav workspace)

This section describes how to share working documents between project members. Creating a homepage for the project website

This section describes how to create a simple website to present your project

2. Getting Started

2.1. Forge homepage

Start your browser and type the main forge URL to access the site. The main page should look like the following image.

(8)

Accounts are normally taken from an LDAP directory so you do not need to ask for the creation of your account on the forge, the creation is automatic as the application is open to every people registered in the LDAP directory.

Note

Alcatel-Lucent employees should use their CSL username and password.

This Users Guide is written in English, so links and buttons names are in English. Depending on the configuration of your computer or Web browser, you might see them in your own language. See section Changing the language of this Users Guide if your want to change the language.

2.3. Registering a new project

To register a new project, login and go to My Page section. You have a Register Project link in the menu at the top of the page.

You need to insert the following information to register a project: Project Full Name

The Name of the Project: eg. My Master project Project Purpose and Summarization

A brief summary of the Project License

You must select a License for your software. This field is required if your software is or includes a Free and Open Source Software.

Project Public Description

Insert a description of the Project. This description will appear in the Project Summary page Project Unix Name

Insert here the Unix name of your project. This name must respect the following rules: 1. it cannot match the Unix name of any other project

2. its length must be between 3 and 15 characters

3. only lowercase letters, numbers and dashes are accepted

The Unix name will be used for your website, mailing lists, email alerts, and the Subversion repository.

Note

The Unix name will never change. Once a project is set up with its Unix name, the name cannot be changed.

Click on the I agree button to register the project. Your project is now registered; but you cannot yet access it. It has to be approved from the site administrators.

When the project is approved, you'll receive an email confirming that the project is active.

2.4. Login

(9)

The form requires that you insert your login and password to access the site. If the data is correct, the user homepage will be displayed.

You should also note that your login/password is also requested for non-browser access (like for Webdav, Subversion or SOAP).

Note

When using Webdav, Subversion or SOAP, you should always use SSL access (by replacing http: with https:), this will ensure that all the transmitted information will be kept secret (including your login/password).

2.5. Logout

To log out, click on the Logout link on the top right of your browser window.

2.6. Listing and Selecting Public Projects

All publicly-available projects are listed in alphabetical order in the Jump to Project select box. To go to a particular project, just select it in the list and you will be transported to the project home page.

You can also go to the Project Tree section and select the Project List link.

3. User specific functions

3.1. User Homepage

The User home page appears after the user has performed the login or when he clicks the My Page tab. The User Homepage contains a 4 links and 5 tabs.

The four links are the following: • My Personal Page

• Diary & Notes • Account Maintenance • Register Project

The five tabs contain the following information: Assigned Artifacts

This list shows the Tracker items assigned to you. Only items in the open state will be listed here. Clicking on the number of the item, you'll go to the detail of the item. The items are ordered by priority.

Assigned Tasks

This list shows the Tasks items assigned to you. Only tasks in the open state will be listed here. Clicking on the task name, you'll go to the detail of the task. The tasks are ordered by subproject. Submitted Artifacts

This list shows the Tracker items submitted by you. Only items in the open state will be listed here. Clicking on the number of the item, you'll go to the detail of the item. The Tracker items are ordered by tracker.

(10)

Monitored Items

This list shows the Items you are monitoring. It shows the Tackers that are monitored globally, the News, the Forums and the FileModules you are monitoring. See the sections about Forums and FileModules for more details on how monitoring works.

Projects

This list shows you the active projects you are participating. When you click on a project, you will go to the project summary.

3.2. Modifying User settings

When you click on Account Maintenance on your user homepage, you get a page where you can change some data you inserted. You can change every data you inserted when you registered as user except: • Registration date (Member since)

• User Id • Login name

3.3. Changing the language

You have two possibilities:

1. If you want to change the language for your account, then go to My Page -> Account Maintenance and then, select <your language> as language. And submit.

2. If you want to change your language when not logged, then it's defined in the configuration of your browser. You should see a preferred list of language somewhere.

Note

Only English is officially supported.

3.4. Diary and Notes

The Diary and Notes section allows you to simulate a basic agenda. You can insert a subject and a description of the item and select if the item is public or private.

If the item is public, every user can view and monitor this item.

3.5. User Profile

It is also possible to view Personal Information of a user by clicking on its name in various place of the application.

This page gives information like the username, the e-mail address and the phone number. It gives also the list of projects the user is member of.

4. Project functions

4.1. Project Summary

The project summary shows summarized information about the current project. The following information is displayed:

Project description and statistics

(11)

Project administrators and members

List of the developers involved in the project Latest file releases (if any)

Latest file releases published via the File Release System. If no files have been released, this information is not displayed.

Public areas

For each tool, Summary Information is displayed; e.g. Public Forums (7 messages in 2 forums), Bugs (4 open, 12 total).

Latest News

Latest news of the project.

4.2. Project Activity

The project activity displays information about the current project activity.

You have to select an activity, a start date and an end date. Then click the Submit button. The list of corresponding activities will be displayed.

4.3. Project Admin

The Project Admin section allows you to administer the project. It is available by clicking on the Project Admin tab.

The Project Admin page is where all the administration of the project is done from. To get there, log in and select the project from your personal page. This will bring you to the Project Admin page. You are presented you with links to Project Info, Users, Tools, Project History and Stats. The Project Admin page is only accessible to members of the project who have been granted administrator privileges. By default, the person who registers the project is given admin privileges. Other members can be granted admin rights by the project administrator(s).

4.3.1. The Project Info Page

The Project Info page presents the user with Project Name, Short Description, Tags, Trove Categorization, Home Page Link and New Document Submissions e-mail address.

It is also possible to change the home page (e.g., it is possible to set up a Web page on another machine, which has other information). In this case, the summary page will remain on the site, pointing to the project, and the Home Page link will point to the pages specified in the Homepage Link field. You can also change the descriptive project name, the short description and the list of comma separated tags (or keywords) that describes your project.

Descriptive Project Name

This shows the name of the project. Short Description

This description is displayed on top of the summary page of the project. Tags

This shows the list of defined tags entered to describe the project. The list of currently used tags by the other project is directly accessible with the "Projects" link .

Trove Categorization

In order for people to be able to find the project, it must be classified in the Trove Map. This is basically a set of categories in which like projects are grouped.

(12)

Clicking on Edit Trove Categorization presets a page which allows you to select the category(s) to which the project belongs (select as many as needed).

Clicking Submit All Category Changes will set the categorizations, and you will be returned to the Project Admin page. You can change the trove categorizations during the lifetime of the project by following the above steps, as the project moves through its life.

Homepage Link

Enter the URL of the homepage of the project if the project has a website located on another server. This URL can also be an internal URL like a wiki page.

New Document Submissions

Enter one or several e-mail addresses to be notified for new document submissions and updates in the Documents tool.

4.3.2. The Users Page

Add User

This allows the project admin to add users in the project. Type a name or part of a name and click the Search button. Click the Add User button next to the user you want to add. Select a role in the menu and click the Add User button.

Another way is to send an invitation message with the "Request to Join" URL. Edit Roles

This allows the project admin to edit existing roles in the project and create new ones. Note that you create as many roles as you want but a user can only associated to one role only.

For each activated features like forums, trackers, you can define the access type like No access, Read, Write and Admin. For Subversion and WebDAV access, it is also possible using the 'Configuration using ACL' link to create finer access control per directories.

A special role, named 'Observer' is dedicated to define access rights for non members. Configuration using ACL (via Edit Roles)

For sources (Subversion repository) and WebDAV space, it is possible to create ACL (Access Control Lists) rules to specify per directory (or per file) which roles can access the given ressource.

The rule on path '/' is implicit and taken from the values set in Edit Roles. Authenticated users and Anonymous users are taken from the Observer role.

Note

The thing to remember is that the most specific path always matches first. The server tries to match the path itself, and then the parent of the path, then the parent of that, and so on. The net effect is that creating a rule for a specific path will always override any permissions inherited from parent directories.

For the WebDAV space, a rule on path '/www' is created by default when the project is created to provide a default place to store Web files for a project website. See ' Sharing working documents (Webdav workspace) ' and ' Creating a homepage for the project website ' for more informations.

(13)

Project Members

This displays the names of the members in the project, and allow to configure access rights of the members by associating for each member a defined role (see Edit Roles for more). To remove a user for the member of the project, click on the 'Remove' button next to his name.

For each role, it is possible to define the access rights per tool and depending on the tool, per items (per forum or per packages for example).

4.3.3. The Tools Page

4.3.3.1. Active Features

This page enables the project admin to select the information that is visible to the public and to the members of the project. It is possible to select the utilities that are used by the project, so that any that are not desired are not presented on the Web page. Specifically it is possible to disable/enable: • Forums

• Trackers • Mailing Lists

(14)

• Task Manager • Documents • Surveys • News • Source Code • File Release System • Statistics

• HTML Editor • Wiki

• Blocks

• Source Code and Mailing List Integration • Source Code and Tracker Integration

4.3.3.2. Tool Admin

This section shows the links to the Tool Admin pages for the active tools.

4.3.4. Project History

This page presents a history of the project, so you can see when major changes took place, e.g. members added/removed, Trove categories changed etc. There is nothing that you can do here.

4.3.5. Stats

This section shows you information about your project activity. You can select:

• Areas: tracker, forums, docs, tasks, downloads, page views; • Type: daily, weekly, monthly;

• Start; • End.

4.4. Forums

Every project can have its own discussion forums. When a new project is created, 3 forums are automatically created:

Open Discussion

A place where to discuss about everything. Help

A forum where to ask for help. Developers

(15)

4.4.1. Creating a new forum

New forums can be created using the Admin section of the forum. When a new forum is created, you must insert a name of the forum, the description of the forum, select if the forum is public or private, if anonymous posts are allowed on the forum and select if the associated email for posting by mail will be accessible externally (on Internet).

Private forums are visible only to project members. If Anonymous posts are enabled, everybody can post messages to the forum, even users that are not logged in.

You can also insert a comma seperated list of email addresses where all posts will be sent. If you want to give access to this forum to external users, then use this field to let them receive posted messages.

Note

If you allow external users to receive message from a forum, you have to set the external flag on this forum. This adds a warning message on top of the forum to warn users that potentially, external users may receive the message.

4.4.2. Using the forum

When you click on the name of the forum, you go to the detail of the forum.

4.4.2.1. Selecting visualization mode

You can select the following types of visualization for the forum lists: Nested

Shows the messages ordered by thread. All data of the message, including the posted message itself will be visualized.

Flat

Similar to Nested, the messages will be showed in chronological order. Threaded

Shows only title, author and date of each message. Shows the messages in threaded order. Clicking on the title of the message the entire message will be displayed.

Ultimate

Shows only the “topic started” messages. Topic starters are the messages that starts a new thread. You can select the number of messages for every page: 25, 50, 75 or 100.

4.4.2.2. Writing a message

Note

You can use the plain text editor or the enhanced editor to compose your messages. The enhanced editor is available if the HTML editor plugin was enabled by project administrators.

You can start a new thread by clicking on Start New Thread link.

You can write a message in an existing thread by clicking on the Reply link of an existing message. In both cases, the enhanced editor is available to compose the message. Use the tool bar to format your message.

(16)

You can also post and reply to a message by email. To post a message, you have to send an email to <name of forum>@<hostname of the site>. The subject of the message will be used as summary and the body will be used as core of message.

4.4.2.3. Moving a thread

If you have admin rights on the forums, you can move move the whole thread from one forum to another.

4.4.2.4. Adding a file to a message

You can add a file to an existing message by clicking on the Add icon. Only one file can be attached to a given message. If you add another file, the first one will be deleted.

The file must not be an executable file (.exe) and must not exceed a certain size.

4.4.3. Available options

The forums have 2 very powerful options: Save place

This function registers the number of messages already inserted in the forum and will highlight new messages the next time you return to the forum.

Monitor forum

You can select to monitor the forum by clicking on the Monitor Forum button.

If this option is enabled, every post to the forum will be sent to you by email. This allows you to be informed about new messages without being logged. The name of the monitored forum will appear in the users homepage in the section Monitored Forums.

4.4.4. Forum admin

Clicking on the Forum Admin link presents you with links to Add Forum and Manage Pending Messages.

Under these links, you have a list of the forums, with for each forum a link Monitoring Users. Clicking on this link will give the list of users that monitor this forum.

4.4.4.1. Add Forum

This allows you to add a new discussion forum. You can select if it is public or private (only members of the project can see it).

4.4.4.2. Manage Pending Messages

This allows you to accept or reject messages posted to a moderated forum.

4.4.4.3. Delete Message

To delete a message (and any followups) from a forum, just display the message and click on the Saint Andrew cross. A confirmation is required.

4.4.4.4. Adjust Forum Features

To adjust forum features, click on the forum name in the forum list. This allows you to alter the properties of the forum such as the name and description, whether or not anonymous posts are allowed, if it's public and you can enter an address to which all messages are posted.

(17)

To configure forum moderation level, click on the forum name in the forum list. This allows you to select the moderation level between the following values:

• No Moderation.

• Moderated Level 1: To moderate anonymous posts (if allowed in public forum) and posts from non-member users.

• Moderated Level 2: To moderate all posts (except admin posts).

4.4.5. Searching

When inside a forum, by default, a search (using the upper top search box) will be restricted to the current forum. You can change if you want to enlarge the search to all forums or all the tools of the project.

4.5. Tracker

4.5.1. What is the Tracker?

The Tracker is a generic system where you can store items like bugs, feature requests, patch submissions, etc.

You can use this system to track virtually any kind of data, with each tracker having separate user, fields, and permission lists. You can also easily move items between trackers when needed.

Trackers are referred to as “Artifact Types” and individual pieces of data are “Artifacts” . “Bugs” might be an Artifact Type, while a bug report would be an Artifact. You can create as many Artifact Types as you want, but remember you need to set up permission for each type, which can get time-consuming. When a project is created, 4 trackers are automatically created by default:

Bugs

Used for Bug tracking Support Requests

Users can insert here support requests and receive support Patches

Developers can upload here patches to the software Feature Requests

Requests for enhancements of the software should be posted here

4.5.2. Using a Tracker

The Tracker provides the following functions: 1. Browsing of Items

2. Downloading CSV file 3. Submitting a new item 4. Reporting

5. Monitoring 6. Administration

(18)

The Browse page shows the list of artifacts.

Using the 'Simple Filtering and Sorting' tab, you can define some simple filtering (on assignee and state), and sorting (by id, priority, summary, open date, close date, submitter and assignee) and select the Ordering (ascending, descending).

The different colors indicate the different priorities of the artifact; a * near the open date indicates that the request is more than 30 days old. The overdue time (default 30 days) is configurable for each tracker.

When you click on the id or summary, you go to the detail/modify artifact page.

4.5.4. Submitting an Artifact

To submit an artifact, click on the Submit New link. A form will be displayed, where you can insert/ select the following data:

Assigned To

You can assign the item to a user. Only users which are “Technicians” are listed here. Priority

You can select the Priority of the item. In the Browse list, and the homepage of the users, priorities are displayed in different colors, and can be ordered by priority.

Summary

Give a short description of the artifact, e.g. Logout function gives an SQL Error Detailed Description

Insert the most detailed description possible. Attach Files

You can also attach files to the artifact. This can be used to add a screenshot with the error and the log file of the application.

To attach files, select files using the Browse button. You can upload up to 5 files at a time. Attachments to tracker items can be no larger than 10MB.

Note

The Tracker supports the following syntax when entering a description or a comment: http:, https: or ftp:

Will be automatically changed in hyperlinks. [#NNN]

To reference id NNN in the trackers (even outside current project). [TNNN]

To reference id NNN in the tasks (even outside current project). [wiki:<pagename>]

To reference page 'pagename' in the project's wiki. [forum:<msg_id>]

To reference post msg_id in the project's forums.

When the user is not logged, he will still be proposed to submit new artifacts. If the Tracker allows anonymous posting, he will be able to post without logging in. If the Tracker does not allow anonymous posting, clicking on the Submit New link will prompt the user with the login banner.

(19)

4.5.5. Build Queries

Queries allow you to display a subset of artifacts corresponding to certain criteria. For example, you can create a query listing only opened artifacts on component A for release v1.0.

Using the 'Advanced queries' tab, you can create, run and save private queries allowing filtering on any defined fields.

Several types of queries are possible: Private

Query defined for personal use. Project level query

Query proposed to all users. Only tracker admins can create or update a project level query. Default project query

Default query proposed to all users.

4.5.6. Modify Artifacts

In the modify artifact page, you can modify the data you inserted, and also add the following information:

Data Type

This combo box lists the trackers of the project. If you select a different tracker and submit the changes, the item will be reassigned to the selected tracker.

Status

The status indicates the status of the item. When an item is inserted, it is created in the “Open” state. When you fix a bug, you should change the state to “Closed” .

Followups

Comments can be added to submitted artifacts (see supported syntax in section "Submitting an Artifact").

Canned Responses

Canned responses are prefixed responses. You can create canned responses for your project in the admin section and select the responses in the combo box.

The Changelog on the bottom of the page shows in chronological order the changes applied to the item. Also all followups can be viewed.

4.5.7. Monitor Artifacts

You can choose to monitor a tracker as a whole, or only individual tracker entries.

4.5.7.1. Monitoring an entire tracker

Go to the tracker page and select Monitor link.

To stop monitoring the tracker, select Stop Monitor link.

4.5.7.2. Monitoring tracker entries

If you select the Monitor button on the top left of the artifact detail page, artifact monitoring will be enabled.

(20)

To disable artifact monitoring, simply select the Stop Monitoring button.

4.5.8. Admin Tracker

If you are an Administrator of the tracker, you can add or change custom fields and canned responses: Manage Custom Fields

You can add new fields or change the name of ones.

You can select the type of box (select box, check box, radio button, text field, multi-select box, status and relation between artifacts) and the possible values. For each custom fields, you can define if the value is required or not and for each custom fields of type select-box, you can add and reorder values.

You can also change the default layout for the custom fields in the trackers by downloading an HTML template (see link: Download default template and Download current template), updating the template with an editor and after uploading the template (see link: Add/Update template).

Note

Be careful, modifying the template requires some skills in HTML. It is also recommended to use a text editor and not an HTML editor as the HTML code represents only a part of a page and not a whole page. The HTML template represents a part of the two columns table so keeping the table format is mandatory or the whole page layout may be broken.

Manage Workflow

You can create a workflow on a status custom field. Creating a workflow allows to configure the initial values possible (when an item is submitted), to configure the allowed transitions and define which roles are allowed to perform each allowed transitions.

The following example shows a status custom field created with 4 possible states (Submitted, Open, Closed, Aborted). When a new ticket will be created, the only possible value will be 'Submitted' and several rules has been defined. For example, from a the Submitted state, it is possible to change to 'Open' or 'Aborted' but not to 'Closed'.

And, for each rule, it is possible to define the roles which will be allowed to change the state. For example, in the following example, only members of the roles: 'Admin' and 'Core Developer' will be allowed to change an artifact from 'Open' to 'Closed'.

(21)

Add Update Canned Responses

Canned responses are predefined responses. Creating useful generic messages can save you a lot of time when handling common requests.

Update preferences

Here you can update the following information on the tracker: Name

The name of the Tracker. This is the name displayed in the tracker list, e.g. Bug Submissions. Description

The description of the Tracker. E.g. This is the tracker dedicated to the Bugs of the project Send email on new submission to address

All new items will be sent to the address inserted in the text box. Send email on all changes

If this checkbox is enabled, all changes on the items will be sent out via email. It is useful to check this radiobutton only if in the Send email address is inserted an email address. Days still considered overdue

Days till pending tracker items time out Free form text for the Submit new item page

This allows you to put a specific introduction on the submit new item page. Free form text for the Browse items page

This allows you to put a specific introduction on the Browse items page.

4.5.9. Mass Update

If you are an Administrator of the tracker, you are also enabled for the Mass Update function. This function is visible in the browse artifact page and allows you to update the following information: 1. Priority

2. Assignee 3. Status

4. Canned Response

When this function is enabled, a checkbox will appear at the left side of each artifact id. You can check one or more of the ids, select one or more of the values in the Mass Update combo boxes and click Mass Update.

All selected artifacts will be modified with these new value(s). This function is very useful if you need to change the same information for more artifacts; e.g. assigning 5 artifacts to one developer or closing 10 artifacts.

This function allow to update all selected box fields, not only mandatory fields but also custom fields.

(22)

The reporting functions allows to check the life-span of the Artifact. The lifespan is the duration of the artifact; it starts when the artifact is inserted (opened) in the tracker and ends when the artifact is closed. • By assignee

• Response time

4.5.11. Searching for artifacts

When using a tracker, the name of the tracker will appear in the search combo box. The search will be done on the description, the summary, the username of the submitter and the username of the assignee.

4.5.12. Adding a comment to a tracker by e-mail

When a user receives an e-mail about a tracker, he can add add a comment to this tracker by replying to this e-mail.

Note

The e-mail reply must use plain text format. An HTML e-mail will lead to an error message.

4.5.13. Managing trackers via CLI using Gforge CLI (PHP

Command-Line Interface)

We give here some basic examples of CLI commands. For more information, please consult the Command-line interface (CLI) documentation in the package.

4.5.13.1. Logging in with CLI

gforge.php -v login --username=<login> --project=myproject

4.5.13.2. Getting the list of tracker entries via CLI

Use CLI to get the tracker id for a given project

gforge.php tracker typelist

Use CLI to get the list all artifacts for a given project

gforge.php tracker list --type=xxx

4.5.13.3. Creating a tracker entry via CLI

The following command is displayed on two lines but should be entered as one single line.

gforge.php tracker add --type=xxx --priority=4 --summary="New bug" --details="This is a brand new bug"

4.5.13.4. Updating a tracker entry via CLI

The following commands are displayed on two lines but should be entered as one single line.

gforge.php tracker update --type=xxx --id=yyyy --priority=5 --summary="New summary" --details="New details"

You can include a Custom Field, e.g. Group

gforge.php tracker update --type=xxx --id=yyyy --priority=5 --summary="New summary" --group=zzzz

(23)

4.5.14. Managing trackers via CLI using Gforge java CLI (Java

Command-Line Interface)

We give here some basic examples of CLI commands. For more information, please consult the Gforge Java Command-line interface (CLI) documentation in the package.

4.5.14.1. Getting the list of tracker entries via CLI

Use CLI to get the tracker name for a given project:

DumpTracker.bat -u "my login" -p mypassword -g project_name -t tracker_name

You can use DumpTracker.sh on Unix/Linux.

4.5.14.2. Creating a tracker entry via CLI

Write <tracker_name>_create.csv file with field's names on the 1st line and bug's values on the next line.

CreateTracker.bat -u "my login" -p mypassword -g project_name -t tracker_name

You can use CreateTracker.sh on Unix/Linux.

4.5.14.3. Updating a tracker entry via CLI

Write <tracker_name>_update.csv file with field's names on the 1st line and bug's values on the next line.

UpdateTracker.bat -u "my login" -p mypassword -g project_name -t tracker_name

You can use UpdateTracker.sh on Unix/Linux.

4.6. Mailing Lists

This is where you will set up and administer the mailing lists associated with the project.

Note

The members management in the mailing lists tool is independant from the user management in the rest of the application. The login used is the email address and the password is the one entered when subscribing.

4.6.1. Main page

This page shows the list of available mailing lists.

Clicking on List Name Archives will allow you to browse the archives of the selected mailing list. You can subscribe, unsubscribe or edit your preferences for a specific mailing list by clicking the appropriate link.

There is a special mailing list named '<project>-commits' which is populated by all the commits performed in Subversion. By simply registering to this mailing list, any user can be informed of the SCM activity on the project.

4.6.2. Admin

(24)

Add Mailing List

Clicking here will allow you to create a new mailing list. You can specify if it is to be made public (people who are not members of the project can see and/or join it) or not. You can also add a description of the list. You will receive an email with the administration password of the list. Administrate/Update Lists

This allows you to change the description of the list, the state of the list, and by clicking on Administrate this list in GNU Mailman you can add members to the mailing list, set the properties of the list, posting policies and so forth.

Delete a Mailing List

This allows you to permanently delete a mailing list.

Select the Update link of the list. Then click on the Permanently Delete List link.

4.6.3. Search in mailing lists

It is possible to perform a search on all the messages stored in the mailing lists. The search will be done on the author, subject, and the content of the messages.

Note that the indexing of these mailing lists is performed only once a day.

Note

Binary attachements are currently not indexed.

4.7. Task Manager

The Task Manager is similar to the tracker, with the following differences: • you can insert the start date of the item

• you can insert the end date of the item

• you can insert the number of hours for the item • you can have multiple assignees for the item • you can handle dependencies between tasks

Tasks are organized in subprojects. Before inserting a new task, you must first create a subproject. You can use the Admin link to create new subprojects.

Tasks allows you to create and manage tasks, or blocks of work, similar to the way projects are broken down in e.g. Microsoft Project.

4.7.1. Inserting a new Task

This allows you to add tasks to the sub projects - e.g. Write Design Doc, Review Doc, Update Doc, Write Code, Review Code, Update Code, Test, Log Test Results, etc. They can be assigned to members of the team, and start and end dates set up for them, dependencies on other tasks set, percentage completion etc.

You need to select first a subproject from the subproject list and then select the Add Task link. A form appears, where you are requested to insert the following data:

Category

(25)

Percent Complete

You can select here the Percentage of the completion of the work. Priority

You can select here the priority of the task. Task Summary (mandatory)

You should insert a brief description of the task. Task Details (mandatory)

You should insert here the most detailed description possible of the task. Estimated Hours (mandatory)

It is the estimated duration of this task in hours. Start Date

You can insert here the start date. End Date

You can insert here the end date of the task. Assigned To

You can select one or more assignees of the task. Only users which are defined as “Technicians” are listed here.

Dependent on task

You can select here one ore more task upon which this task depends.

Only Administrators can add new items on the Task Manager; only Administrators can make changes to the task; only administrators can close the task.

4.7.2. Assigned Tasks

Assigned Tasks, available in My Page, lists the tasks assigned to the user.

4.7.3. Gantt Chart

The Gantt chart gives a graphical representation of the tasks. Here is an example a generated Gantt chart.

4.7.4. Task Admin

The Admin section allows you to: Add a project

You can select if the subproject is public (visibile to everyone) or not (visibile only to project members).

This allows you to add a subproject to a project, such as modules, documentation, etc. Required arguments are Project Name and description.

Update information

Here you can select if the project is public, private or deleted (visible to nobody) and update the name and description of the subproject.

(26)

Register an e-mail address for notification of tasks

Fill the 'Send All Updates To:' box with an e-mail address. Add/Edit Categories

Categories can be used to group or filter tasks. Permanently delete this subproject and all its data.

This link allows to drop the subproject and all the associated tasks.

4.8. Documents

The Documents tool provided gives you a simple way to publish documents on the site.

4.8.1. Submit new documentation

Here you can submit new documents for approving/publishing on the site. Only project members can submit new documents.

The form requires you to insert the following information: Document Title

The document title refers to the relatively brief title of the document Document Part Number

The Part Number of the document Document Edition

The edition number of the document (examples: 1.1 or 1.2 or 1 or 2) Document Status

The status of the document. If the document is a working document, then it's 'IN PREPARATION', if the document is nearly completion (review), it's 'PROPOSAL' and if the document if validated, then set 'VALIDATED'.

Description

A brief description to be placed just under the title. Upload File, URL, Editor

Here you have three tabs, allowing three different ways to provide the document. See below for more information.

Language

You should select here the language of the document. Group that document belongs in

You should select here the group of the document. This feature is used to categorize documents. You have three ways to provide the document. Select the tab that fits your needs.

Upload File

Here you should select the file to be uploaded. You can upload text files (.html, .txt) or binary files (.zip, .doc, .pdf).

URL

Here you can specify the URL where the document is located. Editor

Here you should specify a file name, then type (or paste) the content of the document. You are presented a text area, or the HTML editor if it has been activated in your project.

(27)

Fill in all the fields, select the group from the drop down list and click Submit Information. The document will then be placed in the Pending Submissions section of the DocManager Admin page, to be approved or rejected.

4.8.2. Viewing documents

The View Documentation page shows you a list of documents published and approved for viewing; grouped by Document groups. It is possible to view the list as a tree structure (default mode) or view all the documents at once (using the All files link). You can click on a document to view the entire content. For each document, the filename, description, edition, created by, date of last modification, size and Part Number are displayed. Recently updated document (less than 7 days) have a 'new' icon attached in front of their names.

Each group can also be referenced as URL.

4.8.3. Admin

Clicking on this will present you with a page showing pending and active documents. In order to allow users to submit a document, you must first set up the document groups for the project.

The Admin section allows you to: Approve/publish pending submissions

The Pending Submissions list shows the list of submissions that are waiting for your approval. Clicking on the document name, the Edit Document form will be displayed.

Edit Documents

The Edit Document links shows all states of the documents, and the documents in the state: Active Documents

Active Documents are displayed in the View Documentation list. Pending Documents

Pending Documents are waiting for your approval. Hidden Documents

Hidden documents are not displayed. Deleted Documents

Deleted Documents are old, outdated documents. Private Documents

Private documents are displayed only for members of the project. Edit Document Groups

Clicking on this will present you with a box and a button to add document groups, and it also shows the document groups associated with this project. Submit as many document categories as you wish - eg Howto, Release notes, FAQ, etc. These groups will be the categories the documents will fall into when users submit documents.

(28)

4.8.4. Edit Document

When you select a document from one of the lists, a form will be displayed. In this form you can change the Document Title, the Short Description, the Language, the Document Group and the State. If the Document is a text file with .txt, .html or .htm extension, a textbox appears where you can edit the content of the document.

If the Document is a binary document, you can upload a new version of the document.

4.8.5. Extensions

Some extensions have been made to improve the document manager.

See 'Sharing working documents (Webdav workspace)' for a way to share working documents between members.

See 'Creating a homepage for the project website' for a way to create some webpages for presenting your project.

4.9. Surveys

4.9.1. Introduction

Surveys allow you to ask questions to your developer/users and view the results. Surveys are often very helpful if you need some feedback from the users, examples of surveys might be:

1. User feedback: ask users if they like your project

2. Developer feedback: ask developers on new features to be implemented

Of course, surveys are not limited to this list. Basically, you can ask everything you want with surveys.

4.9.2. Administering survey questions

Before you can add/modify existing surveys, you need to administer the questions for your surveys. Questions are global for all surveys.

Surveys handle the following question types:

1. Radio Buttons 1-5: This type of question shows 5 radio buttons where the user can select between 1 (low) and 5 (high).

This is useful for indicating priorities or quality feedback (e.g.: the question might be: did you like the new xxx feature. The user can select (1 (not very much), 2,3,4, 5(really)

2. Radio Buttons Yes/No. This type of question allows only two choices: Yes or No. 3. Comment Only

4. Text field: This type of question allows the user to insert some text in a text field. 5. Text area: This type of question allows the user to insert some text in a textarea

When inserting new questions or modifying existing questions, take note of the ID of the question. You'll need them when creating/modifying surveys.

4.9.3. Creating a new survey

(29)

You'll be asked to insert the following data: Survey name

The name of the survey Question list

Here you should insert the IDs of the questions in the order they should appear. If you wish to see question 4 first, then question 6, then question 1, you should insert here 4,6,1.

Warning

Don't insert spaces or any character other than comma between the numbers. Is Active?

This flag indicates if the survey is active or not. Is Public?

This flag indicates if the survey is public or private.

4.9.4. Modifying a survey

You can modify an existing survey, although this is not recommended if answers to the survey have already been given.

You should know that the results of a survey are not consistent if you modify the survey and users have already inserted answers.

4.9.5. Viewing survey results

If you have admin rights, you can view the results of the surveys clicking on the View Results tab. You can export the survey results in a file in CSV format. This file can then be imported in a spreadsheet like Open Office Calc or Microsoft Excel.

4.10. News

The news section allows you to insert news relative to your project. A news can be monitored similar to tracker items, forums. News will be displayed on the project homepage and also on the site homepage, if the site administrators approve the news.

News are generally used to announce software releases, milestones, or significant changes in the software.

Note that it it is possible to post news related to a topic by using the Submit News link from the frontpage.

4.10.1. Inserting a news item

You can insert a news item by clicking on the Submit link.

You can post news about your project if you are an admin on your project.

All posts for your project will appear instantly on your project summary page. Posts that are of special interest to the community will have to be approved by a member of the Administration team before they will appear on the frontpage of the site.

You may include URLs in your submissions. URLs that start with http:// are made clickable. A text area is presented or an HTML editor (if activated). If text is HTML (like the one made by the HTML editor), then it will be filtered for security purpose. Remember that users may receive the

(30)

converted text of the news by email, so it is recommended to use only simple formatting and avoid writting complex news with tables or images. They will not be rendered correctly by their mail agent. The news item will go to the News Admin for approval for publication.

4.10.2. Modifying/Approving a news item

You can modify or/and approve a news by clicking on the Admin link.

You can select the status of the news: Displayed or Deleted (the news will be deleted), you can insert the Subject (title) and the details.

4.10.3. Subscribing RSS feed for project news

You can subscribe a RSS feed for project news by clicking on the RSS icon on the Summary page of the project.

4.11. Source Code

4.11.1. Introduction

The Source Code menu shows a page that contains information on how to access the Subversion repository. Use this information to configure your client for Subversion access.

The Browse Subversion Repository link opens the Subversion Web interface (WebSVN), where you can view the Subversion repository, view differences between revisions, download versions of a file.

4.11.2. Administration

Read access on the source code can be managed by the administator of the project in two ways. To configure write access, edit a role and configure the scm access.

By editing the 'Observer' Role in 'Admin', it is possible to restrict access to source code to members only, to restrict access to identified users (logged users) or to allow every one (even non identified users to access).

It's possible to set up finer-grained permissions by creating ACL (Access Control List) rules per path. See ' Configuration using ACL (via Edit Roles) ' for more.

4.12. File Release System

4.12.1. Introduction

The File Release System (FRS) is used to upload or reference files to the site and to make these files available to the users in an easy and efficient way.

Files can be divided in different packages, and every single package can be monitored by the users; these users will receive an email every time a new file has been added to the package.

4.12.2. Administration

The File Release System system allows you to upload or reference a file and make this file available to the public.

You have to define a package before you can release a file. A package should have a descriptive name for the project, e.g. wsprofile.

To add a new package, insert a package name in the textbox at the bottom of the page and click Create this Package.

(31)

You can use the radio buttons to make the package publicly viewable or not. Default is public. You can use the menu buttons to make the package active or hidden. Hidden packages will not be listed in the Files section.

Your package will appear in the Releases list at the bottom of the page. Click Add release. The form has the following fields:

Package ID

You can select here the package. Release Name

Insert here the name of your release. The name should be indicative for the version of your file, e.g. pre-8.

Release Date

The Release Date. File Name

Click the Browse button to select the file to upload. In some browsers you must select the file in the file-upload dialog and click OK. Double-clicking doesn't register the file.

Or you can also specify the URL where the file is located. In this case, the file will not be uploaded on the site but the user will be redirected to the given URL. This solution allows to reference very big files without having to upload them.

File Type

You can select here the file type (.zip, .html, .exe, .tar.gz, etc). Processor Type

You can select here the processor required to run the application. Release Notes

The release notes. Changelog

The changelog.

Click the Release File button. Your file will now appear in the list of files in the File section.

Note

To add new files in a release, you have to go in the package, select 'edit releases' and after, you will have a form to add files to the release.

4.12.3. Managing packages and releases via PHP CLI (PHP

Command-Line Interface)

We give here some basic examples of CLI commands. For more information, please consult the PHP Command-line interface (CLI) documentation in the package.

4.12.3.1. Logging in with CLI

gforge.php -v login --username="user" --project=myproject

4.12.3.2. Getting a list of releases

Get the package id

(32)

Get the list of releases of a given package

gforge.php frs releases --package=xxx

4.12.3.3. Add a release of a given package

gforge.php frs addrelease --package=xxx --name="My new release"

4.12.3.4. Edit a release

Add a text file to a release of a given package.

gforge.php frs addfile --package=xxx --release=yyy --file=zzz

Retrieve file on the standard output

gforge.php frs getfile --package=xxx --release=yyy -id=www

Retrieve file in a file

gforge.php frs getfile --package=xxx --release=yyy -id=www --output=newfile

4.12.4. Managing packages and releases via Java CLI (Java

Command-Line Interface)

We give here some basic examples of CLI commands. For more information, please consult the Java Command-line interface (CLI) documentation in the package.

4.12.4.1. Getting a list of releases

Use java client to get the package informations.

FRS.bat -u login -p password -g project -d

You can use FRS.sh on Unix/Linux.

4.12.4.2. Add a release of a given package.

FRS.bat -u login -p password -g project -k package -r release

You can use FRS.sh on Unix/Linux.

4.12.4.3. Edit a release

Add a text file to a release of a given package (the following command is displayed on two lines but should be entered as one single line).

FRS.bat -u login -p password -g project -k package -r release -n file_name -f file_path

You can use FRS.sh on Unix/Linux.

4.12.5. Monitoring packages

You can monitor a package by clicking on the envelope next to the package name. The envelope now bears a red symbol.

You can unmonitor the package by clicking again on the envelope.

(33)

You can subscribe a RSS feed for a package on the summary page of the project, by clicking on the RSS icon and select Alcatel-Lucent Forge Developer New Project Releases.

4.13. Wiki

The Wiki button gives access to a wiki which allows members of the project to collaborate on the content of this wiki.

A wiki can be used to provide a simple but powerful FAQ, or knowledge base. It can also be used as web site.

Before you can use the wiki in your project, you have to activate the corresponding plug-in. Select the Project Admin tab then Tools and check the Use Wiki Plugin box.

For more information about how to edit a wiki, just select the default pages provided by the tool. The wiki engine is based on Phpwiki (see http://sourceforge.net/projects/phpwiki/ ).

4.13.1. Available features

The following features are available:

• locking a page so that it cannot be modified, • changing ownership of a page,

• managing an ACL (Access Control List) on pages, • reverting to previous version of a page,

• removing a page, • consulting page history,

• displaying differences between versions of a page.

An important feature is the support for wiki plugins that allow to easily add dynamic content to wiki pages: table of contents, syntax highlighting...

See PluginManager to view the plugins already distributed with PhpWiki.

4.13.2. Access rights

Roles are mapped to Phpwiki roles and the default permissions are the following: • administration rights to the project administrators for all pages,

• administration rights to the author on its own pages, • edition rights for project members,

• read-only rights for non project members and non-logged users. Administration rights include the possibility to:

• change ACLs on pages, • delete pages,

• revert modifications...

(34)

4.14.1. Introduction

The Blocks plugin allows the project manager to customize the appearance of the project pages. A block is a piece of HTML that will be displayed (if active) on a predefined location. Predefined location includes: project description and a user blocks (right side) at summary page, and headers on top of each tool (trackers, forums, etc.).

In case the HTML project description block is activated, it overwrites the short project description provided in text mode (the short project description is still used in the project tree).

Note

It is not possible to create a new block.

4.14.2. Activating and modifying blocks

• The project administrator logs in and enters his project. • He clicks on the 'Admin' link to enter the administration area. • He clicks on the 'Blocks admin' link.

• He can then edit a block to change its content and also activate or deactivate a block. • Once submitted, the block is changed.

To edit the block, the HTML editor or a simple text area (showing the HTML code) will be used, depending whether the HTML editor is activated or not.

You might include images in the block as well as text.

It is a good idea to first activate the blocks you want to include, and have a look at the corresponding page before modifying them. This allows you check their placement in the page.

4.14.3. Macros

When you activate a block, a predefined content is provided. The content will use macros. For example, you might have :

{boxHeader}Enter your text here{boxFooter}

We recommend that you use these macros. Use of the macros will guarantee a consistent look and feel. You can create boxes like the ones on the right site of summary page, by inserting the following sentences in the content:

• {boxTop Hello}: will create the top part of the box using Hello as title.

• {boxMiddle Here}: will create a middle part of a box using Here as title (optional). • {boxBottom}: will create the end part of a box.

• {boxHeader}: will create a header before a text. • {boxFooter}: will create a footer after a text.

You can create as many boxes as you want, but a boxTop has to be closed by a boxBottom and a

boxHeader has to be closed by a boxFooter.

(35)

You can, for example, use the summary_right block to display your project logo.

You can use the summary_description block to provide a more complete description of your project and also links to major project resources.

HTML blocks for tools can be used to explain purpose and usage of the different tools (ex: trackers).

5. Site-wide functions

5.1. Introduction

The side-wide functions are available anytime, they are not dependent on the single projects. The site-wide functions handle data that are not relevant to a single project, as tag cloud, project tree, project list, etc.

The single site-wide functions available to the users are: • Search

• Projects

5.2. Searching in the site

You can search in the site for the following arguments: People

You can search for login name or the complete username. The search is not case sensitive. Inserted text must be at least 3 characters.

Software/Group

You can search for software groups. Inserted text must be at least 3 characters. All Site

You can search, using an external search engine on all indexed pages (public pages and public documents).

You can search for People or Software groups by selecting the item in the combo box and inserting the search text in the text box.

If the user is inside a project, he can search on all the items of the project (trackers, forums, mailing lists, tasks, releases, documents, news and wiki); he can also search on a specific item by selecting the corresponding search.

An advanced search is also provided to precise the search on a project.

5.3. Projects

The projects section displays all public projects according some criteria like license, keywords. It allows also to view all the news associated to selected projects or criteria (for project tree and tag cloud).

5.3.1. Tag Cloud

The tag cloud is a visual depiction of project tags, used to describe the content of the project. Tags are usually single words and are typically listed alphabetically, and the importance of a tag is shown with font size.

(36)

Clicking on a tag will give the list of public projects matching the tag. The most popular tags are also displayed on the frontpage of the site.

Tags are defined by project administrators using the Admin -> Edit Public Info link.

5.3.2. Project Tree

The project tree allows users to classify their projects in a tree so that they can be found more easily all projects according to a given criteria.

5.3.3. Project List

The project list display the list of all public projects defined on the forge.

5.3.4. Submit a news

Submit a news allows users to submit a news to the site directly without attaching the news to a project. In this case, the news will only be displayed in the Project Tree and on the Frontpage (if approved by the administrators).

6. Extensions

6.1. Sharing working documents (Webdav workspace)

Members of a project can share their documents using a special method called DAV (Distributed Authoring and Versioning). By this way, documents will be stored on the server and accessed remotely using the DAV protocol.

The DAV protocol provides functionality to create, change and move documents on a remote server (typically a Web server). This is useful, among other things, for authoring the documents which a Web server serves, but can also be used for general Web-based file storage, that can be accessed from anywhere. Most modern operating systems provide built-in support for WebDAV, making it easy to use files on a WebDAV server (almost) as if they were stored in a local directory.

Note

The WebDAV protocol does not support soft or hard links.

6.1.1. On Microsoft Windows

1. On Microsoft Windows, DAV folders are called "Network Places". First, locate and click on the My Network Places icon. If the icon is not visible on your desktop, open a normal windows explorer.

(37)

3. Select another network location

4. Enter your Location/URL as prepared above, and click "Next".

The URL should be https://<server>/groups/<unix_project_name>/ . Note that we are using HTTPS to secure CSL/CIP transfer.

5. Enter your CSL/CIP (login/password), and click "Next".

Check "Save this password in your password list" if you want to be able to open the Web folder shortcut without retyping your password each time. Be aware that there is some security risk involved in doing this, as anybody who has access to your computer could also access your Web folder.

(38)

6. Give your new Web Folder a name.

This is the name of the Web Folder as it will appear from now on in your Web Folders window.

(39)

8. Once configured, entering the DAV folder gives a window like this.

You can drag and drop into and out of this window just like any other window, to upload and download files.

You can also directly edit the file from the DAV folder with a DAV aware application like Microsoft Office 2000 or Open Office.

That's it!

6.1.2. On Linux

(40)

To access a DAV directory, enter the URL of the DAV resource and then the remote files will be displayed.

If you are using a DAV aware application like OpenOffice, then it is possible to edit directly the file from the explorer. If your application does not support accessing remote file, then just drag and drop the file to a local directory and then edit the copy as usual.

You can also access DAV with davfs [http://dav.sourceforge.net/] module.

6.1.2.1. Using GNOME / Nautilus

1. Select Open Location from the Menu

2. Enter the WebDAV URL

3. Enter the CSL/CIP (login/password)

(41)

6.1.2.2. Using KDE

Enter the WebDAV URL directly in the location bar but you have to write

webdavs:

instead of

https:

, so the URL should be webdavs://<server>/groups/<project>/ .

6.1.3. On other operating systems

There are a variety of options available to you.

The grimly-named Cadaver [http://webdav.org/cadaver/] is probably the best-known client for DAV; it's command-line based, but most Unix users are used to that, right? Cadaver is a Freely Available Software.

DAV Explorer [http://www.ics.uci.edu/~webdav/] is a free graphical DAV client available for Windows, Linux and Solaris. Full download and install instructions are available on the DAV Explorer site.

If you are a programmer, you might want to look at Neon [http://webdav.org/neon/] (a C library for DAV) and PerlDAV [http://webdav.org/perldav/] (a Perl library for DAV), both open-source and under development.

(42)

All of these utilities use the same procedure for connecting (with the URL, username and password) described in the Windows and Linux sections.

6.1.4. Configuring access control

It is possible to configure the access rights of the Web DAV workspace. Three access rights are provided:

• No access: the item cannot be accessed;

• Read: the item can be displayed but not modified; • Write: the item can be displayed and modified.

To modify the access rights, select the 'Admin' link then 'Edit Role'.

In 'WebDAV Repository', select the correct access rights in the menu and press 'Submit'.

Note

The 'www/' folder has a special meaning. This place was done to access documents without any authentication. So, the URL http://<server>/www/<project>/ (no authentication) is the shortcut of the full URL http://<server>/groups/<project>/www/ (with authentication according to the access control you have set in your Role settings).

6.2. Creating a homepage for the project website

The 'www/' folder in the WebDAV is accessible for read as http://<server>/www/<project> for all members and non members without authentication.

By default, the homepage for new projects points to subdirectory www of the WebDAV workspace. This makes easy for project members to edit webpages just like their other documents.

For more information about using DAV, see the previous chapter 'Sharing working documents' which details how to edit documents

Note

Only static pages are allowed. CGI or PHP are not executed. The homepage is located at:

http://<server>/www/<project>/

7. Extensions

7.1. Software Configuration Management (SCM)

The SCM tool used is Subversion, it is a simple and free tool, widely available. For more information about this tool, you can go to the main site which is at: http://subversion.tigris.org.

Instead of providing source tarballs or zip file only to the community, a free SCM tool allows every interested user to access in an efficient manner the source code without any added cost (compared to Clearcase access for example which requires an important setup).

References

Related documents