120 likes | 311 Views
Sakai development tips. Aaron Zeckoski azeckoski@gmail.com. The main website for the Sakai foundation and Sakai project is: http://www.sakaiproject.org/ Find information about upcoming Sakai conferences and other Sakai related news Find out what schools are using Sakai
E N D
Sakai development tips Aaron Zeckoski azeckoski@gmail.com
The main website for the Sakai foundation and Sakai project is: http://www.sakaiproject.org/ Find information about upcoming Sakai conferences and other Sakai related news Find out what schools are using Sakai Figure out why it is called Sakai Sakai foundation website
The best source of information for developers wanting to work in Sakai is the programmers café website http://bugs.sakaiproject.org/confluence/display/BOOT/ Info you can find there: Tutorials Tips Documentation Sample code Programmers Cafe
The Sakai Collab server runs a current version of Sakai and provides a place for the community to collaborate using Sakai, demo Sakai, or try out tools The collab server is also used to manage all the Sakai mailing lists and to manage some documentation https://collab.sakaiproject.org/portal Sakai Collab
The sakai-dev email list is a great place to ask development questions How sign up for sakai-dev email list Create account on Sakai Collab and login https://collab.sakaiproject.org/portal Click Membership link on left Click Joinable Sites link at top Click Join link for DG: Development Send email to the list at: sakai-dev@collab.sakaiproject.org sakai-dev email list
Sakai uses Confluence (an enterprise Wiki) to document projects and Sakai related activity http://confluence.sakaiproject.org/confluence/ Sakai uses JIRA (bug tracker) for issue and bug tracking related to Sakai development http://128.196.219.68/jira/ Sakai Confluence and JIRA
The Sakai source code is stored in a Subversion repository Main Sakai source Includes the entire Sakai source plus provisional tools https://source.sakaiproject.org/svn/ Sakai Contrib (contribution) Includes contributed source for various Sakai projects https://source.sakaiproject.org/contrib/ Sakai source code
The vast majority of Sakai developers use Eclipse for development You can use other development environments but Eclipse has some advantages: Supported (eclipse files in the Sakai code base) Well understood (support docs and knowledge) Extended tools (appbuilder plugin) Can get commercial support if desired: http://www.myeclipseide.com/ Eclipse URL: http://www.eclipse.org/
Getting a good development environment setup is critical to working with Sakai code Complete step by step instructions are available in the programmers café: Development Setup Walkthrough Include various tips that will make developing in Sakai easier Development Environment
The Sakai API Javadocs are available with the release documents here: http://source.sakaiproject.org/release/ The link to the Javadocs is a little over halfway down (link named “JavaDocs”) Here is the link for the current release (2.4.0)http://source.sakaiproject.org/release/2.4.0/javadoc/ Javadocs for the trunk are available http://nightly2.sakaiproject.org/javadoc/ Sakai API Javadocs
You can build javadocs for the Sakai source code you have checked out Run the following command from the root directory of your copy of the Sakai source maven sakai:javadoc The javadocs will be generated here <sakai source>/target/sakai-javadoc.zip More Sakai javadocs URL: http://bugs.sakaiproject.org/confluence/display/BOOT/Javadocs+for+the+Sakai+API