GitBook: [master] 11 pages and 6 assets modified

Dmitry Pokidov · gitbook-bot · commit 6066a3ffc7fc · 2021-07-14T02:28:51.000Z
diff --git a/.gitbook/assets/api_keys.png b/.gitbook/assets/api_keys.png
diff --git a/.gitbook/assets/generate_new_keys.png b/.gitbook/assets/generate_new_keys.png
diff --git a/.gitbook/assets/invalidate_cache (1).png b/.gitbook/assets/invalidate_cache (1).png
diff --git a/.gitbook/assets/many_domains.png b/.gitbook/assets/many_domains.png
diff --git a/.gitbook/assets/s3-access.png b/.gitbook/assets/s3-access.png
diff --git a/README.md b/README.md
@@ -10,7 +10,9 @@ Below is the diagram that shows how Pixboost works:
 
 Here is the short video on how to use Pixboost:
 
-[](https://youtu.be/Uj7EU5rUvx8)
+{% embed url="https://youtu.be/Uj7EU5rUvx8" %}
+
+
 
 To start working with the service you would only need to register and [add you image source](setup/adding-image-source.md).
 
diff --git a/api/as-is.md b/api/as-is.md
@@ -14,11 +14,11 @@ No parameters required.
 
 | Original Image | Image after Pixboost transformation |
 | :--- | :--- |
-| ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/asis?auth=MTA0ODU5NDA0NQ\_\_) |
+| ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/asis?auth=MTA0ODU5NDA0NQ__) |
 
 ### Sandbox
 
 | Original Image | Image after Pixboost transformation |
 | :--- | :--- |
