Feature/rebrand ()

This commit is contained in:
Daniel Lautzenheiser
2022-10-02 20:06:20 -04:00
committed by GitHub
parent 11a684f372
commit 8a59f850d1
117 changed files with 2398 additions and 2272 deletions
.eslintrc.jsCODE_OF_CONDUCT.mdCONTRIBUTING.mdREADME.mdbabel.config.js
dev-test
index.d.tspackage.jsonsimple-cms-logo.png
src
tsconfig.jsonwebpack.config.js
website

@ -5,7 +5,7 @@ weight: 10
---
Cloudinary is a digital asset management platform with a broad feature set, including support for responsive image generation and url based image transformation. They also provide a powerful media library UI for managing assets, and tools for organizing your assets into a hierarchy.
The Cloudinary media library integration for Simple CMS uses Cloudinary's own media library interface within Simple CMS. To get started, you'll need a Cloudinary account and Simple CMS 2.3.0 or greater.
The Cloudinary media library integration for Static CMS uses Cloudinary's own media library interface within Static CMS. To get started, you'll need a Cloudinary account and Static CMS 2.3.0 or greater.
## Creating a Cloudinary Account
@ -13,9 +13,9 @@ You can [sign up for Cloudinary](https://cloudinary.com/users/register/free) for
![Cloudinary console screenshot](/img/cloudinary-console-details.png)
## Connecting Cloudinary to Simple CMS
## Connecting Cloudinary to Static CMS
To use the Cloudinary media library within Simple CMS, you'll need to update your Simple CMS configuration file with the information from your Cloudinary account:
To use the Cloudinary media library within Static CMS, you'll need to update your Static CMS configuration file with the information from your Cloudinary account:
```yaml
media_library:
@ -25,14 +25,14 @@ media_library:
api_key: your_api_key
```
**Note:** The user must be logged in to the Cloudinary account connected to the `api_key` used in your Simple CMS configuration.
**Note:** The user must be logged in to the Cloudinary account connected to the `api_key` used in your Static CMS configuration.
### Security Considerations
Although this setup exposes the `cloud_name` and `api_key` publicly via the `/admin/config.yml` endpoint, this information is not sensitive. Any integration of the Cloudinary media library requires this information to be exposed publicly. To use this library or use the restricted Cloudinary API endpoints, the user must have access to the Cloudinary account login details or the `api_secret` associated with the `cloud_name` and `api_key`.
## Simple CMS configuration options
## Static CMS configuration options
The following options are specific to the Simple CMS integration for Cloudinary:
The following options are specific to the Static CMS integration for Cloudinary:
* **`output_filename_only`**: _(default: `false`)_\
By default, the value provided for a selected image is a complete URL for the asset on Cloudinary's CDN. Setting `output_filename_only` to `true` will instead produce just the filename (e.g. `image.jpg`). This should be `true` if you will be directly embedding cloudinary transformation urls in page templates. Refer to [Inserting Cloudinary URL in page templates](#inserting-cloudinary-url-in-page-templates).
@ -43,7 +43,7 @@ The following options are specific to the Simple CMS integration for Cloudinary:
## Cloudinary configuration options
The following options are used to configure the media library. All options are listed in Cloudinary's [media library documentation](https://cloudinary.com/documentation/media_library_widget#3_set_the_configuration_options), but only options listed below are available or recommended for the Simple CMS integration:
The following options are used to configure the media library. All options are listed in Cloudinary's [media library documentation](https://cloudinary.com/documentation/media_library_widget#3_set_the_configuration_options), but only options listed below are available or recommended for the Static CMS integration:
### Authentication
@ -58,7 +58,7 @@ The following options are used to configure the media library. All options are l
## Image transformations
The Cloudinary integration allows images to be transformed in two ways: directly within Simple CMS via [Cloudinary's Media Library](#transforming-images-via-media-library), and separately from the CMS via Cloudinary's [dynamic URL's](https://cloudinary.com/documentation/image_transformations#delivering_media_assets_using_dynamic_urls) by [inserting cloudinary urls](#inserting-cloudinary-url-in-page-templates).
The Cloudinary integration allows images to be transformed in two ways: directly within Static CMS via [Cloudinary's Media Library](#transforming-images-via-media-library), and separately from the CMS via Cloudinary's [dynamic URL's](https://cloudinary.com/documentation/image_transformations#delivering_media_assets_using_dynamic_urls) by [inserting cloudinary urls](#inserting-cloudinary-url-in-page-templates).
### Transforming images via Media Library
If you transform and insert images from within the Cloudinary media library, the transformed image URL will be output by default. This gives the editor complete freedom to make changes to the image output.