New Project Setup Instructions

This page contains information on the steps OSFlash administrators need to follow to setup a new open source project on OSFlash:

1. Go to http://www.cvsdude.com
2. Sign in user your username and password
3. Click on “Project Management”
4. Under the “Project” heading, select “SVN Module Manage”
5. Scroll to the bottom of the page and enter the project’s name (or short name) in the <enter module name> textbox under the “Create new module...” section.
6. Click the “add new” link

That creates a new project in SVN but you still need to create accounts for the project leader and committers (no real difference in terms of workflow/permissions.)

For the project leader and any committers, you need to repeat the following instructions:

1. Select “Project Management” from the top menu
2. Select “Authorized Accounts” from the Project section
3. Click the “add” link at the bottom of the page
4. In the “Authorized Accounts” page, add the project leader or committer’s details. Whenever possible, the username should be based on the user’s name, in the form <first initial><last name>.
5. For the password, enter a simple word that you will remember easily. You will be sending this to the project leader and asking them to change it when they first log in. (Use the same password for all accounts you create to make it easier for you and for project leaders.)
6. Give only the following access rights to the user, using the relevant checkboxes:
   • web access
   • http
   • trac
   • web-based interface
7. Click the “save” link at the bottom of the page

You will be returned to the “Authorized/Sub-Accounts page”, listing all the authorized accounts.

Note: Although you have created a new account, that user will not have access to the new project yet. You will need to give that user access using the Access Control Lists (ACLs).

It’s a good idea to create all new users for a project first and then set up ACLs.

Now that you’ve created the new authorized accounts, you must give these accounts access to the newly created project.

1. Select “Project Management” from the top menu
2. Select “ACLs” from the Project section
3. On the “Access Control Lists” page, scroll to the bottom and click the “add” link
4. Select the project you just created from the listbox and click the “next” link
5. Select the root of the project (/) and click the “next” link
6. Check the read/write checkbox for the project leader and any committers on the project
7. For the DEFAULT user, click the read checkbox
8. Click the “next” link
9. On the next page, confirm that you’ve selected the correct users and click the “save” link
10. You’ll be returned to the “Access Control Lists” page. Click the “compile” link at the top of this page.
11. On the page you’re taken to, scroll to the bottom and click the “install” link.
12. On the confirmation page, enter your username and password (if they’re not already filled in) and click the “install” link.

Great! Now the project lead and committers have read/write access to the project and everone else (anonymous users) have read (checkout) access to the repository.

You’re done with SVN repository setup.

Enter the details in a copy of the email template that you’re going to be sending the project lead (see below) and move on to creating the mailing list.

1. Go to http://osflash.org/cpanel
2. Log in with your username/password
3. Click the “Mail” icon
4. Select the “Mailing Lists” link
5. Scroll to the bottom of the page and select the “Add Mailing List” link
6. Enter the list name and a password. Make a note of this password.
7. Click the “Create” button to create the list.
8. Click the “Go back” link on the confirmation page.

1. Click the “Edit” link next to the list you just created and enter the password you selected for the list when prompted
2. Copy the URL in the address bar of your browser and paste it into the email you will be sending the project leader. This is the administrative URL for the mailing list.
3. Right click the “Go to the general list information page” link and select “Copy link location” to copy the link to the clipboard and paste it into the email you will be sending the project leader. This is the URL of the mailing list where users can sign up, etc.
4. In the list administrator email address, enter the project leader’s email address.
5. For the “Where are replies to list messages directed?” setting, select This list.
6. For the “Should the list moderators get immediate notice of new requests, as well as daily notices about collected ones?” setting, select No.
7. Click the “Submit Your Changes” button

1. Click the “Privacy Options” link
2. Click “Sender Filters”
3. “Action to take when a moderated member posts to the list.” should be Discard
4. “Action to take for postings from non-members for which no explicit action is defined.” should be Discard
5. “Should messages from non-members, which are automatically discarded, be forwarded to the list moderator?” should be No
6. Click “Submit Your Changes”

1. Click the “Membership Management” link
2. Click “Mass Subscription”
3. In the “Enter one address per line below...” textbox, enter your own email address and the address of the project leader.
4. Click “Submit Your Changes”

That’s it, you’re done with the mailing list setup.

The only thing that remains is to set up a page for this project on the Wiki.

1. Click the Edit this menu link in the sidebar (or just control-click on the link here.)
2. Click the Edit button at the bottom of the Hosted Projects section.
3. Add the name of the project with a link (using its short wiki name if one was provided by the project leader)
4. “Save” the page
5. Click on the new link and edit the new page to create it
6. Use the following template to add the initial content:

====== Name of Project ======

This project has just been created.

Finally, copy the URL of the page and paste it into the email you are going to send the project leader.

That’s it. You’ve created the SVN Repository, Mailing List and the Wiki Page for this project. Now, all that remains is to email the project leader with all the necessary information.

Throughout this process, you should have been updating a copy of the email template, below, to be sent to the project leader.

Once complete, email the project leader with the relevant information and send an email to the OSFlash mailing list to inform the list that a new project has been set up.

Your new OSFlash project is ready!

Hi ProjectLeaderName,

Welcome to the OSFlash family!

I’ve just set up your project on OSFlash. Please keep this email in a safe place for future reference at it contains important account details for the Subversion (SVN) repository, mailing list and web site.

Here is the URL you can use to access SVN:
SVN Repository Link

Here is the link to the Trac tool for your project:
Trac Link

Your username and password for committing to the repository are:

Username: SVNUsername
Password: SVNPassword

IMPORTANT: Please log in at http://sourcesecure.co.uk and change your password as soon as possible.

I’ve set up accounts for each of the committers on your project. Their usernames are all in the form <first initial><last name> (except [if there are any exceptions]).

They all have the same password:
SVNCommitterPassword

IMPORTANT: Please ask all your committers to log in at http://sourcesecure.co.uk and change their passwords as soon as possible.

I have also set up a mailing list for you and set you up as the administrator.

To administer the mailing list, log in at:
MailingListAdminURL

Using the following password:
MailingListAdminPassword

Your mailing list has a public sign-up page at:
MailingListSignupPageURL

Finally, I’ve created a namespace (section) on the OSFlash wiki for your project. You can find it at:
ProjectWikiPageURL

When linking to the main page of your section on the wiki, you can link to it as:

[[ProjectName]]

If you want to create sub-pages on your section/site, use the following naming convention:

[[ProjectName:SubPageName]]

(Of course, page names can contain spaces, etc.) The colon tells the wiki that the second page is a subpage (or belongs to your project’s namespace.) It’s important that you keep subpages on your namespace so that the wiki will remain organized. Also, the breadcrumb navigation at the top of the site will allow users to navigate easily between your project’s main page and subpages.

Please don’t hesitate to contact me or ask on the OSFlash mailing list if you have any questions.

All the best,
NameOfAdministator
--
FullNameOfAdministrator
OSFlash Administrator
http://osflash.org