[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gforge-commits] gforge/docs/docbook/docbook/user_guide/project_functio
|
From: |
gsmet |
|
Subject: |
[Gforge-commits] gforge/docs/docbook/docbook/user_guide/project_functions file_releases.xml, NONE, 1.1 docman.xml, NONE, 1.1 forums.xml, NONE, 1.1 cvs.xml, NONE, 1.1 surveys.xml, NONE, 1.1 tracker.xml, NONE, 1.1 project_summary.xml, NONE, 1.1 task_manager.xml, NONE, 1.1 news.xml, NONE, 1.1 project_admin.xml, NONE, 1.1 index.xml, NONE, 1.1 mailing_lists.xml, NONE, 1.1 |
|
Date: |
Tue, 02 Mar 2004 10:58:43 -0600 |
Update of
/cvsroot/gforge/gforge/docs/docbook/docbook/user_guide/project_functions
In directory
db.perdue.net:/tmp/cvs-serv22607/docs/docbook/docbook/user_guide/project_functions
Added Files:
file_releases.xml docman.xml forums.xml cvs.xml surveys.xml
tracker.xml project_summary.xml task_manager.xml news.xml
project_admin.xml index.xml mailing_lists.xml
Log Message:
converted doc from Maven xdoc to XML Docbook
--- NEW FILE: file_releases.xml ---
<?xml version="1.0"?>
<section id="ug_project_file_releases">
<title>File Releases</title>
<section>
<title>Introduction</title>
<para>
The File Releases System (FRS) is used to upload files
to the gforge site and to make these files available to the users in an easy
and efficient way.
</para>
<para>
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.
</para>
</section>
<section>
<title>Administration</title>
<para>
The FRS system allows you to upload file to gforge and
make this file available to the public.
</para>
<para>
You have to define a package before you can release a
file. A package should have a descriptive name for the project, e.g. gforge3.
</para>
<para>
To add a new package, insert a package name in the
textbox at the bottom of the page and click Create this Package.
</para>
<para>
Your package will appear in the Releases list at the
bottom of the page.
</para>
<para>
Click Add release. The form has the following fields:
</para>
<variablelist>
<varlistentry>
<term>Package ID</term>
<listitem>
<para>You can select here the
package.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Release Name</term>
<listitem>
<para>Insert here the name of your
release. The name should be indicative for the version of your file, e.g.
pre-8.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Release Date</term>
<listitem>
<para>The Release Date.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>File Name</term>
<listitem>
<para>Click the browse button to select
the file to upload. In some browsers you must select the file in the
file-upload dialogo and click OK. Double-clicking doesn't register the
file.</para>
<note>
<para>You can't upload file
that exceed the UploadFile Limit in php.ini.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>File Type</term>
<listitem>
<para>You can select here the file type
(.zip, .html, .exe, .tar.gz, etc).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Processor Type</term>
<listitem>
<para>You can select here the processor
required to run the application.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Release Notes</term>
<listitem>
<para>The release notes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Changelog</term>
<listitem>
<para>The changelog.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Click the Release File button. Your file will now
appire in the list of files in the File section.
</para>
</section>
</section>
--- NEW FILE: docman.xml ---
<section id="ug_project_docman">
<title>Document Manager</title>
<para>
The Document Manager provided with Gforge gives you a simple
way to publish documents on the site.
</para>
<section>
<title>Submit new documentation</title>
<para>
Here you can submit new documents for
approving/publishing on the site. The form requires you to insert the following
information:
</para>
<variablelist>
<varlistentry>
<term>Document Title</term>
<listitem>
<para>The document title refers to the
relatively brief title of th document</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description</term>
<listitem>
<para>A brief description to be placed
just under the title.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Upload File</term>
<listitem>
<para>Here you should select the file
to be uploaded. You can upload text files (.html, .txt) or binary files (.zip,
.doc, .pdf).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Language</term>
<listitem>
<para>You should select here the
language of the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Group that document belongs in</term>
<listitem>
<para>You should select here the group
of the document.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Fill in all the fields, select the group from the drop
down list and click <guimenuitem>Submit Information</guimenuitem>. The document
will then be placed in the <guimenuitem>Pending Submissions</guimenuitem>
section of the <guimenuitem>DocManager Admin</guimenuitem> page, to be approved
or rejected.
</para>
</section>
<section>
<title>Viewing existing docs</title>
<para>
The viewing existing docs shows you a list of documents
published and approved for viewing; grouped by Document groups. You can click
on a document to view the entire content.
</para>
</section>
<section>
<title>Admin Doc</title>
<para>
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.
</para>
<para>
The Admin section allows you to:
</para>
<variablelist>
<varlistentry>
<term>Approve/publish pending submissions</term>
<listitem>
<para>The Pendig 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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Edit Documents</term>
<listitem>
<para>The Edit Document links shows all
states of the documents, and the documents in the state:</para>
<variablelist>
<varlistentry>
<term>Active
Documents</term>
<listitem>
<para>Active
Documents are displayed in the View Documentation list</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Pending
Documents</term>
<listitem>
<para>Pending
Documents are waiting for your approval.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Hidden
Documents</term>
<listitem>
<para>Hidden
documents are not displayed</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Deleted
Documents</term>
<listitem>
<para>Deleted
Documents are old, outdated documents.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Private
Documents</term>
<listitem>
<para>Private
documents are displayed only for members of the project</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>Edit Document Groups</term>
<listitem>
<para>
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 classes
as you wish - eg Howto, Release notes, FAQ, etc. These groups will be the
catagories the documents will fall into when users submit documents.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Edit Document</title>
<para>
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.
</para>
<para>
If the Document is a text file with .txt, .html or .htm
extension, a textbox appreas where you can edit the content of the document.
</para>
<para>
If the Document is a binary document, you can upload a
new version of the document.
</para>
</section>
</section>
--- NEW FILE: forums.xml ---
<section id="ug_project_forums">
<title>Forums</title>
<para>
Every project can have his own discussion forums. When a new
project is created, 3 forums are automatically created:
</para>
<variablelist>
<varlistentry>
<term>Open Discussion</term>
<listitem>
<para>A place where to discuss about
everything.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Help</term>
<listitem>
<para>A forum where to ask for help.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Developers</term>
<listitem>
<para>A place where developers discuss about
developments.</para>
</listitem>
</varlistentry>
</variablelist>
<section>
<title>Creating a new forum</title>
<para>
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 and if
anonymous posts are allowed on the forum.
</para>
<para>
Public forums are visibile only to project members. If
Anonymous posts are enabled, everybody can post messages to the forum, even
users that are not logged it.
</para>
<para>
You can also insert an email address where all posts
will be sent.
</para>
</section>
<section>
<title>Using the forum</title>
<para>
When you click on the name of the forum, you go to the
detail of the forum.
</para>
<para>
You can select the following types of visualization for
the forum lists:
</para>
<variablelist>
<varlistentry>
<term>Nested</term>
<listitem>
<para>Shows the messages ordered by
thread. All data of the message, including the posted message itself will be
visualized.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Flat</term>
<listitem>
<para>Similar to Nested, the messages
will be showed in cronological order.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Threaded</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Ultimate</term>
<listitem>
<para>Shows only the <quote>topic
started</quote> messages. Topic starters are the messages that starts a new
thread.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
You can select the number of messages for every page:
25, 50, 75 or 100.
</para>
</section>
<section>
<title>Available options</title>
<para>
The forums of gforge have 2 very powerful options:
</para>
<variablelist>
<varlistentry>
<term>Save place</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Monitor forum</term>
<listitem>
<para>You can select to monitor the
forum by clicking on the Monitor Forum button.</para>
<para>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 beeing logged on to gforge. The name of the
monitored forum will appear in the users homepage in the section Monitored
Forums.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Forum admin</title>
<para>
Clicking on the <guimenuitem>Forum Admin</guimenuitem>
link presents you with links to <guimenuitem>Add Forum, Delete
Message</guimenuitem> or <guimenuitem>Update Forum Info/Status</guimenuitem>.
</para>
<section>
<title>Add Forum</title>
<para>
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).
</para>
</section>
<section>
<title>Delete Message</title>
<para>
This allows you to delete a message (and any
followups) from a forum. You <emphasis>must</emphasis> know the message id of
the message you wish to remove. This can be obtained by viewing the message in
the forums web page and noting the message id of the message.
</para>
</section>
<section>
<title>Update Forum Info/Status</title>
<para>
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.
</para>
</section>
</section>
<section>
<title>Searching</title>
<para>
When using a forum, a voice
<guimenuitem>Forum</guimenuitem> will appear in the search combo box. Selecting
forum and inserting a text in the search box allows you to search through the
text data of the forum.
</para>
</section>
</section>
--- NEW FILE: cvs.xml ---
<section id="ug_project_cvs">
<title>CVS</title>
<para>
The CVS button shows a page that contains information on how to
access the CVS repository. Use this information to configure your client for
CVS access.
</para>
<para>
The Browse CVS Repository link opens the viewcvs web interface,
where you can view the CVS repository, view differences between revisions,
download versions of a file.
</para>
<note>
<para>
Only public projects will show the browse CVS
repository link.
</para>
</note>
</section>
--- NEW FILE: surveys.xml ---
<section id="ug_project_surveys">
<title>Surveys</title>
<section>
<title>Introduction</title>
<para>
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:
</para>
<orderedlist>
<listitem><para>User feedback: ask users if they like
your project</para></listitem>
<listitem><para>Developer feedback: ask developers on
new features to be implemented</para></listitem>
</orderedlist>
<para>
Of course, surveys are not limited to this list.
Basically, you can ask everything you want with surveys.
</para>
</section>
<section>
<title>Administering survey questions</title>
<para>
Before you can add/modify existing surveys, you need to
administer the questions for your surveys. Questions are global for all surveys.
</para>
<para>
Gforge surveys handle the following question types:
</para>
<orderedlist>
<listitem>
<para>Radio Buttons 1-5: This type of question
shows 5 radio buttons where the user can select between 1 (low) and 5
(high).</para>
<para>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)</para>
</listitem>
<listitem><para>Radio Buttons Yes/No. This type of
question allows only two choices: Yes or No.</para></listitem>
<listitem><para>Comment Only</para></listitem>
<listitem><para>Text field: This type of question
allows the user to insert some text in a text field.</para></listitem>
<listitem><para>Text area: This type of question allows
the user to insert some text in a textarea</para></listitem>
</orderedlist>
<para>
When inserting new questions or modifying existing
questions, take note of the ID of the question. You'll need them when
creating/modifying surveys.
</para>
</section>
<section>
<title>Creating a new survey</title>
<para>
You can create a new survey by clicking on the
<guimenuitem>Admin</guimenuitem> link and then <guimenuitem>Add a new
survey</guimenuitem>.
</para>
<para>You'll be asked to insert the following data:</para>
<variablelist>
<varlistentry>
<term>Survey name</term>
<listitem>
<para>The name of the survey</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Survey name</term>
<listitem>
<para>The name of the survey</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Question list</term>
<listitem>
<para>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.</para>
<warning>
<para>Don't insert spaces or
any other character between the numbers.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term>Active</term>
<listitem>
<para>This flag indicates if the survey
is active or not.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Modifying a survey</title>
<para>
You can modify an existing survey, although this is not
recommended if answers to the survey have already been given.
</para>
<para>
You should know that the results of a survey ar not
consistent if you modify the survey and users have already inserted answers.
</para>
</section>
<section>
<title>Viewing survey results</title>
<para>
You can view the results of the surveys cliccking on
the <guimenuitem>View Results</guimenuitem> tab.
</para>
</section>
</section>
--- NEW FILE: tracker.xml ---
<section id="ug_project_tracker">
<title>Tracker</title>
<section>
<title>What is the Tracker?</title>
<para>
The Tracker is a generic system where you can store
items like bugs, feature requests, patch submissions, etc.
</para>
<para>
In previous versions of the software, these items were
handled in separate software modules. Bugs, Enhancement Requests, Support
Requests and Patches handle the same type of data, so it was logical to create
an unique software module that can handle this types of data. New types of
trackers can be created when needed, e.g. Test Results, meeting minutes, etc.
</para>
<para>
You can use this system to track virtually any kind of
data, with each tracker having separate user, group, category, and permission
lists. You can also easily move items between trackers when needed.
</para>
<para>
Trackers are referred to as <quote>Artifact
Types</quote> and individual pieces of data are <quote>Artifacts</quote>.
<quote>Bugs</quote> might be an Artifact Type, whiles a bug report would be an
Artifact. You can create as many Artifact Types as you want, but remember you
need to set up categories, groups, and permission for each type, which can get
time-consuming.
</para>
<para>
When a project is created, gforge creates automatically
4 trackers:
</para>
<variablelist>
<varlistentry>
<term>Bugs</term>
<listitem>
<para>Used for Bug tracking</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Support Requests</term>
<listitem>
<para>Users can insert here support
requests and receive support</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Patches</term>
<listitem>
<para>Developers can upload here
patches to the software</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Feature Requests</term>
<listitem>
<para>Requests for enhancements of the
software should be posted here</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Using a Tracker</title>
<para>
The following descriptions can be applied to any of the
trackers. The functionalities between the different trackers are the same,
we'll use the Bugs Tracker as example to describe the functionality of all
trackers.
</para>
<para>
The Tracker provides the following functions:
</para>
<orderedlist>
<listitem><para>Submitting a new item</para></listitem>
<listitem><para>Browsing of Items</para></listitem>
<listitem><para>Reporting</para></listitem>
<listitem><para>Administration</para></listitem>
</orderedlist>
</section>
<section>
<title>Submitting a new Bug</title>
<para>
To submit a new bug, click on the <guimenuitem>Submit
New</guimenuitem> link. A form will be displayed, where you can insert/select
the following data:
</para>
<variablelist>
<varlistentry>
<term>Category</term>
<listitem>
<para>The Category is generally used to
describe the function/module in which the bug appears. E.g for gforge, this
might be the items <quote>User Login</quote>, <quote>File releases</quote>,
<quote>Forums</quote>, <quote>Tracker</quote>, etc.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Group</term>
<listitem>
<para>The Category can be used to
describe the version of the software or the gravity of the bug. E.g
<quote>3.0pre7</quote>, <quote>3.0pre8</quote> in case of version or
<quote>Fatal error</quote>, <quote>Non-fatal error</quote> in case of
gravity.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Assigned To</term>
<listitem>
<para>You can assign the item to a
user. Only users which are <quote>Technicians</quote> are listed here.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Priority</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Summary</term>
<listitem>
<para>Give a short description of the
bug, e.g. Logout function gives an SQL Error</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Detailed Description</term>
<listitem>
<para>Insert the most detailed
description possible.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>File upload</term>
<listitem>
<para>You can also upload a file as an
attachment to the bug. This can be used to attach a screenshot with the error
and the log file of the application.</para>
<para>To upload the file, Check the
checkbox, select a file using the Browse button and insert a file
description.</para>
<note>
<para>Attachments to tracker
items can be maximal 256KB.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Browse Bugs</title>
<para>
The Browse page shows the list of bugs. You can select
to filter the bugs by Assignee, Status, Category or Group.
</para>
<para>
You can sort the items by ID, Priority, Summary, Open
Date, Close Date, Submittere, Assignee and the Ordering (Ascending, descending).
</para>
<para>
The different colors indicate the different priorities
of the bug; a * near the open date indicates that the request is more than 30
days old. The overdue time (default 30 days) is configurabel for each tracker.
</para>
<para>
When you click on the summary, you go to the
detail/modify Bug page.
</para>
</section>
<section>
<title>Modify Bugs</title>
<para>
In the modify Bug page, you can modify the data you
inserted, and also add the following information:
</para>
<variablelist>
<varlistentry>
<term>Data Type</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Status</term>
<listitem>
<para>The status indicates the status
of the item. When an item is inserted, it is created in the <quote>Open</quote>
state. When you fix a bug, you should change the state to
<quote>Closed</quote>. When a bug is duplicated or not valid, change it to
<quote>Deleted</quote>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Resolution</term>
<listitem>
<para>This indicates the resolution of
the item.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Canned Responses</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The Changelog on the bottom of the page shows in
cronological order the changes applied to the item. Also all followups can be
viewed.
</para>
</section>
<section>
<title>Monitor Bugs</title>
<para>
If you select the <guibutton>Monitor</guibutton> button
on the top left of the Bug detail page, bug monitoring will be enabled.
</para>
<para>
When you are monitoring a bug, every change to the bug
will be sent to you by email.
</para>
<para>
To disable bug monitoring, simply reselect the
<guibutton>Monitor</guibutton> button.
</para>
</section>
<section>
<title>Admin Tracker</title>
<para>
If you are an Administrator of the tracker, you can add
or change bug groups, categories, canned responses:
</para>
<variablelist>
<varlistentry>
<term>Add/Update Categories</term>
<listitem>
<para>You can add new categories or
change the name of existing categories.</para>
<para>You can also select a user in the
Auto-Assign To combo box; every bug with this category will be auto-assigned to
the selected user. This feature can save you lots of time when administering
the tracker.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Add/Update Groups</term>
<listitem>
<para>You can add new groups or change
the name of existing groups.It is not recommended that you change the group
name because other things are dependent upon it. When you change the group
name, all related items will be changed to the new name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Add Update Canned Responses</term>
<listitem>
<para>Canned responses are predefined
responses. Creating useful generic messages can save you a lot of time when
handling common requests.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Add Update Users and Permissions</term>
<listitem>
<para>You can add new users to the
tracker or delete users from the tracker.</para>
<variablelist>
<varlistentry>
<term>-</term>
<listitem>
<para>The user
has no specific permission on the tracker; he cannot administer the tracker, no
items can be assigned to the user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Technician</term>
<listitem>
<para>Items can
be assigned to the user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Administrator and
Technician</term>
<listitem>
<para>The user
is both an Administrator and also a Technician.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Administrator</term>
<listitem>
<para>User can
administer the tracker (add user, set permissions, create/update groups,
categories, canned responses).</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>Update preferences</term>
<listitem>
<para>Here you can update the following
information on the tracker:</para>
<variablelist>
<varlistentry>
<term>Name</term>
<listitem>
<para>The name
of the Tracker. This is the name displayed in the tracker list, e.g. Bug
Submittions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description</term>
<listitem>
<para>The
descriptions of the Tracker. E.g. This is the tracker dedicated to the Bugs of
the project</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Publicly
Available</term>
<listitem>
<para>By
default, this checkbox is not enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Allow
non-logged-in postings</term>
<listitem>
<para>If this
checkbox is enabled, also non logged-in users can post items to the tracker. If
this checkbox is not enabled, only logged in users can post items.</para>
<para>By
default, this checkbox is not enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Display the
<quote>Resolution</quote> box</term>
<listitem>
<para>By
default, this checkbox is not enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Send email on new
submission to address</term>
<listitem>
<para>All new
items be sent to the address inserted in the text box.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Send email on all
changes</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Days still
considered overdue</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Days till pending
tracker items time out</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Free form text
for the <guimenuitem>submit new item</guimenuitem> page</term>
<listitem>
<para>This
allows you to put a specific introduction on the <guimenuitem>submit new
item</guimenuitem> page.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Free form text
for the <guimenuitem>browse items</guimenuitem> page</term>
<listitem>
<para>This
allows you to put a specific introduction on the <guimenuitem>Browse
items</guimenuitem> page.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Mass Update</title>
<para>
If you are an Administrator of the tracker, you are
also enabled for the Mass Update function.
</para>
<para>
This function is visible in the browse bug page and
allows you to update the following information:
</para>
<orderedlist>
<listitem><para>Category</para></listitem>
<listitem><para>Group</para></listitem>
<listitem><para>Priority</para></listitem>
<listitem><para>Resolution</para></listitem>
<listitem><para>Assignee</para></listitem>
<listitem><para>Status</para></listitem>
<listitem><para>Canned Response</para></listitem>
</orderedlist>
<para>
When this function is enabled, a checkbox will appear
at the left side of each bug 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.
</para>
<para>
All bugs will be modified with these new value(s). This
function is very useful if you need to change the same information for more
bugs; e.g. assigning 5 bugs to one developer or closing 10 bugs.
</para>
</section>
<section>
<title>Reporting</title>
<para>
The reporting functions allows to check the life-span
of the Bug. The lifespan is the duration of the bug; it starts when the bug is
inserted (opened) in the tracker and ends when the bug is closed.
</para>
<variablelist>
<varlistentry>
<term>Aging Report</term>
<listitem>
<para>The Aging report shows the
turnaround time for closed bugs, the number of bugs inserted and the number of
bugs still open.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Bugs by Technician</term>
<listitem>
<para>The Bugs by Tecnician report
shows for every member of the project: the number of bugs assigned to the user,
the number of closed bugs and the number of bugs still open.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Bugs by Category</term>
<listitem>
<para>The Bugs by Category report shows
for every Category: the number of bugs inserted, the number of closed and the
number of open bugs</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Bugs by Group</term>
<listitem>
<para>The Bugs by Group report shows
for every Group: the number of bugs inserted, the number of closed and the
number of open bugs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Bugs by Resolution</term>
<listitem>
<para>The Bugs by Resolution report
shows for every type of Resolution (Fixed, invalid, later, etc): the number of
bugs inserted, the number of closed and the number of open bugs.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Searching for bugs</title>
<para>
When using a tracker, a voice with the name of the
tracker will appear in the search combo box. The search will be done on the
description, summary, the username of the submitter and the username of the
assignee.
</para>
</section>
</section>
--- NEW FILE: project_summary.xml ---
<section id="ug_project_project_summary">
<title>Project Summary</title>
<para>
The project summary shows summarized information about the
current project. The following information is displayed:
</para>
<variablelist>
<varlistentry>
<term>Project description and statistics</term>
<listitem>
<para>Description of the project and some
statistics about it</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Project administrators and members</term>
<listitem>
<para>List of the developers involved in the
project</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Latest file releases</term>
<listitem>
<para>Latest file releases published via the
FRS.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Public areas</term>
<listitem>
<para>For each Tool of Gforge, Summary
Information is displayed; e.g. Public Forums (1 message in 1 forums), Bugs (4
open, 12 total).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>News</term>
<listitem>
<para>Latest news of the project.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
--- NEW FILE: task_manager.xml ---
<section id="ug_project_task_manager">
<title>Task Manager</title>
<para>
The Task Manager is similar to the tracker, with the following
differences:
</para>
<itemizedlist>
<listitem><para>you can insert the start date of the
item</para></listitem>
<listitem><para>you can insert the end date of the
item</para></listitem>
<listitem><para>you can insert the number of hours for the
item</para></listitem>
<listitem><para>you can have multiple assignees for the
item</para></listitem>
<listitem><para>you can handle dependencies between
tasks</para></listitem>
</itemizedlist>
<para>
Tasks are organized in subprojects. Before inserting a new
task, you must first create a subproject. You can use the
<guimenuitem>Admin</guimenuitem> link to create new subprojects.
</para>
<para>
Tasks allows you to create and manage tasks, or blocks of work,
similar to the way projects are broken down in eg MS Project.
</para>
<section>
<title>Inserting a new Task</title>
<para>
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.
</para>
<para>
You need to select first a subproject from the
subproject list and then select the <guimenuitem>Add Task</guimenuitem> link.
</para>
<para>
A form appears, where you are requested to insert the
following data:
</para>
<variablelist>
<varlistentry>
<term>Percent Complete</term>
<listitem>
<para>You can select here the
Percentage of the completion of the work.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Priority</term>
<listitem>
<para>You can select here the priority
of the task.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Task Summary</term>
<listitem>
<para>You should insert a brief
description of the task.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Task Details</term>
<listitem>
<para>You should insert here the most
detailed description possibile of the task.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Start Date</term>
<listitem>
<para>You can insert here the start
date.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>End Date</term>
<listitem>
<para>You can insert here the end date
of the task.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Assigned To</term>
<listitem>
<para>You can select one or more
assignees of the task. Only users which are defined as
<quote>Technicians</quote> are listed here.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dependent on task</term>
<listitem>
<para>You can select here one ore more
task upon which this task depends.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Hours</term>
<listitem>
<para>It is the estimated duration of
this task in hours.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Only Administrators can add new items on the Task
Manager; only Administrators can make changes to the task; only administrators
can close the task.
</para>
</section>
<section>
<title>My Tasks</title>
<para>It lists the tasks assigned to the user.</para>
</section>
<section>
<title>Browse Open Tasks</title>
<para>It lists all tasks in the open state.</para>
</section>
<section>
<title>Reporting</title>
<para>The Reporting is similar to the reporting section of the
Tracker.</para>
</section>
<section>
<title>Task Admin</title>
<para>
The Admin section allows you to:
</para>
<variablelist>
<varlistentry>
<term>create new subprojects</term>
<listitem>
<para>You can select if the subproject
is public (visibile to everyone) or not (visibile only to project
memebers).</para>
<para>This allows you to add a
subproject to a project, such as modules, documentation, etc.</para>
<para>Required arguments are Project
Name and description.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>update information</term>
<listitem>
<para>Here you can select if the
project is public, private or deleted (visibile to nobody) and update the name
and description of the subjproject.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
--- NEW FILE: news.xml ---
<section id="ug_project_news">
<title>News</title>
<para>
The news section allows you to insert news relative to your
project. 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 side
administrators approve the news.
</para>
<para>
News are used generally to announce software releases or to
announce significant changes in the software or milestones.
</para>
<section>
<title>Inserting a news item</title>
<para>You can insert a NewsByte by clicking on the Submit
link.</para>
<para>You can post news about your project if you are an admin
on your project.</para>
<para>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 gforge news team before they will appear
on the gforge home page.</para>
<para>You may include URLs, but not HTML in your submissions.
URLs that start with http:// are made clickable.</para>
<para>The NewsByte will go to the News Admin for approval for
publication.</para>
</section>
<section>
<title>Modifying/Approving a news item</title>
<para>You can modify or/and approva a NewsByte by clicking on
the Admin Link.</para>
<para>You can select the status of the News: Displayed or
Delete (the news will be deleted), you can insert the Subject (title) of the
newsByte and the details.</para>
</section>
</section>
--- NEW FILE: project_admin.xml ---
<section id="ug_project_project_admin">
<title>Project Administration</title>
<para>
The Project Administration section allows you to administer the
project.
</para>
<section>
<title>The Project Admin Page</title>
<para>
The Project Admin web page is where all the
administration of the project is done from. To get there, log into GForge, and
select the project from your personal page. This will bring you to the
<guimenuitem>Project Summary</guimenuitem> page.
</para>
<para>
The Project admin page is available by clicking on the
Admin tab.
</para>
<para>
Clicking here will present you with links to Admin,
User Permissions, Edit Public Info, Project History, VHOSTS, Edit/Release
Files, Post Jobs, Edit Jobs, Edit MultiMedia Data, Database Admin 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).
</para>
</section>
<section>
<title>Admin</title>
<para>
The Admin page presents the user with Misc. Project
Information, Trove Categorization, Tool Admin and Group Members.
</para>
<variablelist>
<varlistentry>
<term>Misc Project Information</term>
<listitem>
<para>This shows the Short Description
of the project and the location of the project homepage. There's also a link to
Download Your Nightly CVS Tree Tarball, but this doesn't currently work.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Trove Categorization</term>
<listitem>
<para>
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.
</para>
<para>
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 possible).
</para>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Tool Admin</term>
<listitem>
<para>This section shows the links to
the tools describes the tools listed under the Tool Admin section on the
Project Admin page.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Group Members</term>
<listitem>
<para>This displays the names of the
members in the project, and allows you to add members or delete them. To add
members simply enter their Unix Name into the box provided and press Add User.
To remove them, click on the rubbish bin to the left of their name. The Edit
Member Permissions functionality is described in the section User
Permissions.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>User Permissions</title>
<para>
This allows the project admin to set the permissions of
each member of the project. The page is self explanatory.
</para>
</section>
<section>
<title>Edit Public Info</title>
<para>
This page enables the project admin to select the
information that is visible to members of the public and 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:
</para>
<itemizedlist>
<listitem><para>Mailing Lists</para></listitem>
<listitem><para>Surveys</para></listitem>
<listitem><para>Forums</para></listitem>
<listitem><para>Project/Task Manager</para></listitem>
<listitem><para>CVS</para></listitem>
<listitem><para>pserver (CVS server with password
authentication)</para></listitem>
<listitem><para>Anonymous access to
CVS</para></listitem>
<listitem><para>News</para></listitem>
<listitem><para>Document Manager</para></listitem>
<listitem><para>FTP</para></listitem>
<listitem><para>Tracker</para></listitem>
<listitem><para>File Release System
(FRS)</para></listitem>
<listitem><para>Statistics</para></listitem>
</itemizedlist>
<para>
It is also possible to change the home page (eg, 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 GForge, pointing to the project,
and the Home Page link will point to the pages specified in the Homepage Link
field.
</para>
<para>
You can also change the descriptive group name and the
short description. If desired you can add an email address to which all Bugs,
Patches, Support Requests and Task Assignments will be sent. This could be a
Mailing list or just an email address.
</para>
</section>
<section>
<title>Project History</title>
<para>
This page presents a history of the project, so you can
see when major changes took place, eg members added/removed, Trove categories
changed etc. There is nothing that you can do here.
</para>
</section>
<section>
<title>VHosts</title>
<para>
This section allows you to handle the different virtual
hosts needed for your project. A small interface is presented where you can
add, modify or delete virtualhosts.
</para>
<note>
<para>
These virtualhosts are not created immediately,
they are created by a backend script (be sure that the backend script is
configured in your crontab).
</para>
</note>
</section>
<section>
<title>Post Jobs</title>
<para>
This allows you to post jobs for your project, so that
when non-project members visit the site, they can offer to help with the
development.
</para>
</section>
<section>
<title>Edit Jobs</title>
<para>
This allows you to edit the jobs that have been posted
for your project.
</para>
</section>
<section>
<title>Edit Multimedia data</title>
<para>
This allows you to publish screenshots of your project.
</para>
</section>
<section>
<title>Database Admin</title>
<para>
This allows you to maintain projects' databases.
</para>
</section>
<section>
<title>Stats</title>
<para>
This section shows you information about your project:
</para>
<variablelist>
<varlistentry>
<term>Usage statistics</term>
<listitem>
<para>A graph shows you for the latest
30 days the number of views/dowloads for each day.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Lifetime statistics</term>
<listitem>
<para>This stat shows you, for the
lifetime of the project, the number of visits/downloads, number of items
inserted in the tracker, number of items in the PM/Task manager</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
--- NEW FILE: index.xml ---
<section id="ug_project">
<title>Project functions</title>
<xi:include href="project_summary.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="project_admin.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="forums.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="tracker.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="mailing_lists.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="task_manager.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="docman.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="surveys.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="news.xml" xmlns:xi="http://www.w3.org/2001/XInclude";
/>
<xi:include href="cvs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; />
<xi:include href="file_releases.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"; />
</section>
--- NEW FILE: mailing_lists.xml ---
<section id="ug_project_mailing_lists">
<title>Mailing Lists</title>
<para>
This is where you will set up and administer the mailing lists
associated with the project.
</para>
<section>
<title>Admin</title>
<para>
This brings you to the Mail Admin page, where the
following options are available to you.
</para>
</section>
<section>
<title>Add Mailing List</title>
<para>
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.
</para>
</section>
<section>
<title>Administrate/Update Lists</title>
<para>
This allows you to change the description of the list,
the state of the list, and by clicking on <guimenuitem>Administrate this list
in GNU Mailman</guimenuitem> you can add members to the mailing list, set the
properties of the list, posting policies and so forth.
</para>
</section>
</section>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gforge-commits] gforge/docs/docbook/docbook/user_guide/project_functions file_releases.xml, NONE, 1.1 docman.xml, NONE, 1.1 forums.xml, NONE, 1.1 cvs.xml, NONE, 1.1 surveys.xml, NONE, 1.1 tracker.xml, NONE, 1.1 project_summary.xml, NONE, 1.1 task_manager.xml, NONE, 1.1 news.xml, NONE, 1.1 project_admin.xml, NONE, 1.1 index.xml, NONE, 1.1 mailing_lists.xml, NONE, 1.1,
gsmet <=
- Prev by Date:
[Gforge-commits] gforge/www/include/languages German.tab,1.10,1.11
- Next by Date:
[Gforge-commits] gforge/debian changelog, 1.348.2.30, 1.348.2.31 control, 1.49.2.5, 1.49.2.6
- Previous by thread:
[Gforge-commits] gforge/www/include/languages German.tab,1.10,1.11
- Next by thread:
[Gforge-commits] gforge/debian changelog, 1.348.2.30, 1.348.2.31 control, 1.49.2.5, 1.49.2.6
- Index(es):