Updated docs

- updated docs - added link to cookie-consent documentation - changed default value for ENV property MAILER_EMAIL - removed license - renamed "cookie bar" to "cookie widget" in the application
68publishers · Aug 16, 2022 · c9f061a · c9f061a
1 parent ca18c24
commit c9f061a
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 48 deletions.
diff --git a/.env.dist b/.env.dist
@@ -55,7 +55,7 @@ REDIS_HOST=redis
 REDIS_PORT=6379
 REDIS_AUTH=redis_pass
 
-MAILER_EMAIL=info@cmp.io
+MAILER_EMAIL=info@example.com
 MAILER_FROM="Consent Management Platform"
 
 SENTRY_DSN=https://[email protected]/123

diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -14,19 +14,17 @@
   * [Installation](#installation)
 * [Product Documentation](#product-documentation)
 * [Development Guide](#development-guide)
-* [License](#license)
 
 ## About CMP
 
-The CMP is a standalone application for logging cookie consent and managing the cookies themselves on any website.
-You can implement the integration with the application in the cookie bar on your website, however, if you use [our solution](https://github.com/68publishers/cookie-consent), the integration is ready for you.
+The CMP is a standalone application for storing users' cookie consent and managing the cookies themselves on any website or application.
 
 ![CMP Application](docs/images/dashboard.png)
 
 ## Getting Started
 
 ### Prerequisites
-- Docker Compose
+- Docker
 - Make
 
 ### Installation
@@ -48,7 +46,3 @@ For documentation of the application from a user perspective, please go to the [
 ## Development Guide
 
 For more technical information, please go to the [Development Guide](docs/development.md).
-
-## License
-
-The package is distributed under the MIT License. See [LICENSE](LICENSE.md) for more information.
diff --git a/docs/development.md b/docs/development.md
@@ -128,14 +128,12 @@ If the debug mode is enabled (`APP_DEBUG=1` or the user has set the `APP_DEBUG_C
 
 ## API and integration
 
-The application exposes out API to communicate with the cookie bar.
+The application exposes our API to communicate with the cookie widget.
 
 All endpoints are described using OpenApi. To display the Swagger UI, set the ENV variable `API_DOCS_ENABLED` to `1` and open the `http://localhost:8888/api/docs` page in your browser.
 
 If you use [68publishers/cookie-consent](https://github.com/68publishers/cookie-consent) on your sites, there is no need to manually integrate or call anything, everything is already prepared, and you just need to set the GTM tag correctly.
-You can read how to integrate it in the 68publishers/cookie-consent documentation.
-
-@TODO documentation link
+You can read how to integrate it in the 68publishers/cookie-consent [documentation](https://github.com/68publishers/cookie-consent#integration-with-cmp-application).
 
 ## How to update to the latest version
 

diff --git a/docs/images/cookie-bar-page.png → docs/images/cookie-widget-page.png b/docs/images/cookie-bar-page.png → docs/images/cookie-widget-page.png
diff --git a/docs/product.md b/docs/product.md
@@ -16,7 +16,7 @@
 * [Imports](#imports)
 * [Projects](#projects)
   * [Consents](#consents)
-  * [Cookies bars](#cookie-bars)
+  * [Cookie widgets](#cookie-widgets)
   * [Project cookies](#project-cookies)
   * [Integration](#integration)
 
@@ -80,8 +80,8 @@ The application provides only two roles - `admin` and `manager` with following p
 | Create a project                                                  |                    | :white_check_mark: |
 | `Project > Consents`                                              |      Manager       |       Admin        |
 | View the list of consents                                         | :white_check_mark: | :white_check_mark: |
-| `Project > Cookie bars`                                           |      Manager       |       Admin        |
-| View the list of cookie bars                                      | :white_check_mark: | :white_check_mark: |
+| `Project > Cookie widgets`                                        |      Manager       |       Admin        |
+| View the list of cookie widgets                                   | :white_check_mark: | :white_check_mark: |
 | `Project > Cookies > Providers`                                   |      Manager       |       Admin        |
 | View and edit project providers                                   | :white_check_mark: | :white_check_mark: |
 | `Project > Cookies > Project cookies`                             |      Manager       |       Admin        |
@@ -229,21 +229,21 @@ So the correct procedure is to establish your projects first and then import the
 
 ## Projects
 
-After selecting a specific project, the user is moved to the context of the selected project where he can see consents, cookie bar settings and manage project cookies.
+After selecting a specific project, the user is moved to the context of the selected project where he can see consents, cookie widget settings and manage project cookies.
 
 ### Consents
 
 Here is the list of all recorded consents.
-The consents are grouped according to the user identifier that the cookie bar creates and sends. After clicking on a detail, you can see the complete history of that user.
+The consents are grouped according to the user identifier that the cookie widget creates and sends. After clicking on a detail, you can see the complete history of that user.
 
 <img src="images/consents-page.png" alt="Consents page" width="1000">
 
-### Cookie bars
+### Cookie widgets
 
-On this page you can find the settings of all cookie bars used.
-The uniqueness of the cookie bar is determined by the checksum that is calculated and sent by the cookie bar itself.
+On this page you can find the settings of all cookie widgets used.
+The uniqueness of the cookie widget is determined by the checksum that is calculated and sent by the cookie widget itself.
 
-<img src="images/cookie-bar-page.png" alt="Cookie bars page" width="1000">
+<img src="images/cookie-widget-page.png" alt="Cookie widgets page" width="1000">
 
 ### Project cookies
 

diff --git a/...ns/App_Web_AdminModule_ProjectModule_Control_ConsentHistory_ConsentHistoryControl.en.neon b/...ns/App_Web_AdminModule_ProjectModule_Control_ConsentHistory_ConsentHistoryControl.en.neon
@@ -6,4 +6,4 @@ App_Domain_Consent_Event_ConsentCreated:
 
 consents: Consents
 attributes: Attributes
-settings_checksum: Bar settings
+settings_checksum: Widget settings
diff --git a/...slations/App_Web_AdminModule_ProjectModule_Control_ConsentList_ConsentListControl.en.neon b/...slations/App_Web_AdminModule_ProjectModule_Control_ConsentList_ConsentListControl.en.neon
@@ -1,4 +1,4 @@
 user_identifier: User identifier
-settings_checksum: Bar settings
+settings_checksum: Widget settings
 created_at: Created
 last_update_at: Updated
diff --git a/...ule_ProjectModule_Control_ConsentSettingsDetail_ConsentSettingsDetailModalControl.en.neon b/...ule_ProjectModule_Control_ConsentSettingsDetail_ConsentSettingsDetailModalControl.en.neon
@@ -1,5 +1,5 @@
 title: '''
-Cookie bar
+Cookie widget
 <span class="inline-flex items-center px-2.5 py-0.5 ml-2 rounded-md text-sm font-medium bg-indigo-100 text-indigo-800">%checksum%</span>
 <span class="inline-flex items-center px-2.5 py-0.5 ml-2 rounded-md text-sm font-medium bg-purple-100 text-purple-800">version %shortIdentifier%</span>
 '''

diff --git a/translations/App_Web_AdminModule_ProjectModule_Presenter_ConsentSettingsPresenter.en.neon b/translations/App_Web_AdminModule_ProjectModule_Presenter_ConsentSettingsPresenter.en.neon
@@ -1 +1 @@
-page_title: Cookie bars
+page_title: Cookie widgets
diff --git a/translations/layout.en.neon b/translations/layout.en.neon
@@ -17,7 +17,7 @@ sidebar:
 
 sidebar_project:
 	consents: Consents
-	consent_settings: Cookie bars
+	consent_settings: Cookie widgets
 	cookies: Cookies
 	cookies_providers: Providers
 	cookies_cookies: Project cookies
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		page_title: Cookie bars
		page_title: Cookie widgets