From 3d427a4c591971864f61386ccd48fbbac4ed3f21 Mon Sep 17 00:00:00 2001 From: Christopher Tubbs Date: Tue, 10 Dec 2024 13:38:09 -0500 Subject: [PATCH] Fix code blocks in docs overview page * Fix missing block terminator (triple backticks), which caused the Table section to be included inside the block * Add language types for blocks for syntax highlighting * Replace 4-space indent with explicit backticks for blocks * Update some dependencies also This fixes #446 --- Gemfile.lock | 10 +++++----- _docs-2/configuration/overview.md | 17 ++++++++++++----- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 43374dd9b..065b4cdd1 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -52,8 +52,8 @@ GEM sass-embedded (~> 1.54) jekyll-watch (2.2.1) listen (~> 3.0) - kramdown (2.4.0) - rexml + kramdown (2.5.1) + rexml (>= 3.3.9) kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) @@ -68,7 +68,7 @@ GEM rb-inotify (0.11.1) ffi (~> 1.0) rexml (3.3.9) - rouge (4.4.0) + rouge (4.5.1) safe_yaml (1.0.5) sass-embedded (1.77.5-aarch64-linux-android) google-protobuf (>= 3.25, < 5.0) @@ -115,7 +115,7 @@ GEM terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) unicode-display_width (2.6.0) - webrick (1.8.2) + webrick (1.9.1) PLATFORMS aarch64-linux @@ -154,4 +154,4 @@ RUBY VERSION ruby 3.3.4p94 BUNDLED WITH - 2.5.11 + 2.5.22 diff --git a/_docs-2/configuration/overview.md b/_docs-2/configuration/overview.md index 7a08e36ea..036ace1be 100644 --- a/_docs-2/configuration/overview.md +++ b/_docs-2/configuration/overview.md @@ -39,7 +39,7 @@ local [accumulo.properties] on start up so processes must be restarted to apply in their description. Setting properties in accumulo.properties allows you to configure tablet servers with different settings. Site configuration can be overriden when starting an Accumulo process on the command line (by using the `-o` option): -``` +```bash accumulo tserver -o instance.secret=mysecret -o instance.zookeeper.host=localhost:2181 ``` Overriding properties is useful if you can't change [accumulo.properties]. It's done when [running Accumulo using Docker](https://github.com/apache/accumulo-docker). @@ -51,7 +51,9 @@ in their description on the [server properties] page. System configuration will settings take effect immediately, some require a restart of the process which is indicated in the **zk mutable** section of their description. System configuration can be set using the following shell command: - config -s PROPERTY=VALUE +```console +config -s PROPERTY=VALUE +``` They can also be set using {% jlink org.apache.accumulo.core.client.admin.InstanceOperations %} in the Java API: @@ -68,14 +70,16 @@ client.instanceOperations().modifyProperties(properties -> { properties.put("table.bloom.error.rate", "0.75"); properties.put("table.bloom.size", "128000"); }); - ``` + ### Namespace Namespace configuration refers to [table.* properties] set for a certain table namespace (i.e. group of tables). These settings are stored in ZooKeeper. Namespace configuration will override System configuration and can be set using the following shell command: - config -ns NAMESPACE -s PROPERTY=VALUE +```console +config -ns NAMESPACE -s PROPERTY=VALUE +``` It can also be set using {% jlink org.apache.accumulo.core.client.admin.NamespaceOperations %} in the Java API: @@ -92,12 +96,15 @@ client.namespaceOperations().modifyProperties("mynamespace", properties -> { properties.put("table.bloom.error.rate", "0.75"); properties.put("table.bloom.size", "128000"); }); +``` ### Table Table configuration refers to [table.* properties] set for a certain table. These settings are stored in ZooKeeper and can be set using the following shell command: - config -t TABLE -s PROPERTY=VALUE +```console +config -t TABLE -s PROPERTY=VALUE +``` They can also be set using {% jlink org.apache.accumulo.core.client.admin.TableOperations %} in the Java API: