Kauri documentation refactoring overview

[svr]

Document as attachment with our (sdm + svr) remarks about the current documentation of kauri 0.4. If there are any questions or remarks, just ask.

[svr]

document with remarks about the current version of the documentation of kauri 0.4

[sdm]

Apparently there is no documentation about URIs like the following:

"uri": '${publicUri('service:/myRouter')}/acc/byRoles/{-list|,|roles}'

The structure {-list|,|roles} is used to define the separator between the different values of "roles". But apart from -list, the following options also exist: -prefix, -append, -opt, -neg and -join. It is not clear how, when and why to use these.

It would also be useful if the documentation mentioned how to assign a default value to a variable, like this: {id=-1}

The explanation on the following page is quite clear and could be used as a reference:

 http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.html

[mpo]

Here is a preoposal for a reorganized Table-Of-Contents

• Getting started/** (already in place)
• Tutorial/** (getting there)
• Usage (new)
  • Install
  • Ongoing Changes (features)
    • api changes (svn ref)
    • conf changes (svn ref)
  • Upgrade (Steps to follow)
  • CLI Reference
• Developers Guide
  • Concepts
  • Runtime/**
  • Routing/**
  • Templating/**
  • Prototyping/**
  • Configuration/**
  • Representations/**
  • Error handling
  • DB/**
  • Forms/**
    • add common section for all controls, validators, formatters
  • Security/**
  • Temp Resources/**
  • Caching/**

• Deployment Guide
  • Service Wrapper
  • Packaging
• Glossary

(change into a single page that shows the query

> maybe use some jquery to pop-out

• Reference

( the reference material is already in the different sections, maybe it makes sense to add a single page grouping all of those links > maybe automate through new doctype or field?)

• Hackers Guide/**

Please add comments/alternatives/discussion to the issue.