hpaulos / sakai-reference Goto Github PK

SAKAI - a community source Collaboration and Learning Environment
-----------------------------------------------------------------

The official website for Sakai is:

	https://www.sakailms.org
	
The latest release of Sakai can always be found at:

	https://www.sakailms.org/release
	
To see the institutions involved in the Sakai collaboration and
their implementation status, see:

	http://bugs.sakaiproject.org/confluence/display/PROD/Implementations
	
	
THE reference/docs DIRECTORY

This directory and its subdirectories contains the bulk of the
reference material distributed with a release.

architecture/	technical documentation and white papers

conversion/	contains the DB conversion scripts to alter
		the schema from one version to the next
		
loadtesting/	sample scripts used for loadtesting Sakai 
		using the Apache JMeter loadtesting engine.
	
webservices/	contains documentation for using Web Service
		wrappers of the Sakai API.  This is a common
		method for scripting admin tasks.
	
readme.txt	this file

INSTALL		A URL pointer to our online installation documentation

readme_i18n.txt		internationalization info for Sakai

RELEASE-NOTES	A URL pointer to our online release notes

sakai.properties	a reference configuration file for Sakai


DOCUMENTATION

A good start for developers interested in working with Sakai is the wiki
space named "Programmer's Cafe," where many tutorials and tips have
been collected by community developers.

	http://bugs.sakaiproject.org/confluence/display/BOOT/Home

Technical documentation and white papers can be found in the architecture/
directory.


ISSUE TRACKING

Bugs and other issues can be reported and tracked at:

	http://bugs.sakaiproject.org
	

COMMUNITY

Most Sakai collaboration happens in one (or both) of two arenas: the
collab server, and the Confluence wiki already linked to here a
number of times (bugs.sakaiproject.org/confluence).

The collab server is a fully functional Sakai deployment, with sites
set up for community sub-groups, but in day-to-day activity it is
used most often as a kind of listserv.  You're encouraged to set up an 
account on the collab server and join any groups you like at:

	http://collab.sakaiproject.org
	
The most active site there is the "DG: Development" site, otherwise known as "sakai-dev".


PROJECT STATUS

The best central location for information on sub-project status and
the variety of tools - standard or not - available for Sakai is:

	http://bugs.sakaiproject.org/confluence/display/MGT
	
	
LICENSE

Sakai code is distributed under the ECL license:

	http://www.opensource.org/licenses/ecl2.txt