Apache Cayenne Website > Index > Developer Guide > Documentation Guidelines
Documentation Guidelines
Versioned Cayenne documentation is maintained on this site. Documentation corresponding to the release currently under development is placed in CAYDOC space.
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 supported.
- Use Confluence "parent page" functionality to build the hierarchy of pages
- To order child pages within the parent, and to build a sort of local table of contents, use an "excerpt" macro on the parent page, listing children in the expected order in the bottom of the page:
...
h3. Sections
{excerpt}
# [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
.
Refreshing Documentation from Wiki
See Building Cayenne chapter.