Browse Source

Edits to ingest plugin docs

DeDe Morton 9 years ago
parent
commit
4d0124e65c
2 changed files with 9 additions and 9 deletions
  1. 3 3
      docs/plugins/ingest-attachment.asciidoc
  2. 6 6
      docs/plugins/ingest-geoip.asciidoc

+ 3 - 3
docs/plugins/ingest-attachment.asciidoc

@@ -1,10 +1,10 @@
 [[ingest-attachment]]
 === Ingest Attachment Processor Plugin
 
-The ingest attachment plugin lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, PDF)
+The ingest attachment plugin lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by
 using the Apache text extraction library http://lucene.apache.org/tika/[Tika].
 
-It can be used as replacement for the mapper attachment plugin.
+You can use the ingest attachment plugin as a replacement for the mapper attachment plugin.
 
 The source field must be a base64 encoded binary.
 
@@ -16,7 +16,7 @@ The source field must be a base64 encoded binary.
 | `source_field`         | yes       | -                | The field to get the base64 encoded field from
 | `target_field`         | no        | attachment       | The field that will hold the attachment information
 | `indexed_chars`        | no        | 100000           | The number of chars being used for extraction to prevent huge fields. Use `-1` for no limit.
-| `fields`               | no        | all              | Properties to select to be stored, can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`
+| `fields`               | no        | all              | Properties to select to be stored. Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`
 |======
 
 [source,js]

+ 6 - 6
docs/plugins/ingest-geoip.asciidoc

@@ -7,7 +7,7 @@ This processor adds this information by default under the `geoip` field.
 The ingest-geoip plugin ships by default with the GeoLite2 City and GeoLite2 Country geoip2 databases from Maxmind made available
 under the CCA-ShareAlike 3.0 license. For more details see, http://dev.maxmind.com/geoip/geoip2/geolite2/
 
-The GeoIP processor can run with other geoip2 databases from Maxmind. The files must be copied into the geoip config directory
+The GeoIP processor can run with other geoip2 databases from Maxmind. The files must be copied into the geoip config directory,
 and the `database_file` option should be used to specify the filename of the custom database. The geoip config directory
 is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too.
 
@@ -24,13 +24,13 @@ is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too
 
 *Depends on what is available in `database_field`:
 
-* If the GeoLite2 City database is used then the following fields may be added under the `target_field`: `ip`,
+* If the GeoLite2 City database is used, then the following fields may be added under the `target_field`: `ip`,
 `country_iso_code`, `country_name`, `continent_name`, `region_name`, `city_name`, `timezone`, `latitude`, `longitude`
 and `location`. The fields actually added depend on what has been found and which fields were configured in `fields`.
-* If the GeoLite2 Country database is used then the following fields may be added under the `target_field`: `ip`,
-`country_iso_code`, `country_name` and `continent_name`.The fields actually added depend on what has been found and which fields were configured in `fields`.
+* If the GeoLite2 Country database is used, then the following fields may be added under the `target_field`: `ip`,
+`country_iso_code`, `country_name` and `continent_name`. The fields actually added depend on what has been found and which fields were configured in `fields`.
 
-An example that uses the default city database and adds the geographical information to the `geoip` field based on the `ip` field:
+Here is an example that uses the default city database and adds the geographical information to the `geoip` field based on the `ip` field:
 
 [source,js]
 --------------------------------------------------
@@ -46,7 +46,7 @@ An example that uses the default city database and adds the geographical informa
 }
 --------------------------------------------------
 
-An example that uses the default country database and add the geographical information to the `geo` field based on the `ip` field`:
+Here is an example that uses the default country database and adds the geographical information to the `geo` field based on the `ip` field`:
 
 [source,js]
 --------------------------------------------------