From 3b9117313aec97ff4a4c5bfc8ca9d2ff070a0b36 Mon Sep 17 00:00:00 2001
From: Karen Metts <35154725+karenzone@users.noreply.github.com>
Date: Wed, 11 Mar 2020 14:08:18 -0400
Subject: [PATCH] [DOC] Clarify wording in doc descriptions (#219)

* Clarify wording in doc descriptions

* More doc clarifications for rotation strat

* Update CHANGELOG.md
---
 CHANGELOG.md               |  3 +++
 docs/index.asciidoc        | 26 ++++++++++++++++++++------
 logstash-output-s3.gemspec |  2 +-
 3 files changed, 24 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d2efbd6e..6734d5d1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 4.3.1
+  -  [DOC] Updated setting descriptions for clarity [#219](https://github.com/logstash-plugins/logstash-output-s3/pull/219)and [#220](https://github.com/logstash-plugins/logstash-output-s3/pull/220)
+
 ## 4.3.0
   -  Feat: Added retry_count and retry_delay config [#218](https://github.com/logstash-plugins/logstash-output-s3/pull/218)
 
diff --git a/docs/index.asciidoc b/docs/index.asciidoc
index 269a614c..43e72593 100644
--- a/docs/index.asciidoc
+++ b/docs/index.asciidoc
@@ -283,8 +283,19 @@ Session name to use when assuming an IAM role.
   * Value can be any of: `size_and_time`, `size`, `time`
   * Default value is `"size_and_time"`
 
-Define the strategy to use to decide when we need to rotate the file and push it to S3,
-The default strategy is to check for both size and time, the first one to match will rotate the file.
+Controls when to close the file and push it to S3. 
+
+If you set this value to `size`, it uses the value set in
+<<plugins-{type}s-{plugin}-size_file,`size_file`>>.
+If you set this value to `time`, it uses the value set in
+<<plugins-{type}s-{plugin}-time_file,`time_file`>>.
+If you set this value to `size_and_time`, it uses the values from
+<<plugins-{type}s-{plugin}-size_file,`size_file`>> and
+<<plugins-{type}s-{plugin}-time_file,`time_file`>>, and splits the file when
+either one matches. 
+
+The default strategy checks both size and time. The first value to
+match triggers file rotation.
 
 [id="plugins-{type}s-{plugin}-secret_access_key"]
 ===== `secret_access_key` 
@@ -333,8 +344,9 @@ specified here
   * Value type is <<number,number>>
   * Default value is `5242880`
 
-Set the size of file in bytes, this means that files on bucket when dimension > file_size, are stored in two or more files.
-If you have tags then it will generate a specific size file for every tags
+Set the file size in bytes. When the number of bytes exceeds the `size_file`
+value, a new file is created. If you use tags, Logstash generates a specific size
+file for every tag.
 
 [id="plugins-{type}s-{plugin}-ssekms_key_id"]
 ===== `ssekms_key_id` 
@@ -407,8 +419,10 @@ Specify how many workers to use to upload the files to S3
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-The common use case is to define permission on the root bucket and give Logstash full access to write its logs.
-In some circumstances you need finer grained permission on subfolder, this allows you to disable the check at startup.
+The common use case is to define permissions on the root bucket and give Logstash
+full access to write logs. 
+In some circumstances, you need more granular permissions on the subfolder. This
+allows you to disable the check at startup.
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
diff --git a/logstash-output-s3.gemspec b/logstash-output-s3.gemspec
index b8a10cbe..e4f85e76 100644
--- a/logstash-output-s3.gemspec
+++ b/logstash-output-s3.gemspec
@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-s3'
-  s.version         = '4.3.0'
+  s.version         = '4.3.1'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Sends Logstash events to the Amazon Simple Storage Service"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"