accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [accumulo-website] branch master updated: Improved handling of prefix properties (#95)
Date Wed, 11 Jul 2018 21:08:12 GMT
This is an automated email from the ASF dual-hosted git repository.

mwalch pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 078a747  Improved handling of prefix properties (#95)
078a747 is described below

commit 078a747d12dc1d2afccab2494eac550e113e3c29
Author: Mike Walch <mwalch@apache.org>
AuthorDate: Wed Jul 11 17:08:10 2018 -0400

    Improved handling of prefix properties (#95)
---
 README.md                                            | 4 ++--
 _docs-2-0/administration/configuration-management.md | 5 ++---
 _docs-2-0/administration/in-depth-install.md         | 2 +-
 _docs-2-0/administration/tracing.md                  | 2 +-
 _docs-2-0/development/summaries.md                   | 2 +-
 _docs-2-0/getting-started/table_configuration.md     | 5 ++---
 _plugins/links.rb                                    | 2 +-
 7 files changed, 10 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 5d6d528..3cd5498 100644
--- a/README.md
+++ b/README.md
@@ -44,8 +44,8 @@ The source for these tags is at [_plugins/links.rb](_plugins/links.rb).
 | ----- | ---------------------- | -------------------------------------------------------------------------------
| ---------------------------------------------------- |
 | jlink | Creates Javadoc link   | Link text will be class name by default. Use `-f` for
full package + class name | `{% jlink -f org.apache.accumulo.core.client.Connector %}` |
 | jurl  | Creates Javadoc URL    | None                                                 
                          | `{% jurl org.apache.accumulo.core.client.Connector %}`     |
-| plink | Creates Property link  | Assumes server property by default. Use `-c` to link to
client properties       | `{% plink -c instance.name %}`                             |
-| purl  | Creates Property URL   | Default is servery property. Use `-c` to link to client
properties              | `{% purl instance.volumes %}`                             |
+| plink | Creates Property link  | Assumes server property by default. Use `-c` to link to
client properties. Accepts server property prefixes (i.e `table.*`)       | `{% plink -c instance.name
%}`                             |
+| purl  | Creates Property URL   | Default is server property. Use `-c` to link to client
properties. Accepts server property prefixes (i.e `table.*`)               | `{% purl instance.volumes
%}`                             |
 | dlink | Creates Documentation link | None                                             
                              | `{% dlink getting-stared/clients %}`                   |
 | durl  | Creates Documentation URL  | None                                             
                              | `{% durl troubleshooting/performance %}`                 
 |
 
diff --git a/_docs-2-0/administration/configuration-management.md b/_docs-2-0/administration/configuration-management.md
index 8577017..a3bc0fc 100644
--- a/_docs-2-0/administration/configuration-management.md
+++ b/_docs-2-0/administration/configuration-management.md
@@ -49,11 +49,11 @@ System properties consist of all [properties][props] with **zk mutable:
yes** in
 
     config -s PROPERTY=VALUE
 
-If a `table.*` property is set using this method, the value will apply to all tables except
those configured on per-table basis (which have higher precedence).
+If a {% plink table.* %} property is set using this method, the value will apply to all tables
except those configured on per-table basis (which have higher precedence).
 
 #### Zookeeper Table properties
 
-[Table properties][tableprops] consist of all properties with the `table.*` prefix.
+Table properties consist of all properties with the {% plink table.* %} prefix.
 
 Table properties are configured for a table namespace (i.e group of tables) or on a per-table
basis.
 
@@ -115,4 +115,3 @@ default  | table.failures.ignore ..................... | false
 [client-conn]: {% durl getting-started/clients#connecting %}
 [client-props]: {% durl development/client-properties %}
 [props]: {% durl administration/properties %}
-[tableprops]: {% purl table.prefix %}
diff --git a/_docs-2-0/administration/in-depth-install.md b/_docs-2-0/administration/in-depth-install.md
index d48c51c..ded15a8 100644
--- a/_docs-2-0/administration/in-depth-install.md
+++ b/_docs-2-0/administration/in-depth-install.md
@@ -303,7 +303,7 @@ or a `accumulo-client.properties` file containing [client properties][client-pro
 Accumulo has the ability for users to add custom tags to tables.  This allows
 applications to set application-level metadata about a table.  These tags can be
 anything from a table description, administrator notes, date created, etc.
-This is done by naming and setting a property with a prefix `table.custom.*`.
+This is done by naming and setting a property with a prefix {% plink table.custom.* %}.
 
 Currently, table properties are stored in ZooKeeper. This means that the number
 and size of custom properties should be restricted on the order of 10's of properties
diff --git a/_docs-2-0/administration/tracing.md b/_docs-2-0/administration/tracing.md
index a24f831..eb7cfb1 100644
--- a/_docs-2-0/administration/tracing.md
+++ b/_docs-2-0/administration/tracing.md
@@ -349,4 +349,4 @@ Time  Start  Service@Location       Name
 [trace.table]: {% purl trace.table %}
 [trace.zookeeper.path]: {% purl trace.zookeeper.path %}
 [trace.span.receivers]: {% purl trace.span.receivers %}
-[trace.span.receiver.*]: {% purl trace.span.receiver.prefix %}
+[trace.span.receiver.*]: {% purl trace.span.receiver.* %}
diff --git a/_docs-2-0/development/summaries.md b/_docs-2-0/development/summaries.md
index d8391db..4174fb1 100644
--- a/_docs-2-0/development/summaries.md
+++ b/_docs-2-0/development/summaries.md
@@ -51,7 +51,7 @@ The following tablet server and table properties configure summarization.
 * {% plink tserver.summary.partition.threads %}
 * {% plink tserver.summary.remote.threads %}
 * {% plink tserver.summary.retrieval.threads %}
-* [table.summarizer.*]({% purl table.summarizer.prefix %})
+* {% plink table.summarizer.* %})
 * {% plink table.file.summary.maxSize %}
 
 ## Permissions
diff --git a/_docs-2-0/getting-started/table_configuration.md b/_docs-2-0/getting-started/table_configuration.md
index aea6186..a5289fb 100644
--- a/_docs-2-0/getting-started/table_configuration.md
+++ b/_docs-2-0/getting-started/table_configuration.md
@@ -421,9 +421,8 @@ The default behavior of major compactions is defined in the class {% jlink
org.a
 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.*
+Custom compaction strategies can have additional properties that are specified with the
+{% plink table.majc.compaction.strategy.opts.* %} prefix.
 
 Accumulo provides a few classes that can be used as an alternative compaction strategy. These
classes are located in the 
 {% jlink -f org.apache.accumulo.tserver.compaction %} package. {% jlink org.apache.accumulo.tserver.compaction.EverythingCompactionStrategy
%}
diff --git a/_plugins/links.rb b/_plugins/links.rb
index 2c00279..c6e3866 100755
--- a/_plugins/links.rb
+++ b/_plugins/links.rb
@@ -107,7 +107,7 @@ def render_prop(context, text, link)
   if base.nil?
     base = context.registers[:site].config['docs_baseurl']
   end
-  prop_enc = prop.gsub('.', '_')
+  prop_enc = prop.gsub('.', '_').gsub('*', 'prefix')
   url = "#{base}/administration/properties##{prop_enc}"
   if type == 'client'
     url = "#{base}/development/client-properties##{prop_enc}"


Mime
View raw message