accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [1/2] accumulo-website git commit: Added more links between pages and javadocs
Date Thu, 25 May 2017 14:22:55 GMT
Repository: accumulo-website
Updated Branches:
  refs/heads/asf-site a3b641318 -> 2c7f1e8cd
  refs/heads/master 8939ce98f -> 29778dd0d


Added more links between pages and javadocs


Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/29778dd0
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/29778dd0
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/29778dd0

Branch: refs/heads/master
Commit: 29778dd0df167593b4b70ed39c70a5312eeee955
Parents: 8939ce9
Author: Mike Walch <mwalch@apache.org>
Authored: Thu May 25 10:21:02 2017 -0400
Committer: Mike Walch <mwalch@apache.org>
Committed: Thu May 25 10:21:02 2017 -0400

----------------------------------------------------------------------
 _docs-unreleased/getting-started/clients.md     |  2 +-
 _docs-unreleased/getting-started/design.md      | 23 +++++++----
 .../getting-started/table_configuration.md      | 43 +++++++++++---------
 3 files changed, 38 insertions(+), 30 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/29778dd0/_docs-unreleased/getting-started/clients.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/getting-started/clients.md b/_docs-unreleased/getting-started/clients.md
index 4b3a497..88d4a13 100644
--- a/_docs-unreleased/getting-started/clients.md
+++ b/_docs-unreleased/getting-started/clients.md
@@ -387,7 +387,7 @@ client.closeScanner(scanner);
 [Mutation]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Mutation.html
 [BatchWriter]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/BatchWriter.html
 [ConditionalWriter]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.html
