view website/www/docs.txt @ 8063:6d4b5005abf2

docs: changes to website docs to announce CVE's Changes to the website doc generation to create CVE.html by extracing secions from upgrading.txt. It also allows overriding the release version that is displayed in the web page titles. It also adds support for making a zipfile (which is better supported on windows that a tarball) of the templates needed to address the CVE in the tracker home html files The next commit for this directory will remove the generation of the CVE.html file as CVE remediation/scope issue will be in the upgrading.html document. It will also remove generation of templates.zip.
author John Rouillard <rouilj@ieee.org>
date Tue, 09 Jul 2024 09:12:29 -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/