svn commit: r1804415 - /jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/oak-run-indexing.md

[ch...@apache.org]

Author: chetanm
Date: Tue Aug  8 13:05:24 2017
New Revision: 1804415

URL: http://svn.apache.org/viewvc?rev=1804415&view=rev
Log:
OAK-6471 - Support adding or updating index definitions via oak-run

Updates based on suggestion from Paul Chibulcuteanu

-- Fix command
-- Clarify that this command requires a matching version of oak-run
   with target repo

Modified:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/oak-run-indexing.md

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/oak-run-indexing.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/oak-run-indexing.md?rev=1804415&r1=1804414&r2=1804415&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/oak-run-indexing.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/oak-run-indexing.md Tue Aug  8 13:05:24 2017
@@ -210,7 +210,7 @@ checkpoint creation, indexing and import
 Index tooling support updating and adding new index definitions to existing setups. This can be done by passing 
 in path of a json file which contains index definitions
 
-    java -jar oak-run*.jar index index --reindex --index-paths=/oak:index/newAssetIndex \
+    java -jar oak-run*.jar index --reindex --index-paths=/oak:index/newAssetIndex \
     --index-definitions-file=index-definitions.json \
     --fds-path=/path/to/datastore /path/to/segmentstore  
    
@@ -253,6 +253,8 @@ Some points to note about this json file
 * In case of new index it must be ensured that parent path structure must already exist in repository. 
   So if a new index is being created at `/content/en/oak:index/contentIndex` then path upto  `/content/en/oak:index`
   should already exist in repository
+* If this option is used with online indexing then do ensure that oak-run version matches with the Oak version 
+  used by target repository
 
 You can also use the json file generated from [Oakutils](http://oakutils.appspot.com/generate/index). It needs to be 
 modified to confirm to above structure i.e. enclose the whole definition under the intended index path key.
@@ -261,7 +263,7 @@ In general the index definitions does no
 only String, Long and Double types mostly. However if the index refers to binary config like Tika config then
 the binary data would need to encoded. Refer to next section for more details.
     
-This option is supported in both online and out-of-band indexing.
+This option is supported in both online and out-of-band indexing. 
 
 For more details refer to [OAK-6471][OAK-6471]