Nakamura Documentation

What is Sakai Nakamura?

The original name for the new back end was 'K2,' for 'Kernel 2.' At some point along the way it was realized that this name was problematic for a variety of reasons, and in any event including the version number in the name is just bad form in principle, so the code name Nakamura was chosen instead. This change is still being propagated through.

In the documentation that follows you may still find scattered references to 'K2.' Don't be confused. We just haven't cleaned them up yet.

Sakai Nakamura is a next-generation "kernel" - a set of core services - for the Sakai 3 product. Its overarching aims are the following:

  1. Flexibility for the User Experience : Nakamura aims to provide an underlying infrastructure of services which break down the siloed user experiences in sites and tools.
  2. Developer Ease of Use : the primary users of Nakamura will be front-end developers, many of whom may be working only in HTML and Javascript. Nakamura releases will provide clear documentation with this sort of developer in mind, clean RESTful APIs, fast builds and short startup times enabling rapid cycles.
  3. Scalability and Resilience : Nakamura will support full clustering and be built for scalability.
  4. 3rd-party code : Nakamura will strive to reduce maintenance burdens and minimize the need for the Sakai development community to occupy itself with purer software engineering problems, and it will do so by judicious incorporation of other open source projects.
  5. Test Coverage : Nakamura will labor to improve quality and stability through a discipline of test coverage.
    Which guide is right for me?
    Which guide is most suited to your needs will depend considerably on what kind of information you are looking for. Use the table below to help you.

    Guide Content Target Audience
    Your First Day With Sakai Nakamura A hands-on tutorial introducing the content repository and scripting. Includes ~46 minutes of screencasts. Client-side or server-side developers looking to become acquainted with the basics of Nakamura technology
    User Interface Developers Guide Comprehensive manual for UI developers intending to develop user interfaces based on Sakai Nakamura End Users of Nakamura, ie UI developers
    Adopter and Implementation Guide Step by step installation guide
    Administrators.
    Decision makers.
    Managers.
    Developers Guide Getting started as a Sakai developer
    How can I get involved?
    Detailed documentation contributed by the developers
    Developers contributing to the Sakai Nakamura Project.
    People interested seeing low level technical documentation.


Within each of these categories, there will be guides, faq's and detailed notes on each of the topics.

 
Recently Updated
by Simon Gaeremynck (10 Mar)
405 - Connection Management REST services
by Simon Gaeremynck (09 Mar)
KERN-557 Site Creation Templates
by Paul Bristow (08 Mar)
Re: 410 - Group REST services
by Ray Davis (06 Mar)
200 Running Sakai Nakamura
by Clay Fenlason (05 Mar)
Roadmap
by Clay Fenlason (05 Mar)
Building Nakamura Sling
by Clay Fenlason (05 Mar)
510 Faster UX development on Nakamura
by Clay Fenlason (05 Mar)
User Guide
by Clay Fenlason (05 Mar)
500 - User Interface
by Clay Fenlason (05 Mar)
Developing an OSGi bundle in Nakamura Sling
Mailing List

Join the Sakai Kernel Google Group!
Sakai Kernel Developers Group

Developer Links

Presentations

  Name Size Creator (Last Modifier) Creation Date Last Mod Date Comment  
PDF File k2.pdf 3.40 MB Ian Boston Jul 14, 2009 Jul 14, 2009 K2 Presentation at Sakai09 in Boston View
PDF File Workshop.pdf 1.05 MB Ian Boston Jul 14, 2009 Jul 14, 2009 Sakai3/K2 Workshop introduction at Sakai09 in Boston View
PDF File helloworld.pdf 2.44 MB Ian Boston Jul 14, 2009 Jul 14, 2009 Hello World Exercise from Sakai3/K2 Workshop at Sakai09 in Boston View
File bathurst_work.tgz 12 kB Ian Boston Sep 16, 2009 Sep 16, 2009 Tarball of Bathurst Workshop OSGi component
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.