changeset 6174:5522c950a2e4

Add indexing for roundup-admin references.
author John Rouillard <rouilj@ieee.org>
date Sat, 16 May 2020 13:40:12 -0400
parents 82f58ae89142
children 72a69753f49a
files doc/customizing.txt doc/design.txt doc/installation.txt doc/upgrading.txt doc/user_guide.txt
diffstat 5 files changed, 31 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/doc/customizing.txt	Sat May 16 13:39:47 2020 -0400
+++ b/doc/customizing.txt	Sat May 16 13:40:12 2020 -0400
@@ -1004,6 +1004,8 @@
 setkey(property)
 ~~~~~~~~~~~~~~~~
 
+.. index:: roundup-admin; setting assignedto on an issue
+
 Select a String property of the class to be the key property. The key
 property must be unique, and allows references to the items in the class
 by the content of the key property. That is, we can refer to users by
@@ -1738,7 +1740,7 @@
     #   db.security.addPermissionToRole('Anonymous', 'Edit', cl)
 
 .. index::
-   single: roundup-admin; class permissions
+   single: roundup-admin; view class permissions
 
 You can use ``roundup-admin security`` to verify the permissions
 defined in the schema. It also verifies that properties specified in
@@ -4031,9 +4033,10 @@
 Populating the new category class
 :::::::::::::::::::::::::::::::::
 
-If you haven't initialised the database with the ``roundup-admin``
-"initialise" command, then you can add the following to the tracker
-``initial_data.py`` under the comment::
+If you haven't initialised the database with the
+"``roundup-admin initialise``" command, then you
+can add the following to the tracker ``initial_data.py``
+under the comment::
 
     # add any additional database creation steps here - but only if you
     # haven't initialised the database with the admin "initialise" command
@@ -4045,6 +4048,8 @@
      category.create(name="chaco")
      category.create(name="weave")
 
+.. index:: roundup-admin; create entries in class
+
 If the database has already been initalised, then you need to use the
 ``roundup-admin`` tool::
 
--- a/doc/design.txt	Sat May 16 13:39:47 2020 -0400
+++ b/doc/design.txt	Sat May 16 13:40:12 2020 -0400
@@ -1089,6 +1089,8 @@
 module.)
 
 
+.. index:: roundup-admin; command line specification
+
 Command Interface Specification
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1133,6 +1135,8 @@
 (with the -list) option.
 
 
+.. index:: roundup-admin; usage in scripts
+
 Usage Example
 ~~~~~~~~~~~~~
 
--- a/doc/installation.txt	Sat May 16 13:39:47 2020 -0400
+++ b/doc/installation.txt	Sat May 16 13:40:12 2020 -0400
@@ -67,6 +67,8 @@
   used if available. One of these is recommended if you are anticipating a
   large user base (see `choosing your backend`_ below).
 
+.. index:: roundup-admin:: reindex subcommand
+
 Xapian full-text indexer
   The Xapian_ full-text indexer is also supported and will be used by
   default if it is available. This is strongly recommended if you are
@@ -237,6 +239,8 @@
       environment variable or specify the full path to
       the command in the next step.
 
+   .. index:: roundup-admin; install subcommand
+
    c. Install a new tracker with the command ``roundup-admin install``.
       You will be asked a series of questions.  Descriptions of the provided
       templates can be found in `choosing your template`_ below.  Descriptions
@@ -277,6 +281,8 @@
       you've initialised the tracker - it's just better to have valid values
       for this stuff now.
 
+   .. index:: roundup-admin; initialise subcommand
+
    d. Initialise the tracker database with ``roundup-admin initialise``.
       You will need to supply an admin password at this step. You will be
       prompted::
@@ -377,7 +383,7 @@
 guide`_.
 
 Regardless of which backend you choose, Roundup will attempt to initialise
-a new database for you when you run the roundup-admin "initialise" command.
+a new database for you when you run the "``roundup-admin initialise``" command.
 In the case of MySQL and PostgreSQL you will need to have the appropriate
 privileges to create databases.
 
--- a/doc/upgrading.txt	Sat May 16 13:39:47 2020 -0400
+++ b/doc/upgrading.txt	Sat May 16 13:40:12 2020 -0400
@@ -27,6 +27,8 @@
 Migrating from 1.6.X to 2.0.0
 =============================
 
+.. index:: roundup-admin; updateconfig subcommand
+
 Upgrade tracker's config.ini file
 --------------------------------------
 Once you have installed the new roundup, use::
@@ -1512,6 +1514,8 @@
 Migrating from 1.4.x to 1.4.2
 =============================
 
+.. index:: roundup-admin; migrate subcommand
+
 You should run the "roundup-admin migrate" command for your tracker once
 you've installed the latest codebase.
 
--- a/doc/user_guide.txt	Sat May 16 13:39:47 2020 -0400
+++ b/doc/user_guide.txt	Sat May 16 13:40:12 2020 -0400
@@ -663,6 +663,11 @@
 
     imaps_cram username:password@server [mailbox]
 
+.. index:: ! roundup-admin
+   single: roundup-admin; usage
+   single: roundup-admin; data formats
+   pair: roundup-admin; designator
+
 Command Line Tool
 =================
 
@@ -780,6 +785,8 @@
 
 (for more details see https://issues.roundup-tracker.org/issue2550789.)
 
+.. index:: ! roundup-admin; usage in scripts
+
 Using with the shell
 --------------------
 

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