Merge pull request #519 from humanmade/440-documentation-linting-issues

Reformat docs files after linting

Author: mikelittle

.travis.yml

@@ -1,5 +1,5 @@
 # Import Travis configuration from dev-tools repo
 version: ~> 1.0
 import:
-  - source: humanmade/altis-dev-tools:travis/module.yml@4accc74
+  - source: humanmade/altis-dev-tools:travis/module.yml@0bfa112a
     mode: deep_merge_append

docs/README.md

@@ -1,85 +1,101 @@
 # Search
 
-![](./assets/banner-search.png)
+![Search Banner](./assets/banner-search.png)
 
-The Search module provides a mirrored Elasticsearch index of all CMS content that is optimized for search relevance, speed and accuracy. This operates at a higher level than the primary datastore (MySQL) and is the recommended solution for searching.
+The Search module provides a mirrored Elasticsearch index of all CMS content that is optimized for search relevance, speed and
+accuracy. This operates at a higher level than the primary data store (MySQL) and is the recommended solution for searching.
 
 The benefits of using Elasticsearch over MySQL search queries include:
 
 - Speed
 - Advanced text analysis
   - Removing HTML
   - Language dependent word stemming and stopwords
-  - Language dependent tokenisation
+  - Language dependent tokenization
 - Configurable relevancy scores
 - Fuzzy matching
 - Synonyms
 - Aggregations for faceted search and statistics
 
