update #72

proycon · Nov 19, 2018 · 80bd62c · 80bd62c
1 parent 6148ab4
commit 80bd62c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/docs/source/gettingstarted.rst b/docs/source/gettingstarted.rst
@@ -3,6 +3,8 @@
 Getting Started
 =================
 
+Make sure you have first read the :ref:`introduction` so you understand what CLAM is and what it's architecture is like.
+
 You start a new CLAM webservice project using the ``clamnewproject`` tool. The tool
 generates all the necessary files, which you have to edit. The tool
 takes one argument: an identifier for your system. This identifier is

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,3 +1,5 @@
+.. _introduction:
+
 Introduction
 ================================
 

diff --git a/docs/source/restapi.rst b/docs/source/restapi.rst
@@ -18,6 +18,7 @@ CLAM.
 :Request Parameters:  (none)
 :Response: ``200 - OK`` & CLAM XML, ``401 - Unauthorised``
 
+
 :Endpoint: ``/[project]/``
 :Method: ``GET``
 :Request Parameters: (none)
@@ -61,6 +62,7 @@ CLAM.
 :Description: Deletes a project. Any running processes will be
   aborted.
 
+
 :Endpoint: ``/[project]/input/[filename]``
 :Method: ``GET``
 :Request Parameters: (none)
@@ -101,6 +103,7 @@ CLAM.
   setting ``metadata`` to the full XML string of the metadata
   specification.
 
+
 :Endpoint: ``/[project]/output/[filename]``
 :Method: ``GET``
 :Request Parameters: (none)
@@ -113,6 +116,7 @@ CLAM.
   ``404 - Not Found``
 :Description: Deletes the specified output file.
 
+
 :Endpoint: ``/[project]/output/[filename]/metadata``
 :Method: ``GET``
 :Request Parameters: (none)
@@ -121,13 +125,15 @@ CLAM.
 :Description: Retrieves the metadata for the specified output
   file.
 
+
 :Endpoint: ``/[project]/input/[filename]/metadata``
 :Method: ``GET``
 :Request Parameters: (none)
 :Response: ``200 - OK`` & CLAM Metadata XML,
   ``401 - Unauthorised``, ``404 - Not Found``
 :Description: Retrieves the metadata for the specified input file.
 
+
 :Endpoint: ``/[project]/output/``
 :Method: ``GET``
 :Request Parameters: ``format=zip|tar.gz|tar.bz2``
@@ -141,6 +147,7 @@ CLAM.
 :Description: Deletes all output files and resets the project for
   another run.
 
+
 :Endpoint: ``/actions/[action_id]/``
 :Method: ``GET`` and/or ``POST``, may be constrained by the action
 :Request Parameters: Determined by the action
@@ -150,11 +157,15 @@ CLAM.
   action and obtain the results. The parameters are specific to the
   action.
 
-| \|l|p10cm\| & **Project entry shortcut**
-| & This is a shortcut method (available since CLAM v0.99.17) that
+Project entry shortcut
+---------------------------
+
+This is a shortcut method (available since CLAM v0.99.17) that
   combines the steps of project creation, file adding and upload, in one
   single GET or POST request. Although more limited than the invididual
-  calls, and less RESTful, it facilitates the job for simpler callers.
+  calls, and less RESTful, it facilitates the job for simpler callers:
+
+
 :Endpoint: ``/``
 :Method: ``GET`` or ``POST``
 :Request Parameters: ``project=[name|new]`` (mandatory), selects