Changeset 6259

Timestamp:

06/01/15 14:17:15 (9 years ago)

Author:

Twan Goosen

Message:

merged updates to readme files

Location:

vlo/branches/vlo-3.2

Files:

• . (modified) (1 prop)
• DEPLOY-README.txt (modified) (1 diff)
• README.txt (modified) (3 diffs)

vlo/branches/vlo-3.2/DEPLOY-README.txt

@@ -204 +204 @@
         ./vlo_solr_importer.sh
 
-   script in the vlo/bin directory. Messages are logged to the console. Because 
-   meta data is not static, it is recommended to run the importer a couple of 
-   times a week. Please note that, given the current (04.2014) set of data, a  
-   run typically takes between two and four hours.
+   script in the vlo/bin directory. Messages are logged to the a log file. 
+   Because meta data is not static, it is recommended to run the importer a 
+   couple of times a week. Please note that, given the current (04.2014) set of
+   data, a  run typically takes between two and four hours.
+   
+   More information about running the importer can be found in the README.txt
+   file.
+   

vlo/branches/vlo-3.2/README.txt

@@ +1 @@
+= Table of Contents =
+- What is the VLO? 
+- What should I read? 
+- Setting up
+        - Preparing for release
+- Using the VLO
+        - Running an import
+        
 = What is the VLO? =
 
@@ -26 +34 @@
 Some general development notes.
 
-== Setting up ==
+= Setting up =
 
 Follow the instructions in DEPLOY-README to set up a development environment.
@@ -82 +90 @@
 files.
 
+= Using the VLO =
+
+After a successful deployment and configuration, you should be able to browse to
+the VLO web app and browse the imported records.
+
+If the VLO is empty, you will need to run an import first. 
+
+== Running an import ==
+
+To run an import, go the 'bin' child directory of the VLO application directory 
+and run
+
+        ./vlo_solr_importer.sh
+        
+as the appropriate user (e.g. 'vlouser'). 
+
+It's advisable to run this in a detached background process (for example using 
+"screen") because an import can take quite a long time depending on the amount
+of records to be imported.
+
+Some progress information is logged to a file 'log/vlo-importer.log'. It gets
+rotated automatically by the import process.