A Short Introduction and Guided Tour
Contents of Code Tour
Welcome to a brief tour of the functionality of CodeResort, and the various sections and tools that are available.
Having your project hosted on CodeResort gives you access to powerful tools and services for running your project.
The basic tools are:
- A source file repository for working with various code files that are stored on our servers, but also available on your own machine.
- A web workspace providing an interface for creating and changing information that is not source code - documentation, task and bugs, status reports and so on.
Projects can be added at any time in the project lifecycle, and all the tools will add value both for projects being created now and for projects that are in a maintenance phase. Naturally the completeness of the documentation, task and bugs history, source file history and so on will be benefit from an early start at CodeResort.
Source Code Repository
The source code repository is based on Subversion - a very popular version control tool with much functionality. The features for our Subversion server supports access control defined at any level, transaction and data integrity, and are also built for distributed updating by many developers with features for merging changes back into central storage.
Subversion is only supplied with a command-line interface, but most users will opt to install a separate Subversion client more suited for how they work. As Subversion has open interfaces, a number of clients are available:
- TortoiseSVN -- Windows Shell Extension for Subversion.
- Subclipse -- A Subversion Eclipse Plugin.
- AnkhSVN -- VS.NET addin for the Subversion version control system.
Find the tool most suited for your way of working - or; for those only needing to read and reference the source code, use the Source browser available through your web project (see below).
The preferred tool for most of our users on the Windows platform is TortoiseSVN, and here is an example of how this client allows you to use the regular Windows Explorer to work with your source code locally:
CodeResort Web Interface
The Web interface is the real project "home" - all information is available here, and can be viewed or changed by those with assigned permission to do so. All important information from the repository is also available here. Below there is further description of the various modules that are available.
Linking information is central to the project workspace - any piece of information can be linked to another. Here is an example showing a new page created with some basic text and links illustrating the concepts:
And here is how the page looks when it is saved.
The Web project environment is based on Trac.
The pages you are reading now are Wiki pages. They are no different from regular web pages apart from the syntax used to create them. Instead of learning difficult HTML code, the wiki mark-up is a very rational way of writing text for web quickly, and has number of time- and clutter reducing techniques to allow you to focus on the content.
Central to the wiki idea is that everyone should be able to publish content to the web, and the editor is simply a box for writing normal text. In fact, just writing plain text and hitting "Submit changes" will make you a nice web page. Learning a few easy tricks like headings, bold/italic, bullets and pre-formatted text (for code display for instance) will get you very far.
See the examples above for how a Wiki page is created and edited.
Next on the normal (full) menu is the Timeline. The Timeline displays all activity in the project - it shows changes to wiki pages, bug tracker and tasks, changes to source files in the repository and so on.
To keep up-to-date on project activity, the timeline also produces an RSS feed that can be used in any feed reader supporting authentication.
The Roadmap is a way of grouping planned bug fixes, enhancements and tasks leading up to a milestone. Using the roadmap module you will be able to see all your planned milestones, and view details on all the tasks assigned to this milestone.
The tasks are tasks registered in the ticket system, and can contain a number of attributes such as component, version, and priority and so on. A detailed report of the tickets can be viewed by drilling down from the Roadmap.
The ability to Browse Source is a very important feature, and allows for easy access to the source code at all times. It will display source files with syntax highlighting for most programming languages.
The Source Browser has a number of additional features that make it a very useful tool.
- Ability to view any previous version of a file or a folder
- Compare versions to highlight changes made
- Review the full change history of any file or folder in the repository
The Ticket System is a central part of the code management system. A Ticket has a type, and default the types are "Task", "Defect" and "Enhancement". A to-do for any reason can be a Ticket.
Every ticket has a history - a history with regards to status and attribute changes, and a history regarding all the comments and discussions that can take place within a single ticket.
Use the standard reports for status on tickets, or even create your own.
The Ticket System supports RSS feeds, allowing any report to be a feed definition. In addition, e-mail notification can be enabled for tickets so that everyone working on a ticket can be notified of any changes or comments.
Quick Search is available in the top menu everywhere in the project, and there is also a Search page allowing limiting the search to specific areas. The result set has search word highlighting.
All Help pages are available inside the project, and each project can also add its own Help pages to the HelpProject section - pages will automatically be included in the overall Help navigation.
Project owners have access to Admin pages. By using the Admin pages, all common settings, preferences and access rights for the project can be edited.
The permission system allows for specifying which user/group should have access to the various sections, and their specific access level in each module. There is also a separate page for specifying access to the source code repository, allowing read/write for individual files and folders.
A number of Admin pages exists to be able to completely customise the behaviour of the various Ticket statuses and attributes. By changing the fields, it is easy to set up a Ticket system that implements your own behaviour with the terms you normally use.
DAV-based File Share
With each project, there is also a separate DAV-based File Share for storing any supplemental software, documents, backups or temporary files for sharing among the project.
Hook up to the file share using any operating system, and using Microsoft Office you can open and save directly to the online storage.
View our summary of Benefits for more information about what CodeResort can offer you.