world leader in high performance signal processing
Trace: » administering_a_project

Administering a Project

Registering a New Project

In order to get a project up and running, you must be registered as a user of blackfin.uclinux.org. This is described in a previous section of this document. To register a new project, connect to your blackfin.uclinux.org My Page and then select the Register Project link.

You need to insert the following information to register a project:

  • Project Full Name

The name of the Project (e.g.” XMame Project”)

  • Project Purpose and Summarization

A brief summary of the Project.

  • License

You must select a License for your software (e.g. GNU General Public License)

  • Project Public Description

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

  • Project Unix Name

Enter here the Unix name of your project. This name must respect the following rules:

  • It cannot match the Unix name of any other project
  • Its length must be between 3 and 15 characters
  • It must be in lowercase
  • Only characters, numbers and dashes are accepted

The Unix name will be used for your project URL, the CVS Repository and the shell access for blackfin.uclinux.org.

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 on blackfin.uclinux.org; but you cannot yet access it. It has to be approved by a site administrator.

When the project is accepted, you’ll receive an email from blackfin.uclinux.org confirming the project’s name and stating that the project’s activation is pending.

  • Pending News Bytes

This section lists the News that needs to be approved by the user.

Setting up the Project

The Project Administration section allows you to administer the project. Most aspects of project administration need to be done on a continual basis, so you should not volunteer for this unless you have a few minutes every day to check to see if things need your approval.

At the beginning of a project, it can take some time to properly set things up so it is easy to navigate for end users. Please take the time to go through this section and familiarize yourself with the required setup.

The Project Admin Page

The Project Admin web page is where all the administration of the project is done from. To get there, log into SourceForge, and select the project from your personal page. This will bring you to the Project Summary page. The Project Admin page is available by clicking on the Admin tab.

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).

Admin

The Admin page presents the user with Misc. Project Information, Trove Categorization, Tool Admin, Group Members and File Releases.

  • Misc Project Information

This shows the Short Description of the project and the location of the project homepage. There is also a link to Download Your Nightly CVS Tree Tarball, although this feature is not currently available.

  • 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. Clicking on Edit Trove Categorization presents a page which allows you to select the category(s) to which the project belongs (select as many as possible). 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.

  • Tool Admin

This section shows the links to the tools being used by your project. Clicking a link from the Tool Admin section will bring you to that tools admin page.

  • Group Members

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 User Permissions section.

  • File Releases

This section allows the administrator to upload files to the website that other users can access and download.

User Permissions

This allows the project admin to set the permissions of each member of the project. In order for a member to be assign permissions the user must first be added to the project under the Admin tab. After the user is added to the project varying permissions may be assigned to the user. These permissions include:

  • Project Role: The user can be assigned numerous roles on the project from Developer to Tester.
  • Project Admin: You can assign the current user to have administrative privileges.
  • Release Technician: The user can be assigned as a Release Technician.
  • CVS Commit:
  • Tracker Manager: Assign the user to have Admin privileges on the Tracker page of the project.
  • Project/Task Manager: Assign the user to be a Technician, Admin or a Technician and Admin.
  • Forums: Assign the user to be a forum moderator.
  • Documentation Manager: Assign the user to be an Editor.
  • Trackers: Assign the user to individual Trackers or click “Add All” to assign all the current Trackers to the individual.

Edit Public Info

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 only those that are not pertinent to that project are displayed on the web page. Specifically, it is possible to disable/enable:

  • Mailing Lists
  • Surveys
  • Forums
  • Project/Task Manager
  • CVS
  • Pserver (CVS server with password authentication)
  • Anonymous Access to CVS
  • News
  • Doc Mgr
  • Ftp
  • Tracker
  • File Release System (FRS)
  • Statistics

