Merge pull request #34 from intermine/uosl-patch-1

Document additional properties used by bluegenes
intermine · Sep 26, 2019 · c43713b · c43713b
2 parents bb73b25 + 36ca698
commit c43713b
Showing 1 changed file with 17 additions and 11 deletions.
diff --git a/docs/webapp/blue-genes/index.rst b/docs/webapp/blue-genes/index.rst
@@ -1,10 +1,10 @@
-Guide to Customising Blue Genes
+Guide to Customising BlueGenes
 ================================================================
 
-Blue genes content
+Content
 ------------------------
 
-Certain features of the blue genes app are controlled by parameters set in the `web.properties` file. These properties are also used in the current webapp user interface.
+Certain features of the BlueGenes app are controlled by parameters set in the `web.properties` file. These properties are also used in the current webapp user interface.
 
 =======================================  ================================================  =======================================  
 purpose                                  parameters                                        example
@@ -18,16 +18,22 @@ default keyword search                   quickSearch.identifiers
 
 Please see :doc:`/webapp/properties/web-properties` for details on these parameters.
 
-Tool location
+Environment
 ------------------------
 
-To specify a location for your JavaScript tools to be used in your BlueGenes instance, set this parameter in your `~/.intermine/$MINE.properties` file.
-
-================================== ================================== ==================================
-purpose                            parameters                         example
-================================== ================================== ==================================
-location of JavaScript tools       bluegenes.toolLocation             `/intermine/tools/node_modules/`
-================================== ================================== ==================================
+BlueGenes uses the following parameters defined in the `~/.intermine/$MINE.properties` file.
+
++----------------------------------------------------------------------+------------------------+-----------------------------------+
+| purpose                                                              | parameters             | example                           |
++======================================================================+========================+===================================+
+| location of JavaScript tools                                         | bluegenes.toolLocation | `/intermine/tools/node_modules/`  |
++----------------------------------------------------------------------+------------------------+-----------------------------------+
+| base URL for requests to the InterMine instance                      | webapp.baseurl         | `http://www.flymine.org`          |
++----------------------------------------------------------------------+------------------------+-----------------------------------+
+| path appended to the base URL                                        | webapp.path            | `flymine`                         |
++----------------------------------------------------------------------+------------------------+-----------------------------------+
+| name of your InterMine instance as it will be displayed in BlueGenes | project.title          | `BioTestMine`                     |
++----------------------------------------------------------------------+------------------------+-----------------------------------+
 
 Please see :doc:`/webapp/properties/intermine-properties` for details on this property file.