our documentation is publicly available on the Wiki, including documentation for developers and other contributors. That being said, it's not always easy to find ones way in the tangle of docs.
This list of links is particularly intended for Chandler's interns and Google Summer of Code participants, giving them a way to get started within their first few hours.
All in house
interns though should start with a couple of administrivia things (you can skip this if you're a SoC student):
- Get introduced to the team
- Get installed at their desk
- Pay a visit to our friendly HR staff so that we verify that they can legally work with us and fill up some forms
- Get an OSAF email account and credentials on our network
- Get a key fob and be instructed on how to operate the alarm
- Read the KEI New Hire Starting Points page
The Development Home
is the jumping start for all OSAF engineering groups. Bookmark it so that you can find your way around.
If you work on Chandler, the Apps
page or the Platform
page will give you an overview of the status of the project, who's working on what and the main documents we are maintaining for the current milestone.
As a developer, you are expected to know our QA processes
. Your mentor will guide you through them if you are in doubt. We manage all our workload through Bugzilla
. Beyond the vanilla use of Bugzilla (for bug tracking), we use it also to Track Development Tasks
Source Code Repository
We use Subversion for our source code repository and all Interns should request from bear (aka Mike Taylor) both a subversion account and a sandbox directory. The ability to commit to the different repositories is granted only after a review process, but everyone has access to their own "sandbox". To get access to the sandbox you need to send to bear your requested svn user id (all lower case, no-l33t-sp34k) and your ssh public key.
Information about Subversion and how OSAF uses it can be found here: SubversionGuidelines
Information on generating a SSH key is found at Generating a SSH Key
Some people on staff are remote, we have contributors in various places on the planet, we do telecommute twice a week, none of this would be possible without us using diligently some efficient ways of communication.
As an intern, you should join the general@ and the design@ lists as well as all the mailing lists
relevant to your project (i.e. at least one of chandler-dev@, cosmo-dev@ or scooby-dev@).
You should also install an IRC client on your machine and listen to our IRC channels
We will have an Office Hour every Wednesday from 3:00pm to 4:00pm (US/Pacific time)
on the #osaf channel on FreeNode.
All interns, Summer of Code participants and their mentors will discuss the state of their projects, issues they are having (of any kind) and share their experience.
Everyone at OSAF is welcome to participate since, more than likely, the expert knowledge of people outside the mentors community will be required.
Office Shared Calendar
We do maintain a fairly complete calendar of office events (meetings, travel dates of various team members, even vacation dates). It's useful when you wonder what's happening on any given day. You can access it off the OSAF hosted server using Chandler Desktop or Chandler Web UI (that's dogfooding for you
). The read-only ticket is:
Introduction to Chandler Desktop Development
You should definitely start with downloading the latest Chandler milestone
and give it a try. Everybody around expects you to understand what we are developing here.
Next, you should read the Chandler Architecture
document thoroughly, and follow this with writing a parcel of your own, using the Tutorial
In general, check out the Developer documentation
(it points to the 2 previous docs as well). It has been extensively improved for 0.6.
There are also some older but useful docs on the old Developer Documentation
page. In particular, check out the Busy Developer's Guide to the Repository
Introduction to Chandler Server and Web UI Development
- 01 May Journal.2006