It is also possible to change the homepage (e.g., it is possible to set up a webpage 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 Home Page link field.

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 a single email address.

Project History

This page presents a history of the project, so you can see when major changes took place, such as information on when members were added/removed, changes to Trove categories etc.

VHosts

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 virtual hosts.

Note that these virtual hosts are not created immediately, they are created by a backend script (be sure that the backend script is configured in your crontab).

Edit/Release Files

The FRS system allows you to upload a file to blackfin.uclinux.org and make the 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. ’Version 1.01’.

To add a new package, insert a package name in the textbox at the bottom of the page and click Create This Package. 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 the package here.

  • Release Name

Insert 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 of the file.

  • 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.

You can’t upload files that exceed the Upload File Limit in php.ini

  • File Type

Select here the file type (.zip, .html, .exe, .tar.gz, etc).

  • Processor Type

Select the processor required to run the application.

  • Release Notes

Notes that the uploader wants to state with the file.

  • Change Log

Describes the changes that were made between versions

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

Post Jobs

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.

Edit Jobs

This allows you to edit the jobs that have been posted for your project.

Edit Multimedia data

This allows you to publish screenshots, audio, video footage, or files from your project

Database Admin

Stats

This section shows you information about your project:

  • Usage statistics: a graph shows the number of views/downloads for each day for the past 30 days.
  • Lifetime statistics: these statistics show 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

Administrating Forums

The project administrator should check all the forums to ensure that they are set up the way they desire. In the Forums tab, clicking on the Forum Admin link presents you with links to Add Forum, Delete Message or Update Forum Info/Status.

Add Forum

When a new forum is created, you must insert a name for the forum, the description of the forum, select if the forum is public or private and if anonymous posts are allowed on the forum. Public forums are visible only to project members. If Anonymous posts are enabled, anybody can post messages to the forum, even users that are not logged in. You can also enter an email address where all posts will be sent.

Delete Message

This allows you to delete a message (and any follow-ups) from a forum. You must know the message ID of the message you wish to remove. This can be obtained by viewing the message in the forums webpage and noting the message ID of the message.

Update Forum Info/Status

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, etc. You can also enter or update an address to which all messages are posted.

Admin Tracker

If you are an Administrator of the tracker, you can add or change bug groups, categories and canned responses:

  • Add/Update Categories

You can add new categories or change the name of existing categories. You can also select a user in the Auto-Assign To combo box; thereby enabling every bug with this category to be auto-assigned to the selected user. This feature can save you lots of time when administering the tracker.

  • Add/Update Groups

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.

  • Add/Update Canned Responses

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

  • Add Update Users & Permissions

You can add new users to the tracker or delete users from the tracker. In this section you can assign the following permissions to the user:

  • -: The user has no specific permission on the tracker; he cannot administer the tracker, no items can be assigned to the user.
  • Technician: Items can be assigned to the user.
  • Administrator & Technician: The user is both an Administrator and also a Technician.
  • Administrator: The user can administer the tracker (add user, set permissions, create/update groups, categories, canned responses).
  • 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 Submitions”.
  • Description: The descriptions of the Tracker. For example, “This is the tracker dedicated to the Bugs of the project.”
  • Publicly Available: By default, this checkbox is not enabled.
  • Allow non-logged-in postings: If this checkbox is enabled, non logged-in users can post items to the tracker. If this checkbox is not enabled, only logged in users can post items. By default, this checkbox is not enabled.
  • Display the “Resolution” box: Box marking whether or not the Bug has been resolved.
  • Send email on new submission to address: All new items will be sent to the email address entered 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 radio button only if an email address is entered in the “Send Email” address field.
  • Days until considered overdue: Days until the item times out (default is 30 days).
  • Days until pending tracker items time out: Days until the item should be resolved.
  • Free form text for the “submit new item” page: Description of the item.
  • Free form text for the “browse items” page:

Mass Update

If you are an Administrator of the tracker, you are also enabled to utilize the Mass Update function.

This function is visible in the Browse Bug page and allows you to update the following information:

  • Category
  • Group
  • Priority
  • Resolution
  • Assignee
  • Status
  • Canned Response

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. All bugs will be modified with these new value(s). This function is very useful if you need to change the same information for multiple bugs; such as assigning multiple bugs to one developer or closing multiple bugs simultaneously.

Mailing Lists

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

Admin

This brings you to the Mail Admin page, where the following options are available to you.

  • 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.
  • 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, post policies and so forth.

Task Admin

The Admin section allows you to:

  • Create New Subprojects

You can select if the subproject is public (visible to everyone) or not (visible 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.

Inserting a new Task

Only Administrators can add new items, make changes, or close a task on the Task Manager.

This allows you to add tasks to the subprojects - 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, with start and end dates set up for them, dependencies on other tasks set, percentage completion etc.

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

  • Percent Complete: You can select the Percentage of the completion of the work here.
  • Priority: You can select here the priority level of the task.
  • Task Summary: You should insert a brief description of the task.
  • Task Details: You should insert the most detailed description possible of the task.
  • Start Date: You can insert the start date.
  • End Date: You can insert here the end date of the task.
  • Assigned To: You can select one or more assignees to the task. Only users which are defined as “Technicians” are listed here.
  • Dependent on task: You can select here one or more task upon which this task is dependent.
  • Hours:

Admin Doc

Clicking on this will present you with a page displaying 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 will display the Edit Document form.

  • 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 - Documents that are hidden from the publics view
    • Deleted Documents - Deleted Documents are old, outdated documents.
    • Private Documents - Documents that are viewable to users on a 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 classes as you wish - e.g. HOWTO, Release notes, FAQ, etc. These groups will be the categories the documents will fall into when users submit documents.

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.

Surveys

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:

  • User feedback: ask users if they like your project
  • Developer feedback: ask developers about new features to be implemented

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

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. blackfin.uclinux.org surveys handle the following question types:

  • 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(very much)
  • Radio Buttons Yes/No. This type of question allows only two choices: Yes or No.
  • Comment Only
  • Text field: This type of question allows the user to insert some text in a small text field.
  • Text area: This type of question allows the user to insert some text in a large text area

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

Creating a new survey

You can create a new survey by clicking on the “Admin” link and then “Add a new survey”.

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.

Don’t insert spaces or any other character between the numbers

  • Active: This flag indicates if the survey is active or not.

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 after users have already inserted answers.

Viewing survey results

You can view the results of the surveys clicking on the “View Results” tab.

News

Inserting a news item

You can insert a NewsByte 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 blackfin.uclinux.org news team before they will appear on the blackfin.uclinux.org home page.

You may include URLs, but not HTML in your submissions.

URLs that start with http: are made clickable. The NewsByte will go to the News Admin for approval for publication. ===Modifying/Approving a news item=== You can modify and/or approve a NewsByte by clicking on the Admin link. You can select the status of the News: Displayed or Delete (the news will be deleted). You can also enter the Subject (title) of the NewsByte and the details. ====CVS==== The SCM button shows a page that contains information on how to access the CVS repository. Use this information to configure your client for CVS access. The Browse CVS Repository link opens the viewcvs web interface, where you can view the CVS repository, view differences between revisions and download versions of a file. <note tip> Only public projects will show in the Browse CVS Repository link. </note>

Complete Table of Contents/Topics