Freelancer Community Network

ForgeTips » History » Version 18

« Previous - Version 18/38 (diff) - Next » - Current version
Bullwinkle, 05/10/2010 10:45 PM


Forge Tips

Collected Tips about using the-Starport Forge -- Bullwinkle

Sub-Projects
Forums
What's New -- Keeping Track of Your Team
Using the Wiki
Files Module
Version Control

Sub-Projects

You can add and manage your own sub-projects as you like. There are many uses for sub-projects. One that we found immediately useful was to keep our main project Public, and create a Private Development sub-project.

That way, the team can work in privacy, and still publish finished work in the Public project:

Main Project (Public)
  • Wiki
  • Files
  • News
Dev Sub-Project (Private)
  • Wiki
  • Forums
  • Issues (bug tracker)
  • Repository (SubVersion Version Control)
  • Activity
  • Files

Forums

Want to talk with the team when members live in different time zones? And keep track of the conversation, just in case somebody says something important? But you don't want to fill up the-Starport's forum with off-topic chatter?

Then project Forums may be for you. They work very much like the-Starport's main forum, except that you have more control over them. A Forum in your Public Project will be open to all, while a Forum in your Private Sub-Project is only readable by your team.

Use the Activity Page and/or Watches to follow the topics in your forums... see "What's New", below.

#Whats

Whats New_--_Keeping_Track_of_Your_Team

If your team is busy making updates to your mod or project documentation, then it can be challenging to keep track of who has changed what recently. Two features of the Forge help you to see What's New:

Activity Page

Look at the Activity Page for a quick way to see What's New in your project. Use the filter checkboxes on the right to select which items you want to see on the Activity Page:

Watches

Many of the project pages can be "Watched", which means that you will get an email when that page changes.

For example, if you keep track of team chatter (questions, answers, decisions) by using a private Forum, then you might want to receive an email when a team member makes a post. Wiki (and other) pages can also be Watched. To set a Watch, look for a small "Watch" button in the upper right-hand corner of the page:

Using the Wiki

The Wiki on the Adventures of Trent Forge is powerful and easy to use. You can make many kinds of web pages with it.

Use the buttons at the top of the page to insert formatting codes, or just memorize them.

If you want to create a new page, simply create a link to a new page with a unique name (in Edit mode). Then, click the link (in Read mode) to create the new page.

This is a link in Edit Mode:

2) To Cancel your editing session and return to Read mode, click Wiki on the Forge toolbar:

You should now be in Read mode. Simply click your new link to create a new page.

Files Module

The Files module gives you a place to host files for the public, such as a version of a mod. Once uploaded to the Forge, Files cannot be renamed or moved. The reason for this is that each file in the Files module gets a URL so that you can link to the file from elsewhere (such as the-Starport forum, for example).

In order to keep your Files organized, you can use Versions to mimic sub-folders. In Settings, Create a New Version:

The Version Name is what users will see in the Files listing as a header -- similar to a folder.
The Optional Wiki Page is the name of a page in your project's Wiki that is linked to this Version's Files.

Go to the Files Module, and click New File to upload a file.
In the New File dialog, use the pull-down menu to choose the Version/Folder where you want the file.

Version Control

The coolest and most important feature of the Forge is Version Control (via SubVersion - SVN). A Version Control System (VCS) allows team members to work on the same code without interfering with each other. A VCS offers:

  • Automatic backup of every change made by every developer on the team.
  • Two developers cannot edit the same file at the same, thereby avoiding conflicts.
  • Encourages good documentation and good communication between team members.
  • Ability to mark a "version", which includes all of the source files required to make that version.
  • Ability to roll back changes (in case you try something that does not work).

SubVersion is a popular Version Control System (VCS). The server side is SubVersion. The client side can be one of many client tools. TortoiseSVN is popular for Windows users because it is integrated into the Explorer (does not require a special control panel).

Wiki01.png (15.3 KB) Bullwinkle, 05/10/2010 08:44 AM

Wiki02.png (15.3 KB) Bullwinkle, 05/10/2010 08:44 AM

Wiki03.png (15.1 KB) Bullwinkle, 05/10/2010 08:44 AM

Files01.png (11.5 KB) Bullwinkle, 05/10/2010 09:13 AM

Files02.png (25.4 KB) Bullwinkle, 05/10/2010 09:13 AM

Files03.png (12.7 KB) Bullwinkle, 05/10/2010 09:13 AM

Files04.png (15.9 KB) Bullwinkle, 05/10/2010 09:13 AM

Watch01.png (25 KB) Bullwinkle, 05/10/2010 09:51 AM

Activity01.png (26.7 KB) Bullwinkle, 05/10/2010 10:02 AM

SVN02.png (26.2 KB) Bullwinkle, 05/12/2010 02:26 AM

SVN03.png (30 KB) Bullwinkle, 05/12/2010 02:26 AM

SVN04.png (30.5 KB) Bullwinkle, 05/12/2010 02:26 AM

SVN01.png (19.2 KB) Bullwinkle, 05/12/2010 02:28 AM