Moved image source to its own folder

Author: dooman87

.gitbook.yaml

@@ -5,4 +5,7 @@ structure:
   summary: SUMMARY.md
 
 redirects:
-  quick-start-10-minutes-or-less: quickstart.md
+  quick-start-10-minutes-or-less: quickstart.md
+  setup/adding-s3-bucket-image-source: setup/source-images/s3.md
+  setup/adding-image-source: setup/source-images/domain.md
+  setup/adding-http-image-source: setup/source-images/http.md

.gitbook/assets/api-keys-list.png

@@ -3,9 +3,10 @@
 * [Overview](README.md)
 * [Quickstart](quickstart.md)
 * [Tools and Setup](setup/README.md)
-  * [Adding Source Image Domain](setup/adding-image-source.md)
-  * [Adding HTTP Image Source](setup/adding-http-image-source.md)
-  * [Adding AWS S3 Bucket Image Source](setup/adding-s3-bucket-image-source.md)
+  * Source Images
+    * [Adding Source Image Domain](setup/source-images/domain.md)
+    * [Adding HTTP Image Source](setup/source-images/http.md)
+    * [Adding AWS S3 Bucket Image Source](setup/source-images/s3.md)
   * [Managing API Keys](setup/manage-api-keys.md)
   * [Managing Users](setup/manage-users.md)
   * [Snippet Generator](setup/snippet-generator.md)

SUMMARY.md

@@ -1,14 +1,14 @@
 # Tools and Setup
 
-There is only one step that you need to do to start using Pixboost - [add at least one image domain](adding-image-source.md) or image source.
+There is only one step that you need to do to start using Pixboost - [add at least one image domain](source-images/domain.md) or image source.
 
 You will already have one active API key that you can use, but [you can add more or rotate them](manage-api-keys.md) in case you have different projects and don't want to have all eggs in one basket. It's a good security practice separating you API keys.
 
-## [Adding Images Domain](adding-image-source.md)
+## [Adding Images Domain](source-images/domain.md)
 
-## [Adding HTTP Image Source](adding-http-image-source.md)
+## [Adding HTTP Image Source](source-images/http.md)
 
-## [Adding AWS S3 Bucket Image Source](adding-s3-bucket-image-source.md)
+## [Adding AWS S3 Bucket Image Source](source-images/s3.md)
 
 ## [Managing API Keys](manage-api-keys.md)
 

quick-start-10-minutes-or-less.md

@@ -5,7 +5,7 @@ Cache invalidation is a function that helps you to remove image from the CDN.
 You can delete images using either 
 
 * URL of the original image
-* Path to the image that starts with the [Image Source](./adding-http-image-source.md) alias 
+* Path to the image that starts with the [Image Source](source-images/http.md) alias 
 
 ![](../.gitbook/assets/cache-invalidation/cache-invalidation-1.png)
 

setup/README.md

@@ -6,20 +6,33 @@ Once you signed up you have one API key that you can see in the dashboard:
 
 ![](../.gitbook/assets/manage-api-keys/api-keys-list.png)
 
+## Usage
+
 You'll need to pass an API Key in a query parameter called "**auth**" in the transformation URL. For example:
 
 To use the API key add it as a value in the "auth" query parameter when using API:
 
 https://pixboost.com/api/2/img/pixabay.com/logo.png/resize?size=200&auth=MTg4MjMxMzM3MA
 
-You can create new API Keys from the dashboard and add a label to them, so you remember what you use each key for. Labels are only used for information and reporting purposes.
-
 > Be careful when **deleting** API keys. Any API requests that use deleted keys will be failing.
 
+## Labels
+
+You can create new API Keys from the dashboard and add a label to them, so you remember what you use each key for. Labels are only used for information and reporting purposes.
+
 Some useful examples of the label could include a website and environment. For instance:
 
 * dev
 * test-site-1
 * prod-site-2
 
+## Security
+
+API keys are not secrets and are shared publicly when used to access API. 
+
+When passing an API key with a request, the service can link the request to an account, therefore limiting
+the source image destination to image sources/domains you specified.
+
+## Limits
+
 There is a soft limit of 10 API keys per account. If you need more - please contact [support](mailto:[email protected]).

setup/cache-invalidation.md

@@ -4,23 +4,23 @@
 
 When you login for the first time then you will see a "Welcome" banner:
 
-![](../.gitbook/assets/welcome.png)
+![](../../.gitbook/assets/welcome.png)
 
 Click on the "Plus" button, and you will have to add your domain name in a dialog window "Add domain":
 
-![](../.gitbook/assets/add-domain-1.png)
+![](../../.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)
 {% endhint %}
 
 Enter your domain and click the "Add" button:
 
-![](../.gitbook/assets/add-domain-2.png)
+![](../../.gitbook/assets/add-domain-2.png)
 
 You will see adeed domain in the list now:
 
-![](../.gitbook/assets/domains-list.png)
+![](../../.gitbook/assets/domains-list.png)
 
 That's enough to start using the service. Try it out it in your browser:
 

setup/manage-api-keys.md

@@ -2,21 +2,21 @@
 
 You could add HTTP image source to shorten URLs that you are using for the integration. 
 
-![](../.gitbook/assets/http-image-source-concept.png)
+![](../../.gitbook/assets/http-image-source-concept.png)
 
 ## Adding a new source
 
 * [Login](https://pixboost.com/customer/#login) to your Pixboost account.
 * Click on "Add source" link under the "Images Sources" panel
 
-![](../.gitbook/assets/add-images-source.png)
+![](../../.gitbook/assets/add-images-source.png)
 
 * In the appeared form set Type to "HTTP" and fill in the details
     * _Alias_ is a unique identifier of the images source that will be used in the URL when calling API
     * _Images location_ is a URL where the original images stored
 
-![](../.gitbook/assets/add-http-images-source.png)
+![](../../.gitbook/assets/add-http-images-source.png)
 
 * Click on "Add" button and verify that the source has been created
 
-![](../.gitbook/assets/verify-http-images-source.png)
+![](../../.gitbook/assets/verify-http-images-source.png)

setup/adding-image-source.md renamed to setup/source-images/domain.md

@@ -45,7 +45,7 @@ To set up the integration:
 * [Login](https://pixboost.com/customer/#login) to your Pixboost account.
 * Click on "Add source" link under the "Images Sources" panel
 
-![](../.gitbook/assets/add-images-source.png)
+![](../../.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
@@ -58,11 +58,11 @@ To set up the integration:
   * _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)
+![](../../.gitbook/assets/add-s3-images-source.png)
 
 * Click on "Add" button and verify that the source has been created
 
-![](../.gitbook/assets/verify-s3-images-source.png)
+![](../../.gitbook/assets/verify-s3-images-source.png)
 
 ## Using API
 

setup/adding-http-image-source.md renamed to setup/source-images/http.md

@@ -22,7 +22,7 @@ API\_SECRET - [secret key](api-secrets.md).
 
 202 - Invalidation process began and will finish soon. Usually it will take up to the 5 minutes.
 
-401 - Failed authorization. Image domain is not in the list of [images sources](../setup/adding-image-source.md)
+401 - Failed authorization. Image domain is not in the list of [images sources](../setup/source-images/domain.md)
 
 ## Example