Fixed a few documentation typo's Signed-off-by: Aaron McCurry <[email protected]>
Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/1e8bcff2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/1e8bcff2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/1e8bcff2 Branch: refs/heads/master Commit: 1e8bcff2a21ceef6be5d6205bd5c308a46d1ffc2 Parents: 3d371b0 Author: Rahul Challapalli <[email protected]> Authored: Sun Aug 25 22:34:31 2013 -0700 Committer: Aaron McCurry <[email protected]> Committed: Mon Aug 26 07:16:16 2013 -0400 ---------------------------------------------------------------------- docs/Blur.html | 12 ++++++------ docs/cluster-setup.html | 4 ++-- docs/data-model.html | 6 +++--- docs/getting-started.html | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/1e8bcff2/docs/Blur.html ---------------------------------------------------------------------- diff --git a/docs/Blur.html b/docs/Blur.html index be57f80..6c8ce38 100644 --- a/docs/Blur.html +++ b/docs/Blur.html @@ -428,7 +428,7 @@ with the query options. </table><br/>The RowMutation defines how the given Record is to be mutated. <br/></p></section><section><div class="page-header"><h3 id="Struct_RowMutation">Struct: RowMutation</h3></div><p class="lead"> <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> -<tr><td>1</td><td>table</td><td><code>string</code></td><td>The that that the row mutation is to act upon. +<tr><td>1</td><td>table</td><td><code>string</code></td><td>The table that the row mutation is to act upon. </td><td>default</td><td></td></tr> <tr><td>2</td><td>rowId</td><td><code>string</code></td><td>The row id that the row mutation is to act upon. </td><td>default</td><td></td></tr> @@ -484,7 +484,7 @@ shards that are complete, etc. </table><br/>TableStats holds the statistics for a given table. <br/></p></section><section><div class="page-header"><h3 id="Struct_ColumnDefinition">Struct: ColumnDefinition</h3></div><p class="lead"> <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> -<tr><td>1</td><td>family</td><td><code>string</code></td><td>Required. The family the this column existing within. +<tr><td>1</td><td>family</td><td><code>string</code></td><td>Required. The family that this column exists within. </td><td>default</td><td></td></tr> <tr><td>2</td><td>columnName</td><td><code>string</code></td><td>Required. The column name. </td><td>default</td><td></td></tr> @@ -530,7 +530,7 @@ NOTE: This will index the column as a full text field in a default field, so tha </td><td>default</td><td></td></tr> <tr><td>10</td><td>blockCaching</td><td><code>bool</code></td><td>Should block cache be enable or disabled for this table. </td><td>default</td><td>1</td></tr> -<tr><td>11</td><td>blockCachingFileTypes</td><td><code>set<<code>string</code>></code></td><td>The files extensions that you would like to allow block cache to to cache. If null (default) everything is cached. +<tr><td>11</td><td>blockCachingFileTypes</td><td><code>set<<code>string</code>></code></td><td>The files extensions that you would like to allow block cache to cache. If null (default) everything is cached. </td><td>default</td><td></td></tr> <tr><td>12</td><td>readOnly</td><td><code>bool</code></td><td>If a table is set to be readonly, that means that mutates through Thrift are NOT allowed. However updates through MapReduce are allowed and in fact they are only allowed if the table is in readOnly mode. @@ -638,7 +638,7 @@ throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code> <pre><code>string</code> parseQuery(<code>string</code> table, <code><a href="Blur.html#Struct_Query">Query</a></code> query) throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code> -</pre>Parses the given query and return the string represents the query. +</pre>Parses the given query and returns the string that represents the query. @return string representation of the parsed query. <br/><br/><h4 id="Parameters_Blur_parseQuery">Parameters</h4> <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the table name. @@ -706,7 +706,7 @@ throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code> </table></p></section><section><div class="page-header"><h4 id="Fn_Blur_mutate">Function: Blur.mutate</h4></div><p class="lead"> <pre><code>void</code> mutate(<code><a href="Blur.html#Struct_RowMutation">RowMutation</a></code> mutation) throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code> -</pre>Mutates a Row given the RowMutation the is provided. +</pre>Mutates a Row given the RowMutation that is provided. <br/><br/><h4 id="Parameters_Blur_mutate">Parameters</h4> <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>mutation</td><td>the RowMutation. </td></tr> @@ -765,7 +765,7 @@ string and text field types. </td></tr> <tr><td>columnName</td><td>the column name. </td></tr> -<tr><td>startWith</td><td>the term to start with assuming that you paging through the term list. +<tr><td>startWith</td><td>the term to start with assuming that you are paging through the term list. </td></tr> <tr><td>size</td><td>the number to fetch at once. </td></tr> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/1e8bcff2/docs/cluster-setup.html ---------------------------------------------------------------------- diff --git a/docs/cluster-setup.html b/docs/cluster-setup.html index eae084d..8657acc 100644 --- a/docs/cluster-setup.html +++ b/docs/cluster-setup.html @@ -103,7 +103,7 @@ file: <p> <pre> -<code class="bash"># The ZooKeeper connection string, consider adding a root path to the string it +<code class="bash"># The ZooKeeper connection string, consider adding a root path to the string, it # can help when upgrading Blur. # Example: zknode1:2181,zknode2:2181,zknode3:2181/blur-0.2.0 # @@ -140,7 +140,7 @@ export HADOOP_HOME=<path to your Hadoop install directory></code> </div> <h3 id="controller-blur-site">blur-site.properties</h3> <p> - These are the default settings for the shard server that can be overridden in the blur-site.properties file. Consider increasing the various thread pool counts (*.thread.count). The blur.controller.server.remote.thread.count is very important to increase for larger clusters, basically one thread is used per shard server per query. Some production cluster have used set this thread pool to 2000 or more threads. + These are the default settings for the shard server that can be overridden in the blur-site.properties file. Consider increasing the various thread pool counts (*.thread.count). The blur.controller.server.remote.thread.count is very important to increase for larger clusters, basically one thread is used per shard server per query. Some production clusters have set this thread pool to 2000 or more threads. </p> <pre> <code class="bash"># Sets the hostname for the controller, if blank the hostname is automatically detected http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/1e8bcff2/docs/data-model.html ---------------------------------------------------------------------- diff --git a/docs/data-model.html b/docs/data-model.html index 3c23dec..1602f13 100644 --- a/docs/data-model.html +++ b/docs/data-model.html @@ -177,7 +177,7 @@ Let's say you want to find all the Rows that contain a Record with the family &q <h3 id="text_query">Text</h3> <p>Text fields are analyzed with Lucene's standard analyzers, which mean that the string is broken down into terms -and the terms capitalization is removed and well as any special punctuation. See Lucene's documentation for further explanation. +and the terms capitalization is removed as well as any special punctuation. See Lucene's documentation for further explanation. </p> <h4>Examples:</h4> <p> @@ -241,14 +241,14 @@ To run a query to find all the rows that contain a column with a starting value <h3 id="spatial_query">Spatial</h3> <p> Spatial queries are supported through the Lucene spatial module. There are currently three -different types of stragies: +different types of strategies: <ul> <li>Point Vector</li> <li>Term Query Prefix Tree</li> <li>Recursive Prefix Tree</li> </ul> Currently all of the built in spatial types are using a GEO spatial context, meaning the assumed -cooridates are on the planet Earth. Each of these strategies support different indexing features +coordinates are on the planet Earth. Each of these strategies support different indexing features such as the shapes they can index, the shapes they can query with, and the operations they support during the query. See the type section below to get a list of supported operations and shapes per strategy. http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/1e8bcff2/docs/getting-started.html ---------------------------------------------------------------------- diff --git a/docs/getting-started.html b/docs/getting-started.html index f7bc169..66f6432 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -178,7 +178,7 @@ localhost: Stopping ZooKeeper with pid [6650].</code></pre> <pre><code class="bash">$BLUR_HOME/bin/blur shell</code></pre> <p>You can also explicitly call out the controller servers.</p> <pre><code class="bash">$BLUR_HOME/bin/blur shell controller1:40010,controller2:40010</code></pre> - <p>Once in the shell, tables and be created, enabled, disabled, and removed. Type help to get a list of the commands.</p> + <p>Once in the shell, tables can be created, enabled, disabled, and removed. Type help to get a list of the commands.</p> </section> <section> <div class="page-header">
