Difference between revisions of "Core developer introduction"

First week or two: getting acclimated

Server / git access

• Generate SSH key
• Coordinate with nkinkade about getting on servers
• Coordinate about getting git access

Get cc packages set up with zc.buildout

Do git checkouts *via ssh* for all of these packages:

• cc.license
• license.rdf
• cc.engine
• i18n
• cc.api
• deedscraper

Next:

Configure buildout so it takes less than your lifetime to complete: http://www.cynapse.com/blog/cynin-buildout-low-bandwidth-try-these-settings

You should then set up zc.buildout. For more about what zc.buildout is, let's talk on the phone.

 python bootstrap.py && ./bin/buildout

Next, you'll need the RDF library, which comes from Redland (you need the redland-bindings package configured with --enable-python):

http://librdf.org

Get server running

In cc.engine:

 ./bin/paster serve cc.engine.ini --reload

Get cross-package virtualenv working

http://labs.creativecommons.org/2010/03/16/using-virtualenv-and-zc-buildout-together/

This will be important when you have to work on multiple packages that affect each other at once.

Reading materials

You aren't expected to completely grasp all of this immediately.

• Read the cc.engine docs/ materials
• Read the RDFa primer: http://www.w3.org/TR/xhtml-rdfa-primer/
• Play with http://creativecommons.org/choose/ and see how the output there has RDFa embedded in it
• ... don't bother reading the RDF primer immediately, let's talk about it on the phone
• http://wiki.creativecommons.org/CC_REL
• http://en.wikipedia.org/wiki/XML_namespace
• Read: http://labs.creativecommons.org/2009/12/18/understanding-the-state-of-sanity-via-whiteboards-and-ascii-art/
• Read: http://labs.creativecommons.org/2010/01/06/caching-deeds-for-peak-performance/
• If you get stuck on git, http://progit.org/book/ is really great.

Some general CC pages you should read:

• http://creativecommons.org/licenses/
• All sections on http://creativecommons.org/about
• The FAQ http://wiki.creativecommons.org/FAQ
• The CC0 FAQ http://wiki.creativecommons.org/CC0_FAQ
• The Public Domain Mark FAQ http://wiki.creativecommons.org/PDM_FAQ

Backups!

You should have the machine you work on have backups done regularly and automatically. We have some in-house backup machines, but you can backup locally, even to an external drive. You just need to backup your data.

Some of us like using Dirvish for this.

Start working on tickets

EG, with Jon Palecek, we're starting with:

http://wiki.creativecommons.org/Clarity_Project

Talk and pick out the appropriate tickets