Skip to content

Commit a7d3921

Browse files
committed
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.
1 parent aff1fbe commit a7d3921

File tree

5 files changed

+46
-41
lines changed

5 files changed

+46
-41
lines changed

doc/debugging.txt

Lines changed: 0 additions & 23 deletions
This file was deleted.

doc/developers.txt

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,24 @@ attached to an issue in our tracker are preferred.
164164
Debugging Aids
165165
--------------
166166

167-
See :doc:`debugging <debugging>`.
167+
Try turning on logging of DEBUG level messages. This may be done a number
168+
of ways, depending on what it is you're testing:
169+
170+
1. If you're testing the database unit tests, then set the environment
171+
variable ``LOGGING_LEVEL=DEBUG``. This may be done like so:
172+
173+
LOGGING_LEVEL=DEBUG python -m pytest test/
174+
175+
This variable replaces the older HYPERDBDEBUG environment var.
176+
177+
2. If you're testing a particular tracker, then set the logging level in
178+
your tracker's ``config.ini``.
179+
180+
If you set the environment variable SENDMAILDEBUG to a filename,
181+
roundup will write each email message that it sends to that file
182+
instead to the internet. This environment variable is independent of
183+
the python -O flag.
184+
168185

169186
Internationalization Notes
170187
--------------------------

doc/security-history.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:orphan:
66

7-
===================
8-
Security Mechanisms
9-
===================
7+
=============================
8+
Old Security Mechanisms Notes
9+
=============================
1010

1111
Current situation
1212
=================

website/www/docs.txt

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,11 @@ Docs
1616
docs/FAQ
1717
docs/user_guide
1818
docs/customizing
19-
docs/reference
20-
docs/admin_guide
21-
docs/security-history
22-
docs/upgrading-history
23-
docs/debugging
24-
docs/xmlrpc
2519
docs/rest
26-
docs/tracker_templates
20+
docs/xmlrpc
21+
docs/reference
2722
docs/glossary
28-
docs/acknowledgements
23+
docs/admin_guide
2924
docs/license
30-
Design Overview <docs/overview>
31-
Design (original) <docs/design>
32-
docs/developers
33-
Notes about the MySQL Database backend <docs/mysql>
34-
Notes about the PostgreSQL Database backend <docs/postgresql>
35-
Richard Jones implementation notes <docs/implementation>
25+
docs/acknowledgements
26+
olderdocs

website/www/olderdocs.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Other Docs
2+
==========
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
docs/upgrading-history
8+
9+
docs/tracker_templates
10+
11+
Design Overview <docs/overview>
12+
Design (original) <docs/design>
13+
14+
docs/developers
15+
16+
Notes about the MySQL Database backend <docs/mysql>
17+
Notes about the PostgreSQL Database backend <docs/postgresql>
18+
19+
Richard Jones implementation notes <docs/implementation>
20+
docs/security-history

0 commit comments

Comments
 (0)