-| [www.midday.coffee/assets/cup.jpeg](www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/asis?auth=MTA0ODU5NDA0NQ__)\_ |
+| [www.midday.coffee/assets/cup.jpeg](https://github.com/Pixboost/docs/tree/8f93cdfa3e5fdb7584ce488ef51153268bef537f/api/www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/asis?auth=MTA0ODU5NDA0NQ__)\_ |
 
diff --git a/api/fit.md b/api/fit.md
@@ -18,11 +18,11 @@ size =`200x100 (scaling by the smaller side which is height, cropping sides, cen
 
 | Parameters | Original | After |
 | :--- | :---: | :---: |
-| size=200x100 | ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ\_\_) |
+| size=200x100 | ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ__) |
 
 ### Sandbox
 
 | Original Image | Image after Pixboost transformation |
 | :--- | :--- |
-| [www.midday.coffee/assets/cup.jpeg](www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ__)\_ |
+| [www.midday.coffee/assets/cup.jpeg](https://github.com/Pixboost/docs/tree/8f93cdfa3e5fdb7584ce488ef51153268bef537f/api/www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=200x100&auth=MTA0ODU5NDA0NQ__)\_ |
 
diff --git a/api/optimise.md b/api/optimise.md
@@ -14,13 +14,13 @@ No parameters required.
 
 | Original | After |
 | :---: | :---: |
-| ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?&auth=MTA0ODU5NDA0NQ\_\_) |
+| ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?&auth=MTA0ODU5NDA0NQ__) |
 
-In the example above an image becomes at least 20% lighter 
+In the example above an image becomes at least 20% lighter
 
 ### Sandbox
 
 | Original Image | Image after Pixboost transformation |
 | :--- | :--- |
-| [www.midday.coffee/assets/cup.jpeg](www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?&auth=MTA0ODU5NDA0NQ__) |
+| [www.midday.coffee/assets/cup.jpeg](https://github.com/Pixboost/docs/tree/8f93cdfa3e5fdb7584ce488ef51153268bef537f/api/www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?&auth=MTA0ODU5NDA0NQ__) |
 
diff --git a/api/resize.md b/api/resize.md
@@ -16,12 +16,12 @@ You can specify only one dimension and the second will be calculated according t
 
 | Parameters | Original | After |
 | :--- | :---: | :---: |
-| size=200 | ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200&auth=MTA0ODU5NDA0NQ\_\_) |
-| size=x80 | ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=x80&auth=MTA0ODU5NDA0NQ\_\_) |
+| size=200 | ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200&auth=MTA0ODU5NDA0NQ__) |
+| size=x80 | ![](http://www.midday.coffee/assets/cup.jpeg) | ![](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=x80&auth=MTA0ODU5NDA0NQ__) |
 
 ### Sandbox
 
 | Original Image | Image after Pixboost transformation |
 | :--- | :--- |
-| [www.midday.coffee/assets/cup.jpeg](www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200x100&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200x100&auth=MTA0ODU5NDA0NQ\_\_) |
+| [www.midday.coffee/assets/cup.jpeg](https://github.com/Pixboost/docs/tree/a18a5ae66426629920df8220795d1a1ac414a5a0/api/www.midday.coffee/assets/cup.jpeg) | [http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200x100&auth=MTA0ODU5NDA0NQ\_\_](http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200x100&auth=MTA0ODU5NDA0NQ__) |
 
diff --git a/quick-start-10-minutes-or-less.md b/quick-start-10-minutes-or-less.md
@@ -1,4 +1,4 @@
-# Quick Start \(under 10 minutes!\)
+# Quick Start \(10 minutes or less\)
 
 We try to make the start with Pixboost as fast and as easy as possible. We aim it to be under 10 minutes. So, lets cut it short.
 
@@ -44,13 +44,11 @@ You can add as many domains and sub-domains as you need by clicking "**Add domai
 
 Below you will see a pre-generated _**API Keys**_, which you will use to access API.
 
-> _**API Key**_ is a value that is generated for security purposes by Pixboost. 
-> You have to use it in the URLs of images you wish to deliver through Pixboost service.
+> _**API Key**_ is a value that is generated for security purposes by Pixboost. You have to use it in the URLs of images you wish to deliver through Pixboost service.
 
 ![](.gitbook/assets/api-keys.png)
 
-You might need more than one key in your project. Please read the manual on 
-[API Keys Usage and Security Issues](./setup/manage-api-keys.md).
+You might need more than one key in your project. Please read the manual on [API Keys Usage and Security Issues](setup/manage-api-keys.md).
 
 To add more keys press the "**Generate new key**" link:
 
@@ -104,5 +102,5 @@ For more information on API, please read the [Images API section](api/).
 
 Update all the **Image URLs** on your website that you wish to process through Pixboost according to the **Step 5** and [Image API](api/) instructions.
 
-Apart from URL-based transformations we provide developers friendly libraries: [pixboost.js](web-dom/) and [pixboost-react](react/). 
+Apart from URL-based transformations we provide developers friendly libraries: [pixboost.js](web-dom/) and [pixboost-react](react/).
 
diff --git a/setup/adding-image-source.md b/setup/adding-image-source.md
@@ -1,9 +1,6 @@
 # Adding Images Domain
 
-**Image domain** is the domain name of your server where your images are stored. 
-Pixboost will allow only requests to the images from domains that are listed. 
-Using list of domains allows us to make service secure and protect you account from malicious 
-abuse.
+**Image domain** is the domain name of your server where your images are stored. Pixboost will allow only requests to the images from domains that are listed. Using list of domains allows us to make service secure and protect you account from malicious abuse.
 
 When you login for the first time then you will see a "Welcome" banner:
 
@@ -14,8 +11,7 @@ Click on the "Plus" button and you will have to add your domain name in a dialog
 ![](../.gitbook/assets/add-domain-1.png)
 
 {% hint style="info" %}
-If you'd like to load images from a private AWS S3 bucket then click on the "Bucket" icon 
-and follow [steps from here](./adding-s3-bucket-image-source.md)
+If you'd like to load images from a private AWS S3 bucket then click on the "Bucket" icon and follow [steps from here](adding-s3-bucket-image-source.md)
 {% endhint %}
 
 Enter your domain and click the "Add" button:
@@ -28,8 +24,7 @@ You will see adeed domain in the list now:
 
 That's enough to start using the service. Try it out it in your browser:
 
-```
+```text
 https://pixboost.com/api/2/img/http://i.imgur.com/RgSMqlKg.jpg/resize?size=200&auth=MzI0NTc5NDAyMQ__
 ```
 
-
diff --git a/setup/adding-s3-bucket-image-source.md b/setup/adding-s3-bucket-image-source.md
@@ -1,13 +1,10 @@
-# Adding AWS S3 bucket as image source
+# Adding AWS S3 Bucket as Source
 
-Using Pixboost, you can set up a private S3 bucket to be a source of your images.
-Here, we will go through requirements for the S3 bucket, how to add an integration to Pixboost 
-and how to optimise images from the bucket using API.
+Using Pixboost, you can set up a private S3 bucket to be a source of your images. Here, we will go through requirements for the S3 bucket, how to add an integration to Pixboost and how to optimise images from the bucket using API.
 
 ## AWS setup
 
-We assume that you already have S3 bucket with your images stored there. If not then you
-can read how to do that [here](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html).
+We assume that you already have S3 bucket with your images stored there. If not then you can read how to do that [here](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html).
 
 To setup a new user that you'll integrate with Pixboost:
 
@@ -17,7 +14,7 @@ To setup a new user that you'll integrate with Pixboost:
 
 Below is an example of a bucket policy:
 
-```json
+```javascript
 {
     "Version": "2012-10-17",
     "Statement": [
@@ -39,7 +36,7 @@ Below is an example of a bucket policy:
         }
     ]
 }
