Mercurial > p > roundup > code
view doc/reference.txt @ 7322:485cecfba982
Simplify TOC; older docs pushed a level down; Consolidate debugging
Restructured docs.txt. Pulled out older documents into Old Docs.
I wish I could add whitespace between documents in the toc. Current
order split into groupings:
Roundup Features
Roundup Features
Installing Roundup
Upgrading to newer versions of Roundup
Reporting Security Issues with Roundup
Roundup FAQ
User Guide
Customising Roundup
REST API for Roundup
XML-RPC access to Roundup
Roundup Reference
Roundup Glossary
Administration Guide
License
Acknowledgements
Other Docs
debugging.txt removed. Its contents replaced a reference in
developer.txt.
Added olderdocs for:
docs/upgrading-history
docs/tracker_templates
Design Overview <docs/overview>
Design (original) <docs/design>
docs/developers
Notes about the MySQL Database backend <docs/mysql>
Notes about the PostgreSQL Database backend <docs/postgresql>
Richard Jones implementation notes <docs/implementation>
docs/security-history
to keep them out of the docs.txt sidebar.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 11 May 2023 13:50:57 -0400 |
| parents | 2a735d785836 |
| children | f3c9ba5db30b |
line wrap: on
line source
.. meta:: :description: Reference for the internals of Roundup. Includes background information for cookbook and how-to examples. Reference for the design and internals needed to understand and extend the examples to meet new needs. :tocdepth: 2 ================= Roundup Reference ================= .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx .. contents:: :depth: 2 :local: Welcome ======= This document used to be part of the `customization document`_. The customization document was getting large and unwieldy. It was a combination of examples and internal information that made finding information difficult. We often had questions on the mailing list that were well answered in the customization document, but finding the info was difficult. The documentation is slowly being reorganized using the `Diataxis framework`_. Help with the reorganization is welcome. This is the document you should look at for background on a tutorial or how-to guide in the customization document. .. _customization document: customizing.html .. _diataxis framework: https://diataxis.fr/