-[Scanner]: {{ page.javadoc_core }}org/apache/accumulo/core/client/Scanner.html
+[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html
 [IsolatedScanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/IsolatedScanner.html
 [BatchScanner]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/BatchScanner.html
 [Range]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Range.html

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/29778dd0/_docs-unreleased/getting-started/design.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/getting-started/design.md b/_docs-unreleased/getting-started/design.md
index 251ae9f..01c015e 100644
--- a/_docs-unreleased/getting-started/design.md
+++ b/_docs-unreleased/getting-started/design.md
@@ -67,8 +67,8 @@ and the others will become backups if the master should fail.
 
 The Accumulo Tracer process supports the distributed timing API provided by Accumulo.
 One to many of these processes can be run on a cluster which will write the timing
-information to a given Accumulo table for future reference. Seeing the section on
-Tracing for more information on this support.
+information to a given Accumulo table for future reference. See the
+[tracing documentation][tracing] for more information.
 
 ### Monitor
 
@@ -86,9 +86,8 @@ at one time. Leader election will be performed internally to choose the
active M
 
 ### Client
 
-Accumulo includes a client library that is linked to every application. The client
-library contains logic for finding servers managing a particular tablet, and
-communicating with TabletServers to write and retrieve key-value pairs.
+Accumulo has a client library that can be used to write applications that write and read
+data to/from Accumulo. See the [Accumulo clients documentation][clients] for more information.
 
 ## Data Management
 
@@ -126,7 +125,8 @@ performs Major Compactions of files within a tablet, in which some set
of RFiles
 are combined into one file. The previous files will eventually be removed by the
 Garbage Collector. This also provides an opportunity to permanently remove
 deleted key-value pairs by omitting key-value pairs suppressed by a delete entry
-when the new file is created.
+when the new file is created. See the [compaction documentation][compaction]
+for more information.
 
 ## Splitting
 
@@ -142,8 +142,8 @@ writes giving better initial performance without waiting for automatic
 splitting.
 
 As data is deleted from a table, tablets may shrink. Over time this can lead
-to small or empty tablets. To deal with this, merging of tablets was
-introduced in Accumulo 1.4. This is discussed in more detail later.
+to small or empty tablets. To deal with this, the [merging of tablets][merging]
+was introduced in Accumulo 1.4.
 
 ## Fault-Tolerance
 
@@ -162,4 +162,9 @@ TabletServer failures are noted on the Master's monitor page, accessible
via
 
 ![failure handling]({{ site.url }}/images/docs/failure_handling.png)
 
-[monitor]: {{page.docs_baseurl}}/administration/overview#monitoring
+[monitor]: {{page.docs_baseurl}}/administration/monitoring-metrics#monitoring
+[tracing]: {{page.docs_baseurl}}/administration/tracing
+[clients]: {{page.docs_baseurl}}/getting-started/clients
+[merging]: {{page.docs_baseurl}}/getting-started/table_configuration#merging-tablets
+[compaction]: {{page.docs_baseurl}}/getting-started/table_configuration#compaction
+

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/29778dd0/_docs-unreleased/getting-started/table_configuration.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/getting-started/table_configuration.md b/_docs-unreleased/getting-started/table_configuration.md
index 9b629fc..4a0f5a3 100644
--- a/_docs-unreleased/getting-started/table_configuration.md
+++ b/_docs-unreleased/getting-started/table_configuration.md
@@ -7,18 +7,18 @@ order: 5
 Accumulo tables have a few options that can be configured to alter the default
 behavior of Accumulo as well as improve performance based on the data stored.
 These include locality groups, constraints, bloom filters, iterators, and block
-cache.  See the [configuration documentation][config] for a complete list of
-available configuration options.
+cache.  See the [configuration properties documentation][config-properties] for
+a complete list of available configuration options.
 
 ## Locality Groups
 
 Accumulo supports storing sets of column families separately on disk to allow
 clients to efficiently scan over columns that are frequently used together and to avoid
 scanning over column families that are not requested. After a locality group is set,
-Scanner and BatchScanner operations will automatically take advantage of them
+[Scanner] and [BatchScanner] operations will automatically take advantage of them
 whenever the fetchColumnFamilies() method is used.
 
-By default, tables place all column families into the same ``default'' locality group.
+By default, tables place all column families into the same `default` locality group.
 Additional locality groups can be configured at any time via the shell or
 programmatically as follows:
 
@@ -446,24 +446,23 @@ compact tablets that overlap the given row range.
 ### Compaction Strategies
 
 The default behavior of major compactions is defined in the class DefaultCompactionStrategy.

-This behavior can be changed by overriding the following property with a fully qualified
class name:
-
-    table.majc.compaction.strategy
+This behavior can be changed by overriding [table.majc.compaction.strategy] with a fully
+qualified class name.
 
 Custom compaction strategies can have additional properties that are specified following
the prefix property:
 
     table.majc.compaction.strategy.opts.*
 
 Accumulo provides a few classes that can be used as an alternative compaction strategy. These
classes are located in the 
-org.apache.accumulo.tserver.compaction.* package. EverythingCompactionStrategy will simply
compact all files. This is the 
-strategy used by the user "compact" command. SizeLimitCompactionStrategy compacts files no
bigger than the limit set in the
-property table.majc.compaction.strategy.opts.sizeLimit. 
+`org.apache.accumulo.tserver.compaction.*` package. `EverythingCompactionStrategy` will simply
compact all files. This is the 
+strategy used by the user `compact` command. `SizeLimitCompactionStrategy` compacts files
no bigger than the limit set in the
+property `table.majc.compaction.strategy.opts.sizeLimit`. 
 
-TwoTierCompactionStrategy is a hybrid compaction strategy that supports two types of compression.
If the total size of 
-files being compacted is larger than table.majc.compaction.strategy.opts.file.large.compress.threshold
than a larger 
-compression type will be used. The larger compression type is specified in table.majc.compaction.strategy.opts.file.large.compress.type.

-Otherwise, the configured table compression will be used. To use this strategy with minor
compactions set table.file.compress.type=snappy 
-and set a different compress type in table.majc.compaction.strategy.opts.file.large.compress.type
for larger files.
+`TwoTierCompactionStrategy` is a hybrid compaction strategy that supports two types of compression.
If the total size of 
+files being compacted is larger than `table.majc.compaction.strategy.opts.file.large.compress.threshold`
than a larger 
+compression type will be used. The larger compression type is specified in `table.majc.compaction.strategy.opts.file.large.compress.type`.

+Otherwise, the configured table compression will be used. To use this strategy with minor
compactions set `table.file.compress.type=snappy` 
+and set a different compress type in `table.majc.compaction.strategy.opts.file.large.compress.type`
for larger files.
 
 ## Pre-splitting tables
 
@@ -479,7 +478,7 @@ In the shell:
     root@myinstance> addsplits -t newTable g n t
 
 This will create a new table with 4 tablets. The table will be split
-on the letters ``g'', ``n'', and ``t'' which will work nicely if the
+on the letters `g`, `n`, and `t` which will work nicely if the
 row data start with lower-case alphabetic characters. If your row
 data includes binary information or numeric information, or if the
 distribution of the row information is not flat, then you would pick
@@ -498,7 +497,7 @@ window of current information, tablets for older rows may be empty.
 
 Accumulo supports tablet merging, which can be used to reduce
 the number of split points. The following command will merge all rows
-from ``A'' to ``Z'' into a single tablet:
+from `A` to `Z` into a single tablet:
 
     root@myinstance> merge -t myTable -s A -e Z
 
@@ -532,7 +531,7 @@ faster to set the split point and merge the entire table:
 ## Delete Range
 
 Consider an indexing scheme that uses date information in each row.
-For example ``20110823-15:20:25.013'' might be a row that specifies a
+For example `20110823-15:20:25.013` might be a row that specifies a
 date and time. In some cases, we might like to delete rows based on
 this date, say to remove all the data older than the current year.
 Accumulo supports a delete range operation which efficiently
@@ -540,8 +539,8 @@ removes data between two rows. For example:
 
     root@myinstance> deleterange -t myTable -s 2010 -e 2011
 
-This will delete all rows starting with ``2010'' and it will stop at
-any row starting ``2011''. You can delete any data prior to 2011
+This will delete all rows starting with `2010` and it will stop at
+any row starting `2011`. You can delete any data prior to 2011
 with:
 
     root@myinstance> deleterange -t myTable -e 2011 --force
@@ -663,3 +662,7 @@ for example code.
 [combiner]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Combiner.html
 [combiner-example]: https://github.com/apache/accumulo-examples/blob/master/docs/combiner.md
 [filter]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Filter.html
+[table.majc.compaction.strategy]: {{ page.docs_baseurl}}/administration/configuration-properties#table_majc_compaction_strategy
+[config-properties]: {{ page.docs_baseurl}}/administration/configuration-properties
+[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html
+[BatchScanner]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/BatchScanner.html


Mime
View raw message