-``` 
+```
 
 ## Pixboost setup
 
@@ -51,13 +48,15 @@ To set up the integration:
 ![](../.gitbook/assets/add-images-source.png)
 
 * In the appeared form set Type to "Amazon AWS S3 Bucket" and fill in the details
-  * *Alias* is a unique identifier of the images source that will be used in the URL when calling API
-  * *Bucket name* is the name of a bucket
-  * *Region* is an AWS region ID of the bucket
-  * *Path Prefix* is an optional prefix that will be used for all requests. It could be used if all your images in 
+  * _Alias_ is a unique identifier of the images source that will be used in the URL when calling API
+  * _Bucket name_ is the name of a bucket
+  * _Region_ is an AWS region ID of the bucket
+  * _Path Prefix_ is an optional prefix that will be used for all requests. It could be used if all your images in 
+
     the bucket stored in one folder. In that case, you could set "Path prefix", and you won't need to add it to each API call. 
-  * *Access Key* is an AWS IAM user's access key created in the step above
-  * *Secret Key* is an AWS IAM user's secret key created in the step above
+
+  * _Access Key_ is an AWS IAM user's access key created in the step above
+  * _Secret Key_ is an AWS IAM user's secret key created in the step above
 
 ![](../.gitbook/assets/add-s3-images-source.png)
 
@@ -67,22 +66,17 @@ To set up the integration:
 
 ## Using API
 
-All API requests follow the [original pattern](../api/README.md):
+All API requests follow the [original pattern](../api/):
 
 `https://pixboost.com/api/2/img/[ALIAS]/[PATH_TO_THE_IMAGE]/[OPERATION]?[OPERATION_PARAMS]&auth=[API_KEY]`
 
-Let's consider a configuration from the step above. For instance, if there is an image in 
-S3 bucket with a path (key): `prefix/another-prefix/images/hello.png` then to resize it we 
-use the following API call:
+Let's consider a configuration from the step above. For instance, if there is an image in S3 bucket with a path \(key\): `prefix/another-prefix/images/hello.png` then to resize it we use the following API call:
 
 `https://pixboost.com/api/2/img/bucket/images/hello.png/resize?size=200&auth=[API_KEY]`
 
-In the example above `/bucket` (after `/api/2/img`) will be replaced with bucket name and
-path prefix - `pixboost-test-source/prefix/another-prefix`
+In the example above `/bucket` \(after `/api/2/img`\) will be replaced with bucket name and path prefix - `pixboost-test-source/prefix/another-prefix`
 
 ## Limitations
 
-You could have a maximum of 10 images sources. That is a soft limit, so if you'd like
-to raise it, please email us at customer.service@pixboost.com
+You could have a maximum of 10 images sources. That is a soft limit, so if you'd like to raise it, please email us at customer.service@pixboost.com
 
-   
diff --git a/setup/cache-invalidation.md b/setup/cache-invalidation.md
@@ -16,5 +16,5 @@ To use the feature, please:
 
 **Step 3:** Enter the URL of the image you wish to update and press "**Invalidate**" button.
 
