view website/www/docs.txt @ 8064:d6b447de4f59

docs: set up for release documentation. Make changes to publish security.html with CVE announcements referring to the sections in upgrading.html rather than CVE.html. Remove templates.zip as part of html build in Makefile. Also update doc for using CVE.html.
author John Rouillard <rouilj@ieee.org>
date Tue, 09 Jul 2024 09:34:13 -0400
parents e3b34d02c61a
children 78b13272d41b
line wrap: on
line source

.. meta::
    :description:
        Table of contents for published documentation on the Roundup
        Issue Tracker.

Docs
====

.. admonition:: Welcome

   The documentation is slowly being reorganized using the `Diataxis
   framework`_. Help with the reorganization is welcome. If a page you
   used to see is missing, try checking the `Other Docs
   <olderdocs.html>`_ page.

See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
documentation.

.. _diataxis framework: https://diataxis.fr/

.. toctree::
   :maxdepth: 2

   Features <docs/features>
   Installation <docs/installation>
   Upgrading to Newer Versions <docs/upgrading>
   Security Issues <docs/security>
   FAQ <docs/FAQ>
   User's Guide <docs/user_guide>
   Customising <docs/customizing>
   Rest API <docs/rest>
   XML-RPC API <docs/xmlrpc>
   Reference <docs/reference>
   Glossary <docs/glossary>
   docs/admin_guide
   docs/man_pages
   docs/license
   docs/acknowledgements
   olderdocs

Roundup Issue Tracker: http://roundup-tracker.org/