-The default Search index and related functionality is provided by the [ElasticPress plugin](https://github.com/10up/ElasticPress) and the multilingual support is derived from [the WordPress.com Elasticsearch library](https://github.com/Automattic/wpes-lib).
-
+The default Search index and related functionality is provided by the [ElasticPress plugin](https://github.com/10up/ElasticPress)
+and the multilingual support is derived from [the WordPress.com Elasticsearch library](https://github.com/Automattic/wpes-lib).
 
 ## Support
 
-Altis provides the Search module and underlying Elasticsearch server to facilitate search on your site, with default configuration to meet a majority of use cases.
-
-Using developer features of the Search module **requires understanding how Elasticsearch works**. We recommend reading the [Elasticsearch guide by Elastic](https://www.elastic.co/guide/en/elasticsearch/).
+Altis provides the Search module and underlying Elasticsearch server to facilitate search on your site, with default configuration
+to meet a majority of use cases.
 
-Modifying and tuning search queries for relevance is a subjective process. Additionally, much like writing complex database queries, building custom Elasticsearch queries requires a deep understanding of how Elasticsearch works.
+Using developer features of the Search module **requires understanding how Elasticsearch works**. We recommend reading
+the [Elasticsearch guide by Elastic](https://www.elastic.co/guide/en/elasticsearch/).
 
-Guides contained in this documentation are on a best-effort basis; for help with tuning or customising search results, the Altis team can help you find a partner to facilitate your use. Altis support cannot help with tuning results, tweaking configuration, or writing custom Elasticsearch queries.
+Modifying and tuning search queries for relevance is a subjective process. Additionally, much like writing complex database queries,
+building custom Elasticsearch queries requires a deep understanding of how Elasticsearch works.
 
+Guides contained in this documentation are on a best-effort basis; for help with tuning or customising search results, the Altis
+team can help you find a partner to facilitate your use. Altis support cannot help with tuning results, tweaking configuration, or
+writing custom Elasticsearch queries.
 
 ## Terminology
 
-Altis includes the Search module (`altis/enhanced-search`) which is built upon a WordPress plugin called ElasticPress, made by our friends at [10up](https://10up.com). Altis adds additional functionality, including deep integration into the Altis platform.
-
-Altis Cloud includes Elasticsearch backend servers, which are a database tuned specifically for search. The Search module sets up a connection to the Elasticsearch servers.
+Altis includes the Search module (`altis/enhanced-search`) which is built upon a WordPress plugin called ElasticPress, made by our
+friends at [10up](https://10up.com). Altis adds additional functionality, including deep integration into the Altis platform.
 
-When content is created or updated, that content is **indexed** into Elasticsearch. This works similar to caching, where a copy of your original data is stored within Elasticsearch in an **index** (effectively, a database table). Unlike your original data, the index can also contain additional data just for search, including generated or rendered data. Each item of content is stored as a **document** which has **fields** containing the data.
+Altis Cloud includes Elasticsearch backend servers, which are a database tuned specifically for search. The Search module sets up a
+connection to the Elasticsearch servers.
 
-When a user searches for content on your site, Altis converts this into a **query**. The query is run in Elasticsearch against your indexed content, which generates results with a **relevancy score**. Relevancy scores are based on the index configuration, field configuration, the query being run, and the indexed data.
+When content is created or updated, that content is **indexed** into Elasticsearch. This works similar to caching, where a copy of
+your original data is stored within Elasticsearch in an **index** (effectively, a database table). Unlike your original data, the
+index can also contain additional data just for search, including generated or rendered data. Each item of content is stored as a *
+*document** which has **fields** containing the data.
 
+When a user searches for content on your site, Altis converts this into a **query**. The query is run in Elasticsearch against your
+indexed content, which generates results with a **relevancy score**. Relevancy scores are based on the index configuration, field
+configuration, the query being run, and the indexed data.
 
 ## Indexing
 
-The indexing process is performed automatically for you by Altis, indexing [most forms of content on your site](./indexing/README.md). Content can be [reindexed if necessary](./indexing/reindexing.md), and [additional data can be indexed](./indexing/additional-data.md).
-
+The indexing process is performed automatically for you by Altis,
+indexing [most forms of content on your site](./indexing/README.md). Content can
+be [reindexed if necessary](./indexing/reindexing.md), and [additional data can be indexed](./indexing/additional-data.md).
 
 ## Querying
 
-Altis [automatically integrates with search queries](./querying/cms-integration.md), as well as providing [autosuggest functionality automatically for your search forms](./querying/autosuggest.md).
+Altis [automatically integrates with search queries](./querying/cms-integration.md), as well as
+providing [autosuggest functionality automatically for your search forms](./querying/autosuggest.md).
 
 Developers can also use [custom queries](./querying/custom-queries.md) for advanced feature development.
 
-
 ## Configuration
 
-Altis provides [various configuration options](./configuration/README.md) to allow adjusting ElasticPress and Elasticsearch behaviour.
-
-You can also use these options to [tune relevancy scoring](./configuration/tuning.md), including [date-based "decay"](./configuration/date-decay.md).
+Altis provides [various configuration options](./configuration/README.md) to allow adjusting ElasticPress and Elasticsearch
+behaviour.
 
-Users can also use the [custom user dictionary settings](./configuration/custom-dictionaries.md) to adjust how text is analyzed, including support for synonyms, stop words and custom text analysis for Japanese.
+You can also use these options to [tune relevancy scoring](./configuration/tuning.md),
+including [date-based "decay"](./configuration/date-decay.md).
 
+Users can also use the [custom user dictionary settings](./configuration/custom-dictionaries.md) to adjust how text is analyzed,
+including support for synonyms, stop words and custom text analysis for Japanese.
 
 ## Disabling Search
 
-The Search module works by overriding default WordPress search, which uses MySQL full-text search. If you would prefer to use MySQL search, you can deactivate the search module via your config:
+The Search module works by overriding default WordPress search, which uses MySQL full-text search. If you would prefer to use MySQL
+search, you can deactivate the search module via your config:
 
 ```json
 {
-	"extra": {
-		"altis": {
-			"modules": {
-				"search": {
-					"enabled": false
-				}
-			}
-		}
-	}
+    "extra": {
+        "altis": {
+            "modules": {
+                "search": {
+                    "enabled": false
+                }
+            }
+        }
+    }
 }
 ```
 
-**Note:** turning this module off does not remove the Elasticsearch server. This can still be used for [Native Analytics](docs://analytics/native/README.md) and any custom use cases.
+**Note:** turning this module off does not remove the Elasticsearch server. This can still be used
+for [Native Analytics](docs://analytics/native/README.md) and any custom use cases.
 
 Additionally, this will increase load on your database servers. Depending on your Altis subscription, this may incur extra cost.

docs/configuration/README.md

@@ -4,26 +4,27 @@ Altis strives to provide a great out-of-the-box search experience for most uses.
 
 For advanced usage, additional configuration is available to adjust search behaviour in indexing and querying.
 
-
 ## Tuning
 
-When searching, results can be ordered by relevancy score. This score is based on a blend of various factors, including index configuration, field configuration, the query being run, and the indexed data.
-
-To help adjust relevancy, Altis provides [various configuration settings to tune relevancy and search behaviour](./tuning.md), allowing for stricter or more permissive matching, advanced query operators, and fuzzy matching.
+When searching, results can be ordered by relevancy score. This score is based on a blend of various factors, including index
+configuration, field configuration, the query being run, and the indexed data.
 
+To help adjust relevancy, Altis provides [various configuration settings to tune relevancy and search behaviour](./tuning.md),
+allowing for stricter or more permissive matching, advanced query operators, and fuzzy matching.
 
 ## Date Decay
 
-For most use cases, you'll want to treat newer results as more relevant than older ones. Altis includes [date decay functionality](./date-decay.md) which automatically adjusts relevancy scores based on dates. These parameters can be tuned as part of the configuration.
-
-
+For most use cases, you'll want to treat newer results as more relevant than older ones. Altis
+includes [date decay functionality](./date-decay.md) which automatically adjusts relevancy scores based on dates. These parameters
+can be tuned as part of the configuration.
 
 ## User Dictionaries
 
-When indexing content, Elasticsearch uses analyzers to convert text from a raw string into data which can be queried. Altis provides [analyzers for common languages](../language-support.md) out of the box.
-
-Altis also provides the ability to upload [custom user dictionaries](./custom-dictionaries.md), which allow adding synonyms, stop words and custom text analysis for Japanese to improve analysis.
+When indexing content, Elasticsearch uses analyzers to convert text from a raw string into data which can be queried. Altis
+provides [analyzers for common languages](../language-support.md) out of the box.
 
+Altis also provides the ability to upload [custom user dictionaries](./custom-dictionaries.md), which allow adding synonyms, stop
+words and custom text analysis for Japanese to improve analysis.
 
 ## Additional Configuration Options
 
@@ -41,13 +42,17 @@ The following options can be enabled/disabled via the search configuration.
 
 To find related posts leveraging Elasticsearch, use the `ep_find_related()` function.
 
-The function requires a single parameter ( `$post_id` ) with another optional parameter ( `$return` ). The `$post_id` will be used to find the posts that are related to it, with `$return` specifying the number of related posts to return, which defaults to 5.
-
-If an out of the box solution is desired, the "ElasticPress - Related Posts" widget can be added to your site's sidebar. In order for the widget to work correctly it needs to be added to the sidebar which will be displayed for a single post.
+The function requires a single parameter ( `$post_id` ) with another optional parameter ( `$return` ). The `$post_id` will be used
+to find the posts that are related to it, with `$return` specifying the number of related posts to return, which defaults to 5.
 
+If an out of the box solution is desired, the "ElasticPress - Related Posts" widget can be added to your site's sidebar. In order
+for the widget to work correctly it needs to be added to the sidebar which will be displayed for a single post.
 
 ### Facets
 
-Facets are a feature in ElasticPress which add control to filter content by one or more taxonomies. A widget can be added so when viewing a content list (archive), the taxonomy and all of its terms will be displayed. This will allow a vistors to further filter content.
+Facets are a feature in ElasticPress which add control to filter content by one or more taxonomies. A widget can be added so when
+viewing a content list (archive), the taxonomy and all of its terms will be displayed. This will allow a visitor to further filter
+content.
 
-Depending on the configuration specified for `facets`, if the `match-type` property is set to `any`, it will force the results to match any selected taxonomy term. If set to `all`, it will match to results with all of the selected terms.
+Depending on the configuration specified for `facets`, if the `match-type` property is set to `any`, it will force the results to
+match any selected taxonomy term. If set to `all`, it will match to results with all of the selected terms.