accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctubb...@apache.org
Subject [accumulo-website] branch main updated: Typo fixes and minor grammar changes. (#251)
Date Mon, 23 Nov 2020 16:45:33 GMT
This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/main by this push:
     new 4efcd94  Typo fixes and minor grammar changes. (#251)
4efcd94 is described below

commit 4efcd943d1222c9af4b787506a2c20736db60721
Author: Dom G <47725857+DomGarguilo@users.noreply.github.com>
AuthorDate: Mon Nov 23 11:45:06 2020 -0500

    Typo fixes and minor grammar changes. (#251)
    
    * spelling and grammar improvements
    * minor grammar fixes
    * fixed broken link
    
    Co-authored-by: Christopher Tubbs <ctubbsii@apache.org>
---
 1.10/examples/sample.md                    | 2 +-
 _docs-2/administration/in-depth-install.md | 6 +++---
 _docs-2/configuration/files.md             | 6 +++---
 _docs-2/configuration/overview.md          | 8 ++++----
 _docs-2/development/high_speed_ingest.md   | 2 +-
 _docs-2/development/mapreduce.md           | 4 ++--
 _docs-2/development/sampling.md            | 6 +++---
 _docs-2/development/summaries.md           | 8 ++++----
 _docs-2/security/authentication.md         | 4 ++--
 _docs-2/security/authorizations.md         | 4 ++--
 _docs-2/security/on-disk-encryption.md     | 4 ++--
 _docs-2/security/wire-encryption.md        | 2 +-
 12 files changed, 28 insertions(+), 28 deletions(-)

diff --git a/1.10/examples/sample.md b/1.10/examples/sample.md
index dc36df4..d52cf07 100644
--- a/1.10/examples/sample.md
+++ b/1.10/examples/sample.md
@@ -94,7 +94,7 @@ feature works.  The commands determine what files the sampex table is using.
 Below shows running `accumulo rfile-info` on the file above.  This shows the
 rfile has a normal default locality group and a sample default locality group.
 The output also shows the configuration used to create the sample locality
-group.  The sample configuration within a rfile must match the tables sample
+group.  The sample configuration within an RFile must match the tables sample
 configuration for sample scan to work.
 
     $ ./bin/accumulo rfile-info hdfs://localhost:10000/accumulo/tables/2/default_tablet/A000000s.rf
diff --git a/_docs-2/administration/in-depth-install.md b/_docs-2/administration/in-depth-install.md
index 826baab..a70187e 100644
--- a/_docs-2/administration/in-depth-install.md
+++ b/_docs-2/administration/in-depth-install.md
@@ -113,7 +113,7 @@ and specify the following:
 3. Optionally, choose a different location for Accumulo logs using `$ACCUMULO_LOG_DIR`
 
 Accumulo uses `HADOOP_HOME` and `ZOOKEEPER_HOME` to locate Hadoop and Zookeeper jars
-and add them the `CLASSPATH` variable. If you are running a vendor-specific release of Hadoop
+and add them to the `CLASSPATH` variable. If you are running a vendor-specific release of
Hadoop
 or Zookeeper, you may need to change how your `CLASSPATH` is built in [accumulo-env.sh].
If
 Accumulo has problems later on finding jars, run `accumulo classpath` to print Accumulo's
 classpath.
@@ -260,7 +260,7 @@ to result in data being leaked to users who should not have access to
that data.
 In Hadoop-2.6.0, a new CredentialProvider class was introduced which serves as a common
 implementation to abstract away the storage and retrieval of passwords from plaintext
 storage in configuration files. Any Property marked with the `Sensitive` annotation
-is a candidate for use with these CredentialProviders. For version of Hadoop which lack
+is a candidate for use with these CredentialProviders. For versions of Hadoop which lack
 these classes, the feature will just be unavailable for use.
 
 A comma separated list of CredentialProviders can be configured using the Accumulo Property
@@ -290,7 +290,7 @@ general.security.credential.provider.paths=jceks://file/path/to/accumulo/conf/ac
 ```
 
 This configuration will then transparently extract the [instance.secret] from
-the configured KeyStore and alleviates a human readable storage of the sensitive
+the configured KeyStore and eliminates human readable storage of the sensitive
 property.
 
 A KeyStore can also be stored in HDFS, which will make the KeyStore readily available to
diff --git a/_docs-2/configuration/files.md b/_docs-2/configuration/files.md
index 541b981..ba4e211 100644
--- a/_docs-2/configuration/files.md
+++ b/_docs-2/configuration/files.md
@@ -33,7 +33,7 @@ See the [quick start] for help with configuring this file.
 ## accumulo-env.sh
 
 The {% ghc assemble/conf/accumulo-env.sh %} file configures the Java classpath and JVM options
needed to run
-Accumulo processes. See the [quick install] for help with configuring this file.
+Accumulo processes. See the [quick start] for help with configuring this file.
 
 ## Log configuration files
 
@@ -54,7 +54,7 @@ The {% ghc assemble/conf/log4j.properties %} file configures logging for
Accumul
 ## Host files
 
 The `accumulo-cluster` script uses the host files below to determine where Accumulo processes
should be run.
-These files are not in `conf/` directory the Accumulo release tarball by default. They can
be created by running
+These files are not in the `conf/` directory of the Accumulo release tarball by default.
They can be created by running
 the command `accumulo-cluster create-config`.
 
 ### gc
@@ -64,7 +64,7 @@ to run standby Garbage Collectors that can take over if the lead Garbage
Collect
 
 ### masters
 
-Contains a list of hosts where [Master] processes should run. While only one host needed,
others can be specified
+Contains a list of hosts where [Master] processes should run. While only one host is needed,
others can be specified
 to run on standby Masters that can take over if the lead Master fails.
 
 ### monitor
diff --git a/_docs-2/configuration/overview.md b/_docs-2/configuration/overview.md
index 972d35e..588af20 100644
--- a/_docs-2/configuration/overview.md
+++ b/_docs-2/configuration/overview.md
@@ -14,7 +14,7 @@ Configuration is managed differently for Accumulo clients and servers.
 ## Server Configuration
 
 Accumulo processes (i.e master, tablet server, monitor, etc) are configured by [server properties]
whose values can be
-set in the following configuration locations (with increasing precedence) that are described
in detail below:
+set in the following configuration locations (with increasing precedence):
 
 1. [Default](#default) - All properties have a default value
 2. [Site](#site) - Properties set in [accumulo.properties]
@@ -46,7 +46,7 @@ Overriding properties is useful if you can't change [accumulo.properties].
It's
 
 ### System
 
-System configuration refers to [server properties] set for the entire Accumulo instance/cluster.
These settings are stored in ZooKeeper and can identified by **zk mutable: yes**
+System configuration refers to [server properties] set for the entire Accumulo instance/cluster.
These settings are stored in ZooKeeper and can be identified by **zk mutable: yes**
 in their description on the [server properties] page. System configuration will override
any site configuration set in [accumulo.properties]. While most system configuration
 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:
@@ -101,8 +101,8 @@ Accumulo's current configuration can be viewed in the shell using the
`config` c
 * `config -ns <NAMESPACE>` - view configuration for a specific namespace
 * `config -t <TABLE>` - view configuration for a specific table
 
-Below is example shell output from viewing configuration for the table `foo`. Please note
how `table.compaction.major.ratio`
-is set in multiple locations but the value `1.6` set in the `table` scope is used as it has
the highest precedence.
+Below is an example shell output from viewing configuration for the table `foo`. Please note
how `table.compaction.major.ratio`
+is set in multiple locations, but the value `1.6` set in the `table` scope is used because
it has the highest precedence.
 
 ```
 root@accumulo-instance> config -t foo
diff --git a/_docs-2/development/high_speed_ingest.md b/_docs-2/development/high_speed_ingest.md
index 3bf35de..40a7f74 100644
--- a/_docs-2/development/high_speed_ingest.md
+++ b/_docs-2/development/high_speed_ingest.md
@@ -25,7 +25,7 @@ hardware. Tables can be split at any time by using the shell:
 
     user@myinstance mytable> addsplits -sf /local_splitfile -t mytable
 
-For the purposes of providing parallelism to ingest it is not necessary to create more
+For the purposes of providing parallelism to ingest, it is not necessary to create more
 tablets than there are physical machines within the cluster as the aggregate ingest
 rate is a function of the number of physical machines. Note that the aggregate ingest
 rate is still subject to the number of machines running ingest clients, and the
diff --git a/_docs-2/development/mapreduce.md b/_docs-2/development/mapreduce.md
index 400e433..9641dd6 100644
--- a/_docs-2/development/mapreduce.md
+++ b/_docs-2/development/mapreduce.md
@@ -42,7 +42,7 @@ MapReduce jobs to run with both Accumulo's & Hadoop's dependencies on
the classp
 Since 2.0, Accumulo no longer has the same versions for dependencies as Hadoop. While this
allows
 Accumulo to update its dependencies more frequently, it can cause problems if both Accumulo's
&
 Hadoop's dependencies are on the classpath of the MapReduce job. When launching a MapReduce
job that
-use Accumulo, you should build a [shaded jar] with all of your dependencies and complete
the following
+uses Accumulo, you should build a [shaded jar] with all of your dependencies and complete
the following
 steps so YARN only includes Hadoop code (and not all of Hadoop's dependencies) when running
your MapReduce job:
 
 1. Set `export HADOOP_USE_CLIENT_CLASSLOADER=true` in your environment before submitting
@@ -148,7 +148,7 @@ Follow the steps below to write to an Accumulo table from a MapReduce
job.
 
 ## Write output to RFiles in HDFS
 
-Follow the step below to have a MapReduce job output to RFiles in HDFS. These files
+Follow the steps below to have a MapReduce job output to RFiles in HDFS. These files
 can then be bulk imported into Accumulo:
 
 1. Create a Mapper or Reducer with `Key` & `Value` as output parameters.
diff --git a/_docs-2/development/sampling.md b/_docs-2/development/sampling.md
index e8ee4bf..79bd28d 100644
--- a/_docs-2/development/sampling.md
+++ b/_docs-2/development/sampling.md
@@ -11,7 +11,7 @@ This sample data is kept up to date as a table is mutated.  What key values
are
 placed in the sample data is configurable per table.
 
 This feature can be used for query estimation and optimization.  For an example
-of estimation assume an Accumulo table is configured to generate a sample
+of estimation, assume an Accumulo table is configured to generate a sample
 containing one millionth of a tables data.   If a query is executed against the
 sample and returns one thousand results, then the same query against all the
 data would probably return a billion results.  A nice property of having
@@ -34,11 +34,11 @@ for examples of how to configure a [Sampler] on a table.
 Once a table is configured with a [Sampler], all writes after that point will
 generate sample data.  For data written before sampling was configured, sample
 data will not be present.  A compaction can be initiated that only compacts the
-files in the table that do not have sample data.  The [sampling example][example] 
+files in the table that do not have sample data.  The [sampling example][example]
 shows how to do this.
 
 If the sampling configuration of a table is changed, then Accumulo will start
-generating new sample data with the new configuration.   However old data will
+generating new sample data with the new configuration.   However, old data will
 still have sample data generated with the previous configuration.  A selective
 compaction can also be issued in this case to regenerate the sample data.
 
diff --git a/_docs-2/development/summaries.md b/_docs-2/development/summaries.md
index d2e3d31..8c7278a 100644
--- a/_docs-2/development/summaries.md
+++ b/_docs-2/development/summaries.md
@@ -17,7 +17,7 @@ about which files to compact.
 
 Summary data is stored in each file Accumulo produces.  Accumulo can gather
 summary information from across a cluster merging it along the way.  In order
-for this to be fast the, summary information should fit in cache.  There is a
+for this to be fast, the summary information should fit in cache.  There is a
 dedicated cache for summary data on each tserver with a configurable size.  In
 order for summary data to fit in cache, it should probably be small.
 
@@ -36,7 +36,7 @@ ranges per a file.  However, the ranges are not granular enough to completely
 offset extra data.
 
 Any source of inaccuracies is reported when summary information is requested.
-In the shell examples below this can be seen on the `File Statistics` line.
+In the shell examples below, this can be seen on the `File Statistics` line.
 For files missing summary information, the compact command in the shell has a
 `--sf-no-summary` option.  This options compacts files that do not have the
 summary information configured for the table.  The compact command also has the
@@ -57,7 +57,7 @@ The following tablet server and table properties configure summarization.
 ## Permissions
 
 Because summary data may be derived from sensitive data, requesting summary data
-requires a special permission.  User must have the table permission
+requires a special permission.  Users must have the table permission
 `GET_SUMMARIES` in order to retrieve summary data.
 
 ## Bulk import
@@ -69,7 +69,7 @@ class has options for creating RFiles with embedded summary data.
 
 ## Examples
 
-This example walks through using summarizers in the Accumulo shell.  Below a
+This example walks through using summarizers in the Accumulo shell.  Below, a
 table is created and some data is inserted to summarize.
 
     root@uno> createtable summary_test
diff --git a/_docs-2/security/authentication.md b/_docs-2/security/authentication.md
index 7f3051d..9a2b583 100644
--- a/_docs-2/security/authentication.md
+++ b/_docs-2/security/authentication.md
@@ -41,7 +41,7 @@ client.securityOperations().createLocalUser("bob", new PasswordToken("pass"));
 ## Authenticating users
 
 Users are authenticated when they [create an Accumulo client]({% durl getting-started/clients#creating-an-accumulo-client
%})
-or when the log in to the [Accumulo shell]({% durl getting-started/shell %}).
+or when they log in to the [Accumulo shell]({% durl getting-started/shell %}).
 
 Authentication can also be tested in the shell:
 
@@ -59,7 +59,7 @@ boolean valid = client.securityOperations().authenticateUser("bob", new
Password
 
 ## Changing user passwords
 
-A user's password can changed be in the shell:
+A user's password can be changed in the shell:
 
 ```
 root@uno> passwd -u bob
diff --git a/_docs-2/security/authorizations.md b/_docs-2/security/authorizations.md
index 76af658..31aa2bb 100644
--- a/_docs-2/security/authorizations.md
+++ b/_docs-2/security/authorizations.md
@@ -98,7 +98,7 @@ the [Accumulo shell][shell], use the `setuaths` and `getauths` commands.
They ca
 retrieved and modified in Java using `getUserAuthorizations` and `changeUserAuthorizations`
 methods of [SecurityOperations].
 
-When a user creates a [Scanner] or [BatchScanner] a set of [Authorizations] is passed.
+When a user creates a [Scanner] or [BatchScanner], a set of [Authorizations] is passed.
 If the Authorizations passed to the scanner are not a subset of the user's Authorizations,
 then an exception will be thrown.
 
@@ -118,7 +118,7 @@ disable the bulk import permission.
 
 For applications serving many users, it is not expected that an Accumulo user
 will be created for each application user. In this case an Accumulo user with
-all authorizations needed by any of the applications users must be created. To
+all authorizations needed by any of the application's users must be created. To
 service queries, the application should create a scanner with the application
 user's authorizations. These authorizations could be obtained from a trusted 3rd
 party.
diff --git a/_docs-2/security/on-disk-encryption.md b/_docs-2/security/on-disk-encryption.md
index 6cf700b..d0fe598 100644
--- a/_docs-2/security/on-disk-encryption.md
+++ b/_docs-2/security/on-disk-encryption.md
@@ -60,7 +60,7 @@ For more help getting started see {% jlink org.apache.accumulo.core.security.cry
 ## Things to keep in mind
 
 The on disk encryption configured here is only for RFiles and Write Ahead Logs (WALs).  The
majority of data in Accumulo
-is written to disk with these files but there are a few scenarios that can take place where
data will be unencrypted, 
+is written to disk with these files, but there are a few scenarios that can take place where
data will be unencrypted, 
 even with the crypto service enabled.
 
 ### Sorted WALs
@@ -73,7 +73,7 @@ is finished, these unencrypted files will be removed.
 
 For queries, data is decrypted when read from RFiles and cached in memory.  This means that
data is unencrypted in memory 
 while Accumulo is running.  Depending on the situation, this also means that some data can
be printed to logs. A stacktrace being logged 
-during an exception is one example. Accumulo developers have made sure not to expose data
protected by authorizations during logging but 
+during an exception is one example. Accumulo developers have made sure not to expose data
protected by authorizations during logging, but 
 its the additional data that gets encrypted on disk that could be exposed in a log file.

 
 ### Bulk Import
diff --git a/_docs-2/security/wire-encryption.md b/_docs-2/security/wire-encryption.md
index 27f5d51..6000138 100644
--- a/_docs-2/security/wire-encryption.md
+++ b/_docs-2/security/wire-encryption.md
@@ -40,7 +40,7 @@ In `accumulo.properties`, the following properties are required:
 
 Optionally, SSL client-authentication (two-way SSL) can also be enabled by setting
 {% plink instance.rpc.ssl.clientAuth %} `true` in `accumulo.properties`.
-This requires that each client has access to  valid certificate to set up a secure connection
+This requires that each client has access to a valid certificate to set up a secure connection
 to the servers. By default, Accumulo uses one-way SSL which does not require clients to have
 their own certificate.
 


Mime
View raw message