Documentation Guidelines has been edited by Andrus Adamchik (Dec 18, 2006).

(View changes)

Content:

Versioned Cayenne documentation is maintained on this Wiki. Documentation corresponding to the release currently under development is placed in CAYDOC space.

Unresolved Issues

See a discussion here.

Authoring Tips

  • Links to other spaces must be entered as full URLs, otherwise they'll come across as plain text on export.
  • Multiple levels of sub-chapters are supprted.
  • Use Confluence "parent page" functionality to build the hierarchy of pages
  • To order child pages within the parent, an invisible "excerpt" macro is added to the parent page, listing children in the expected order.
{excerpt:hidden=true}
Chapter 1
Chapter 2
Chapter 3
{excerpt}

Versioning

Once a stable release is branched, documentation is also branched to a space with name like CAYDOC_X_X. Making a space copy is a manual process that requires exporting the space, manually changing the name, and reimporting as a different space name: http://confluence.atlassian.com/pages/viewpage.action?pageId=169578.

Reply via email to