Mercurial > p > roundup > code

annotate website/www/docs.txt @ 7399:deb8e7e6d66d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Skip redis tests if unable to communicate with the server. If the redis module is in the test environment, the redis tests will not be skipped. If connecting to redis during testing fails with a ConnectionError because there is no redis server at localhost, or if it fails with an AuthenticationError, you would fail a slew of tests. This causes the tests to report as skipped if either of the two errors occurs. It is very inefficient as it fails in setup() for the tests, but at least it does report skipping the tests. Also documented how to pass the redis password to the tests in the test part of the install docs. Future note: running tests needs proper docs in development.txt (including database setup) and a link left to that doc in installation.txt.
author John Rouillard <rouilj@ieee.org>
date Wed, 24 May 2023 12:52:53 -0400
parents 79fd1bf20543
children e3b35dcf0dcb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7048
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
1 .. meta::
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
2 :description:
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
3 Table of contents for published documentation on the Roundup
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
4 Issue Tracker.
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
5
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
6 Docs
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
7 ====
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
8
7358
79fd1bf20543 add welcome preface on reorg to pages
John Rouillard <rouilj@ieee.org>
parents: 7339
diff changeset
9 .. admonition:: Welcome
79fd1bf20543 add welcome preface on reorg to pages
John Rouillard <rouilj@ieee.org>
parents: 7339
diff changeset
10
7328
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
11 The documentation is slowly being reorganized using the `Diataxis
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
12 framework`_. Help with the reorganization is welcome. If a page you
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
13 used to see is missing, try checking the `Other Docs
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
14 <olderdocs.html>`_ page.
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
15
7339
5eadba24e148 add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents: 7328
diff changeset
16 See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
5eadba24e148 add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents: 7328
diff changeset
17 documentation.
5eadba24e148 add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents: 7328
diff changeset
18
7328
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
19 .. _diataxis framework: https://diataxis.fr/
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
20
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
21 .. toctree::
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
22 :maxdepth: 2
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
23
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
24 docs/features
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
25 docs/installation
4610
e793eafba69c Documentation: Synced the doc/index.txt and docs.txt. Removed outdated contact.txt.
Bernhard Reiter <bernhard@intevation.de>
parents: 4441
diff changeset
26 docs/upgrading
7100
8a267e9827cc Integrate security.txt with website docs. Align TOCs.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
27 docs/security
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
28 docs/FAQ
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
29 docs/user_guide
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
30 docs/customizing
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
31 docs/rest
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
32 docs/xmlrpc
7283
1a0548b60c6b Update document TOC with security-history, reference, upgrading-history
John Rouillard <rouilj@ieee.org>
parents: 7100
diff changeset
33 docs/reference
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 4610
diff changeset
34 docs/glossary
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
35 docs/admin_guide
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 4610
diff changeset
36 docs/license
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
37 docs/acknowledgements
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
38 olderdocs
Roundup Issue Tracker: http://roundup-tracker.org/