diff --git a/.travis.yml b/.travis.yml index 5126473..268926b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,7 @@ # 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 # Add your custom config below, which will merge with the default module config from the section above. diff --git a/docs/README.md b/docs/README.md index b4102a7..8dc5297 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # SEO -![](./assets/banner-seo.png) +![SEO banner](./assets/banner-seo.png) ## Configuration @@ -8,16 +8,16 @@ The following JSON is the default configuration for the module and can be overri ```json { - "extra": { - "altis": { - "modules": { - "seo": { - "enabled": true - }, - "redirects": true - } - } - } - } + "extra": { + "altis": { + "modules": { + "seo": { + "enabled": true + }, + "redirects": true + } + } + } + } } ``` diff --git a/docs/redirects.md b/docs/redirects.md index 0990a5d..ddf6bc0 100644 --- a/docs/redirects.md +++ b/docs/redirects.md @@ -2,35 +2,47 @@ Redirects have many uses, not just for SEO and marketing but also for migrating sites or moving content around. -The redirects component is architected for performance and scale by using indexed data in the CMS database. They can be exported and imported using standard WXR format files. +The redirects component is built for performance and scale by using indexed data in the CMS database. They can be exported and +imported using standard WXR format files. ## Whitelisting redirect hosts -For security purposes redirects only work within the current host name by default. To redirect to other domains external to the current host use the following filter: +For security purposes redirects only work within the current host name by default. To redirect to other domains external to the +current host use the following filter: ```php add_filter( 'allowed_redirect_hosts', function ( array $hosts ) : array { - $hosts[] = 'example.com'; - return $hosts; + $hosts[] = 'example.com'; + return $hosts; }, 10 ); ``` ## CLI commands -**`wp hm-redirects find-domains`** +```shell +wp hm-redirects find-domains +``` -Extracts a list of unique target domains from your existing redirects. This is useful for populating the `allowed_redirect_hosts` filter. +Extracts a list of unique target domains from your existing redirects. This is useful for populating the `allowed_redirect_hosts` +filter. -**`wp hm-redirects insert-redirect `** +```shell +wp hm-redirects insert-redirect +``` Adds a redirect rule. -**`wp hm-redirects import-from-csv --csv= [--verbose]`** +```shell +wp hm-redirects import-from-csv --csv= [--verbose] +``` Imports redirects from a CSV file. The file must have 2 columns, column 1 being the "from" URL and column 2 being to the "to" URL. - The "to" URL can be a full URL, a relative path or an existing post ID. -**`wp hm-redirects import-from-meta --meta_key= [--start=] [--end=] [--dry_run] [--verbose]`** +```shell +wp hm-redirects import-from-meta --meta_key= [--start=] [--end=] [--dry_run] + [--verbose] +``` -If you have existing redirect URLs or paths stored as meta data on the posts they should redirect to you can use this command to migrate to the more performant structure. +If you have existing redirect URLs or paths stored as metadata on posts, you can use this command to migrate to the more efficient +structure.