README.md in s3_website-2.7.0 vs README.md in s3_website-2.7.1

- old
+ new

@@ -217,11 +217,13 @@ #### Using your existing CloudFront distribution If you already have a CloudFront distribution that serves data from your website S3 bucket, just add the following line into the file `s3_website.yml`: - cloudfront_distribution_id: your-dist-id +```yaml +cloudfront_distribution_id: your-dist-id +``` Next time you run `s3_website push`, it will invalidate the items on CloudFront and thus force the CDN system to reload the changes from your website S3 bucket. #### Specifying custom settings for your CloudFront distribution @@ -252,11 +254,13 @@ You can instruct the push command to invalidate the root resource instead of the *index.html* resource by adding the following setting into the configuration file: - cloudfront_invalidate_root: true +```yaml +cloudfront_invalidate_root: true +``` To recap, this setting instructs s3_website to invalidate the root resource (e.g., *article/*) instead of the filename'd resource (e.g., *article/index.html*). @@ -316,28 +320,33 @@ #### On skipping application of redirects If your website has a lot of redirects, you may find the following setting helpful: - treat_zero_length_objects_as_redirects: true +```yaml +treat_zero_length_objects_as_redirects: true +``` -The setting allows `s3_website push` to infer whether a redirect exists or not. +The setting allows `s3_website push` to infer whether a redirect exists on the S3 bucket. You will experience faster `push` performance when this setting is `true`. -However, if this setting is enabled and you modify the `redirects` setting in + +If this setting is enabled and you modify the `redirects` setting in *s3_website.yml*, use `push --force` to apply the modified values. For backward-compatibility reasons, this setting is `false` by default. +In this context, the word *object* refers to object on S3, not file-system file. + ### Specifying custom concurrency level By default, `s3_website` does 3 operations in parallel. An operation can be an HTTP PUT operation against the S3 API, for example. You can increase the concurrency level by adding the following setting into the `s3_website.yml` file: -``` +```yaml concurrency_level: <integer> ``` However, because S3 throttles connections, there's an upper limit to the level of parallelism. If you start to see end-of-file errors, decrease the @@ -432,9 +441,10 @@ * David Michael Barr * David Raffensperger * Douglas Teoh * Greg Karékinian * John Allison +* Jon Frisby * Jordan White * Justin Latimer * László Bácsi * Mason Turner * Michael Bleigh