diff --git a/docs/en/Modules/Cms-Kit/Global-Resources.md b/docs/en/Modules/Cms-Kit/Global-Resources.md new file mode 100644 index 0000000000..7f639ad884 --- /dev/null +++ b/docs/en/Modules/Cms-Kit/Global-Resources.md @@ -0,0 +1,66 @@ +# CMS Kit: Global Resources + +CMS Kit Global Resources system allows to add global styles and scripts dynamically. + +## The User Interface + +### Menu items + +CMS Kit module admin side adds the following items to the main menu, under the *Global Resources* menu item: + +* **Global Resources**: Global resources management page. + +`CmsKitAdminMenus` class has the constants for the menu item names. + +### Global Resources Page + +Global Resources page is used to manage global styles and scripts in the system. + +![cms-kit-global-resources-page](../../images/cmskit-module-global-resources-page.png) + +# Internals + +## Domain Layer + +#### Aggregates + +This module follows the [Entity Best Practices & Conventions](https://docs.abp.io/en/abp/latest/Best-Practices/Entities) guide. + +- `GlobalResource` (aggregate root): Stores a resource. + +#### Repositories + +This module follows the [Repository Best Practices & Conventions](https://docs.abp.io/en/abp/latest/Best-Practices/Repositories) guide. + +Following custom repositories are defined for this feature: + +- `IGlobalResourceRepository` + +#### Domain services + +This module follows the [Domain Services Best Practices & Conventions](https://docs.abp.io/en/abp/latest/Best-Practices/Domain-Services) guide. + +##### Global Resource Manager + +`GlobalResourceManager` is used to perform operations for the `GlobalResource` aggregate root. + +### Application layer + +#### Application services + +- `GlobalResourceAdminAppService` (implements `IGlobalResourceAdminAppService`): Implements the management operations of global resources system. +- `GlobalResourcePublicAppService` (implements `IGlobalResourcePublicAppService`): Implements the public use cases of global resources system. + +#### Database + +#### Entity Framework Core + +##### Tables + +- CmsGlobalResources + +#### MongoDB + +##### Collections + +- CmsGlobalResources \ No newline at end of file diff --git a/docs/en/Modules/Cms-Kit/Index.md b/docs/en/Modules/Cms-Kit/Index.md index 46ecaad8c8..072f196f10 100644 --- a/docs/en/Modules/Cms-Kit/Index.md +++ b/docs/en/Modules/Cms-Kit/Index.md @@ -13,6 +13,7 @@ The following features are currently available: * Provides a [**reaction**](Reactions.md) system to add reactions (smileys) feature to any kind of resource, like a blog post or a comment. * Provides a [**rating**](Ratings.md) system to add rating feature to any kind of resource. * Provides a [**menu**](Menus.md) system to manage public menus dynamically. +* Provides a [**global resources**](Global-Resources.md) system to add global styles and scripts dynamically. Click to a feature to understand and learn how to use it. diff --git a/docs/en/images/cmskit-module-global-resources-page.png b/docs/en/images/cmskit-module-global-resources-page.png new file mode 100644 index 0000000000..9090c97412 Binary files /dev/null and b/docs/en/images/cmskit-module-global-resources-page.png differ