-![](../.gitbook/assets/invalidate_cache.png)
+![](../.gitbook/assets/invalidate_cache%20%281%29.png)
 
diff --git a/setup/snippet-generator.md b/setup/snippet-generator.md
@@ -1,24 +1,20 @@
 # Snippet Generator
 
-**Snippet Generator** is a Tool that helps users to quick start with Pixboost and to make the setup much easier. 
-It creates the small blocks of reusable code to insert in a code of a website. It is available for all registered users of our service.
+**Snippet Generator** is a Tool that helps users to quick start with Pixboost and to make the setup much easier. It creates the small blocks of reusable code to insert in a code of a website. It is available for all registered users of our service.
 
 ![](../.gitbook/assets/main-image.png)
 
-To start using Pixboost all you need is to modify the URLs of images that you would like 
-to pass through the service for optimization for scaling purposes. That's exactly what Snippet Generator will do for you.
+To start using Pixboost all you need is to modify the URLs of images that you would like to pass through the service for optimization for scaling purposes. That's exactly what Snippet Generator will do for you.
 
 ## How to use it from a sandbox or from the app
 
-To start using Snippet Generator you have two options. 
-You either use our demo account to check it out or you log into your Pixboost account
-and there you can use this tool for your projects.
+To start using Snippet Generator you have two options. You either use our demo account to check it out or you log into your Pixboost account and there you can use this tool for your projects.
 
-For sandbox follow the link to 
-[start Snippet Generator](https://pixboost.com/snippet/?k=MTg4MjMxMzM3MA__)
+For sandbox follow the link to [start Snippet Generator](https://pixboost.com/snippet/?k=MTg4MjMxMzM3MA__)
 
 * Paste URL to the image you would like to compress, scale and deliver through CDN. 
-Or you can use our example image to see how this tool works. Pre-Set Image URL - `http://www.midday.coffee/image.jpg`
+
+  Or you can use our example image to see how this tool works. Pre-Set Image URL - `http://www.midday.coffee/image.jpg`
 
 As a sandbox user or as a registered user you use the Snippet Generator in a similar way:
 
@@ -41,7 +37,8 @@ As a sandbox user or as a registered user you use the Snippet Generator in a sim
 ![](../.gitbook/assets/preview-mobile.png)
 
 * Finally, after you are happy with your setup, you can **Copy** snippet and 
-paste directly into your website code.
+
+  paste directly into your website code.
 
 ![](../.gitbook/assets/code-snippet-html.png)
 
diff --git a/shopify.md b/shopify.md
@@ -32,16 +32,11 @@ Please, follow steps from ["Installation"](shopify.md#installation) section to u
 
 ![](.gitbook/assets/shopify-added-theme.png)
 
-At this point, you should be able to preview the theme, 
-and it will use Pixboost demo account. All the images will be served from 
-Pixboost Image CDN. Note that first time the images will load slowly as 
-they will go through optimisation and CDN uploading process. 
-Reload the page after the initial load to see the real performance.
+At this point, you should be able to preview the theme, and it will use Pixboost demo account. All the images will be served from Pixboost Image CDN. Note that first time the images will load slowly as they will go through optimisation and CDN uploading process. Reload the page after the initial load to see the real performance.
 
 ![](.gitbook/assets/shopify-preview-theme.png)
 
-Once you are happy with the result, you would need to create a Pixboost account 
-and use your API key:
+Once you are happy with the result, you would need to create a Pixboost account and use your API key:
 
 * [Sign up here](https://github.com/Pixboost/docs/tree/f5010c234fd24fe5e3402831d8152bbad3b3c3ea/shopify/pixboost.com/customer/README.md#/signup) and select Shopify integration
 
@@ -67,9 +62,7 @@ and use your API key:
 
 ![](.gitbook/assets/shopify-save-theme.png)
 
-Congratulation! You now have responsive, optimised and fast images on your 
-Shopify store. Keep customizing your page layouts and publish the theme once
-you are ready.
+Congratulation! You now have responsive, optimised and fast images on your Shopify store. Keep customizing your page layouts and publish the theme once you are ready.
 
 ## Integration with a custom theme
 
