CMSMS | CMS Made Simple

Submit new documentation | View Documentation

How to create and manage a project

This is a shorter introduction to creating and managing a project in the CMSMS Forge. For full details, read the CMSMS Forge User Guide.

Register a project

To register a project you must first register as a user and then log in. When you log in you will be taken to "My Page", which contains your personal info, about the projects you are a member of, bugs you have reported etc. At the top of "My Page" there is a link to "Register a project".

On the project registration page you need to give the following info:

1. Select a name for your project
2. Write a description of your project so that the admins know what they approve (this will only be used when submitting a project for approval)
3. Choose a license for your project
4. Write a description of your project that anybody can read when they browse to your project. Give a good description of what your project is!
5. Choose a unix name, which must be in lower case and without any space in the name.

When you have submitted your project a site administrator has to approve it before you can access it.

Categorize your project

The first thing you should do as soon as your project has been approved is to categorize it! Otherwise users will not be able to find your project. Click on "Edit" next to Trove Categorization under the Admin tab for your project. The most important category to choose is for CMS Made Simple (if it's a module, tag, translation etc.).

Upload file releases

To make files available for users to download, navigate to the Files tab. Before you release a file you have to define a package, which should have a descriptive name for the project. By default the unix name of your project has been added as a package.

To upload a new release click "Add release". The form has the following fields:

Package ID -- Select a package.
Release Name -- Type the version number here. If it's a module, use only numbers, like 1.1. or 0.4 beta2.
Release Date -- The Release Date, which you normally don't have to change.
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.
File Type -- You must select the file type (.zip, .html, .exe, .tar.gz, etc).
Processor Type -- This is to select the processor required to run the application. It's not really valid for CMSMS so just select Any or Other.
Release Notes -- Type some info about this particular release.
Changelog -- The changelog, version history, what is new in this release.

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

Use SVN for development

We encourage you to use SVN for the development of your project, please read more here.

Trackers

Trackers help you keep track of bugs, feature requests, patches etc. You can create new trackers to keep track of any kind of data.

Get notified of changes in your project

To make sure you get notified when anything happens on your project, you can go to each of the "trackers" - i.e., the bug tracker, the feature request tracker - and enable email notification. To do that, go to your project page, click on the "Tracker" tab, click on "Bugs", click on "Admin", then click on "Update preferences", and put your email address in the "Send email on new submission to address:" box. Also, you can check the box right below it that says "Send email on all changes".

You can also subscribe to the commits mailing list for a project, to get email notification when a file has been committed to that project's SVN.

Post news

You can insert a news item about your project. All posts for your project will appear instantly on your project summary page.

Posts that are of special interest to the CMS Made Simple community will have to be approved by a site administrator before they will appear on the CMSMS Forge home page.

You may include URLs, but not HTML in your submissions. URLs that start with http:// are made clickable. The news item will go to the News Admin for approval for publication.

Turn on/off features

You may want to turn off some of the features for your project if you don't plan to use them - you can always turn them back on. You can turn things off by clicking your project's Admin tab, then clicking the "Edit Public Info" link, and deselecting the appropriate checkboxes. Likely candidates for disabling include surveys, forum, FTP, mailing lists and the project/task manager.