Populate index with section topics

Closes #1122
datalad-handbook · Dec 1, 2023 · aabff48 · aabff48
1 parent 9cec494
commit aabff48
Show file tree

Hide file tree

Showing 25 changed files with 58 additions and 1 deletion.
diff --git a/docs/basics/101-102-populate.rst b/docs/basics/101-102-populate.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: populate dataset; with DataLad
 .. _populate:
 
 Populate a dataset

diff --git a/docs/basics/101-103-modify.rst b/docs/basics/101-103-modify.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: modify dataset; with DataLad
 .. _modify:
 
 Modify content

diff --git a/docs/basics/101-108-run.rst b/docs/basics/101-108-run.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: provenance tracking; with DataLad
 .. _run:
 
 Keeping track

diff --git a/docs/basics/101-109-rerun.rst b/docs/basics/101-109-rerun.rst
@@ -1,5 +1,6 @@
 .. index::
    pair: rerun; DataLad command
+   pair: reproducibility; with DataLad
 .. _run2:
 
 DataLad, rerun!

diff --git a/docs/basics/101-110-run2.rst b/docs/basics/101-110-run2.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: provenance tracking; with DataLad
 .. _run3:
 
 Input and output

diff --git a/docs/basics/101-112-run4.rst b/docs/basics/101-112-run4.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: provenance tracking; with DataLad
 .. _run5:
 
 Clean desk

diff --git a/docs/basics/101-115-symlinks.rst b/docs/basics/101-115-symlinks.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: data file handling; with git-annex
 .. _2-002:
 .. _symlink:
 

diff --git a/docs/basics/101-116-sharelocal.rst b/docs/basics/101-116-sharelocal.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: data sharing; with DataLad
 .. _sharelocal1:
 
 Looking without touching

diff --git a/docs/basics/101-117-sharelocal2.rst b/docs/basics/101-117-sharelocal2.rst
@@ -1,3 +1,6 @@
+.. index::
+   pair: data sharing; with DataLad
+   pair: data availability tracking; with git-annex
 .. _sharelocal2:
 
 Where's Waldo?

diff --git a/docs/basics/101-118-sharelocal3.rst b/docs/basics/101-118-sharelocal3.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: reproducibility; with DataLad
 .. _sharelocal3:
 
 Retrace and reenact

diff --git a/docs/basics/101-119-sharelocal4.rst b/docs/basics/101-119-sharelocal4.rst
@@ -1,5 +1,6 @@
+.. index::
+   pair: update dataset; with DataLad
 .. _sharelocal4:
-
 .. _update:
 
 Stay up to date

diff --git a/docs/basics/101-121-siblings.rst b/docs/basics/101-121-siblings.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: update dataset; with DataLad
 .. _sibling:
 
 Networking

diff --git a/docs/basics/101-122-config.rst b/docs/basics/101-122-config.rst
@@ -1,3 +1,6 @@
+.. index::
+   pair: configuration; with Git
+   pair: configuration; with DataLad
 .. _config:
 
 Local configuration

diff --git a/docs/basics/101-123-config2.rst b/docs/basics/101-123-config2.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: dataset configuration; with DataLad
 .. _config2:
 
 Shipping and overriding configuration

diff --git a/docs/basics/101-124-procedures.rst b/docs/basics/101-124-procedures.rst
@@ -1,4 +1,5 @@
 .. index:: ! procedures, run-procedures
+   pair: standardized configuration; with DataLad
 .. _procedures:
 
 Configurations to go

diff --git a/docs/basics/101-127-yoda.rst b/docs/basics/101-127-yoda.rst
@@ -1,4 +1,6 @@
 .. index:: ! YODA principles
+   pair: data organization; with DataLad
+   pair: project management; with DataLad
 .. _2-001:
 .. _yoda:
 

diff --git a/docs/basics/101-130-yodaproject.rst b/docs/basics/101-130-yodaproject.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: data analysis; with DataLad
 .. _yoda_project:
 
 YODA-compliant data analysis projects

diff --git a/docs/basics/101-133-containersrun.rst b/docs/basics/101-133-containersrun.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: containerized data analysis; with DataLad
 .. _containersrun:
 
 Computational reproducibility with software containers

diff --git a/docs/basics/101-135-help.rst b/docs/basics/101-135-help.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: get help; with DataLad
 .. _help:
 
 When things go wrong

diff --git a/docs/basics/101-136-filesystem.rst b/docs/basics/101-136-filesystem.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: dataset operations; with DataLad
 .. _file system:
 
 Dataset ops

diff --git a/docs/basics/101-139-hostingservices.rst b/docs/basics/101-139-hostingservices.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: push to Git hosting; with DataLad
 .. _share_hostingservice:
 
 Publishing datasets to Git repository hosting

diff --git a/docs/basics/101-139-privacy.rst b/docs/basics/101-139-privacy.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: sensitive data handling; with DataLad
 .. _privacy:
 
 Keeping (some) dataset contents private

diff --git a/docs/basics/101-141-push.rst b/docs/basics/101-141-push.rst
@@ -1,5 +1,6 @@
 .. index::
    pair: push; DataLad command
+   pair: distribute dataset; with DataLad
 .. _push:
 
 The datalad push command

diff --git a/docs/intro/executive_summary.rst b/docs/intro/executive_summary.rst
@@ -1,3 +1,5 @@
+.. index::
+   pair: what is; DataLad
 .. _executive_summary:
 
 What you really need to know

diff --git a/docs/intro/howto.rst b/docs/intro/howto.rst
@@ -1,4 +1,7 @@
 .. index:: ! terminal, ! shell, ! command Line
+   pair: what is; command line
+   pair: what is; terminal
+   pair: what is; shell
 .. _howto:
 
 ****************
@@ -148,6 +151,9 @@ Windows systems
     Set an :term:`environment variable` ``NAME`` to ``Value`` for your current terminal session
 
 
+.. index:: ! paths
+   pair: what is; prompt
+
 The prompt
 ==========
 When you first login on the command line, you are greeted with "the prompt",
@@ -164,6 +170,7 @@ the reader to quickly differentiate between lines containing commands vs the
 output of those commands.
 
 .. index:: ! paths
+   pair: what is; path
 
 Paths
 =====
@@ -274,6 +281,8 @@ In order to quickly get home, you could use
 
 More information on Windows paths can be found `here <https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file>`_.
 
+.. index:: text editor
+
 Text editors
 ============
 
@@ -307,6 +316,8 @@ A good graphical alternative is Notepad++, a powerful Windows-native text editor
 You may either be able to configure this during the installation, of afterwards by running ``git config core.editor notepad``.
 
 
+.. index:: shell
+
 Shells
 ======