diff --git a/README.md b/README.md index 12784c9d..6ed3423f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Ibexa DXP User Documentation +# Cohesivo CMS User Documentation -This repository is the source for [User Documentation for Ibexa DXP](https://doc.ibexa.co/projects/userguide/en/latest/), +This repository is the source for [User Documentation for Cohesivo CMS](https://doc.ibexa.co/projects/userguide/en/latest/), a digital experience platform that is based on the Symfony Full Stack Framework in PHP. # Resources -1. Ibexa DXP Developer Hub: https://developers.ibexa.co -1. Ibexa DXP Repository: https://github.com/ibexa/oss +1. Cohesivo CMS Developer Hub: https://developers.ibexa.co +1. Cohesivo CMS Repository: https://github.com/ibexa/oss 1. Open JIRA board: https://issues.ibexa.co 1. Ibexa Website: https://ibexa.co 1. User Documentation: https://doc.ibexa.co/projects/userguide @@ -15,7 +15,7 @@ a digital experience platform that is based on the Symfony Full Stack Framework To contribute to the documentation, you can open a PR in this repository. -If you'd like to see Ibexa DXP in your language, you can [contribute to the translations](https://doc.ibexa.co/en/latest/resources/contributing/contribute_translations/). +If you'd like to see Cohesivo CMS in your language, you can [contribute to the translations](https://doc.ibexa.co/en/latest/resources/contributing/contribute_translations/). ## Build and preview documentation diff --git a/docs/content_management/block_reference.md b/docs/content_management/block_reference.md index 771d7a42..696a4604 100644 --- a/docs/content_management/block_reference.md +++ b/docs/content_management/block_reference.md @@ -94,7 +94,7 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr ### Campaign block -Displays a campaign created and configured in [[[= product_name_engage =]]](../ibexa_engage/ibexa_engage.md). +Displays a campaign created and configured in [[[= product_name_engage =]]](../qualifio/qualifio.md). On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the campaign. diff --git a/docs/content_management/content_items.md b/docs/content_management/content_items.md index f34a1cd2..2725d8f0 100644 --- a/docs/content_management/content_items.md +++ b/docs/content_management/content_items.md @@ -1,5 +1,5 @@ --- -description: Content items are containers that Ibexa DXP uses to store content data. +description: Content items are containers that Cohesivo CMS uses to store content data. --- # Content items diff --git a/docs/content_management/content_model.md b/docs/content_management/content_model.md index 90dac427..2691a388 100644 --- a/docs/content_management/content_model.md +++ b/docs/content_management/content_model.md @@ -1,5 +1,5 @@ --- -description: The Ibexa DXP content model relies on content items that are based on predefined content types. +description: The Cohesivo CMS content model relies on content items that are based on predefined content types. --- # Content model diff --git a/docs/dam/ibexa_dam.md b/docs/dam/ibexa_dam.md deleted file mode 100644 index 59aa92cc..00000000 --- a/docs/dam/ibexa_dam.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -description: DAM module interface for uploading and managing image assets. -edition: headless ---- - -# [[= product_name_dam =]] - -Digital Asset Management is a platform dedicated to editors. -It enables storing in central location, organizing, distributing, and sharing media assets across many channels. - -[[= product_name_dam =]] image picker is developed to work with any web browser that supports modern standards. -The minimum screen resolution is 1366 x 768. - -List of supported web browsers: - -- Mozilla® Firefox® most recent stable version (recommended) -- Google Chrome™ most recent stable version (recommended) -- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop and tablet -- Apple® Safari® most recent stable version, desktop and tablet - -## View modes - -The main window is available in two display versions: grid and list view. - -To change the view mode, in the upper-right corner, click **View** and select the view you need. - -### Grid view - -Grid view contains image preview, file format, and image size. - -### List view - -List view contains a thumbnail, title, format, size, dimensions, creation, and update date. - -### Sorting - -You can sort image assets by alphabetical order or by the creation date. -To sort image assets, in the upper-right corner, click **Date** and select the sorting method you need. - -## Search assets - -### Keyword search - -The search option allows to find image assets using a word or phrase. -To use it, in the upper part of the screen, click the **Search** field. -Enter a search keyword. -The platform searches assets for matches based on the keyword, including file title. - -### Filter by attributes - -With filtering by attributes, you can narrow search results to the following attributes: - -- language -- format -- file size -- orientation -- dimensions -- tags (this filter is available only when image assets have tags assigned to) -- date of creation - -To use it, in the right-side panel select attributes and click the **Apply** button. -You can combine searches by all types of filtering: keyword search and attributes filter. - -!!! note "Search engine support" - - Filtering works only when [[= product_name_base =]] uses `solr` or `elasticsearch` search engine. - Legacy Search Engine (LSE) isn't supported. - -### Navigation - -Assets are organized and stored in folders. The folder structure serves as another option for filtering assets. - -To navigate through folders, go to left-side panel **Folders**, and in the folders tree view, click folder you want to open. - -!!! note - - Filtering by attribues and folders is complimentary, it means you have to use these two methods at once to get search results. - -### Insert images - -To insert an image asset into the HTML editor, find the image with search options, or manually locate the asset in the folder. -Next, click the image thumbnail. -The selected item is marked with a red dot in the upper-left corner. -To confirm the selection, in the bottom toolbar, click **Insert**. - -You can only select one image at a time. -To deselect the image, click the thumbnail again. \ No newline at end of file diff --git a/docs/getting_started/dashboard/dashboard.md b/docs/getting_started/dashboard/dashboard.md index c1230a7a..2008d7f7 100644 --- a/docs/getting_started/dashboard/dashboard.md +++ b/docs/getting_started/dashboard/dashboard.md @@ -35,7 +35,7 @@ By default, dashboard in [[= product_name_exp =]] and [[= product_name_com =]] c - [Quick actions](dashboard_block_reference.md#quick-actions-block) - [Recent activity](dashboard_block_reference.md#recent-activity-block) -- [Ibexa News](dashboard_block_reference.md#ibexa-news-block) +- [Cohesivo News](dashboard_block_reference.md#cohesivo-news-block) - [Review queue](dashboard_block_reference.md#review-queue-block) - [My content](dashboard_block_reference.md#my-content-block) - [Common content](dashboard_block_reference.md#common-content-block) diff --git a/docs/getting_started/dashboard/dashboard_block_reference.md b/docs/getting_started/dashboard/dashboard_block_reference.md index 4de1a5d4..e7520288 100644 --- a/docs/getting_started/dashboard/dashboard_block_reference.md +++ b/docs/getting_started/dashboard/dashboard_block_reference.md @@ -9,7 +9,7 @@ The following blocks are provided with a clean installation of [[= product_name |Block|Description| |-----|-----------| |[Common content](#common-content-block)|Displays a list of content items created by all members of the organization that the user belongs to.| -|[Ibexa News](#ibexa-news-block)|Displays a list of recent blog posts or articles published at [ibexa.co blog](https://www.ibexa.co/blog) (product related).| +|[Cohesivo News](#cohesivo-news-block)|Displays a list of recent blog posts or articles published at [ibexa.co blog](https://www.ibexa.co/blog) (product related).| |[My content](#my-content-block)|Displays a list of content items created by the user who is currently logged in.| |[Orders by status](#orders-by-status-block)|Displays a chart presenting orders and their status.| |[Products by category](#products-by-category-block)|Displays a chart presenting products by their category.| @@ -35,7 +35,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of content and submit your changes. -## Ibexa News block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Cohesivo News block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] Presents a list of recent blog posts or articles published at `ibexa.co` blog (product related). It includes title, image, publication date, and link to article details. @@ -158,7 +158,7 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr ## Top 10 clicked items block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] -Requires [Ibexa Personalization](personalization.md) enabled. +Requires [Personalization](personalization.md) enabled. Displays a table presenting top 10 clicked items. diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md index 5aa17c7e..0603eef0 100644 --- a/docs/getting_started/get_started.md +++ b/docs/getting_started/get_started.md @@ -1,5 +1,5 @@ --- -description: Get started with Ibexa DXP by logging in to the back office. +description: Get started with Cohesivo CMS by logging in to the back office. month_change: true --- diff --git a/docs/image_management/upload_images.md b/docs/image_management/upload_images.md index c6dac6ef..cc1ee5b1 100644 --- a/docs/image_management/upload_images.md +++ b/docs/image_management/upload_images.md @@ -1,5 +1,5 @@ --- -description: Upload images to Ibexa DXP to manage them. +description: Upload images to Cohesivo CMS to manage them. --- # Upload and store images diff --git a/docs/index.md b/docs/index.md index 57174dae..f6b1e7d9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@
-

Ibexa User Documentation

+

Cohesivo User Documentation

How to start?

diff --git a/docs/persona_paths/explorer.md b/docs/persona_paths/explorer.md index f11d25ed..04ae54ec 100644 --- a/docs/persona_paths/explorer.md +++ b/docs/persona_paths/explorer.md @@ -1,5 +1,5 @@ --- -description: Browse a list of topics that bring you closer to understanding Ibexa DXP. +description: Browse a list of topics that bring you closer to understanding Cohesivo CMS. --- # Time to explore diff --git a/docs/product_catalog/quable_pim_integration.md b/docs/product_catalog/quable_pim_integration.md index 6bd58807..60fb8e69 100644 --- a/docs/product_catalog/quable_pim_integration.md +++ b/docs/product_catalog/quable_pim_integration.md @@ -1,5 +1,5 @@ --- -description: Quable PIM integration allows you to use products managed in Quable as the source of product data in Ibexa DXP. +description: Quable PIM integration allows you to use products managed in Quable as the source of product data in Cohesivo CMS. month_change: true --- diff --git a/docs/ibexa_engage/img/campaign_block.png b/docs/qualifio/img/campaign_block.png similarity index 100% rename from docs/ibexa_engage/img/campaign_block.png rename to docs/qualifio/img/campaign_block.png diff --git a/docs/ibexa_engage/img/campaign_custom_tag.png b/docs/qualifio/img/campaign_custom_tag.png similarity index 100% rename from docs/ibexa_engage/img/campaign_custom_tag.png rename to docs/qualifio/img/campaign_custom_tag.png diff --git a/docs/ibexa_engage/img/qualifio_manager.png b/docs/qualifio/img/qualifio_manager.png similarity index 100% rename from docs/ibexa_engage/img/qualifio_manager.png rename to docs/qualifio/img/qualifio_manager.png diff --git a/docs/ibexa_engage/img/welcome_page_activated.png b/docs/qualifio/img/welcome_page_activated.png similarity index 100% rename from docs/ibexa_engage/img/welcome_page_activated.png rename to docs/qualifio/img/welcome_page_activated.png diff --git a/docs/ibexa_engage/img/welcome_page_form.png b/docs/qualifio/img/welcome_page_form.png similarity index 100% rename from docs/ibexa_engage/img/welcome_page_form.png rename to docs/qualifio/img/welcome_page_form.png diff --git a/docs/ibexa_engage/ibexa_engage.md b/docs/qualifio/qualifio.md similarity index 93% rename from docs/ibexa_engage/ibexa_engage.md rename to docs/qualifio/qualifio.md index f7627360..5e08b97a 100644 --- a/docs/ibexa_engage/ibexa_engage.md +++ b/docs/qualifio/qualifio.md @@ -1,21 +1,20 @@ --- -description: Use Ibexa Engage to engage audiences and collect valuable data. +description: Use Qualifio to engage audiences and collect valuable data. month_change: false --- # [[= product_name_engage =]] -[[= product_name_engage =]] is a data collection tool. -It gives you the ability to use the [Qualifio](https://qualifio.com/) tools to engage your audiences. +[[= product_name_engage =]] is a data collection tool powered by [Qualifio](https://qualifio.com/). You can use interactive content to build relationships and collect important data, for example, a list of recent orders, or personal information about customers. ## Request access To use [[= product_name_engage =]], you must make arrangements with [[= product_name_base =]] to define the initial configuration, and then get and set up a user account. -1\. On the left menu panel, go to **Ibexa Engage**. +1\. On the left menu panel, go to **[[= product_name_engage =]]**. -2\. On the left panel, go to **Ibexa Engage**. +2\. On the left panel, go to **[[= product_name_engage =]]**. 3\. On the welcome page, provide the required information: @@ -70,7 +69,7 @@ Every campaign includes at least one publication channel, which you can choose f ## Work with campaigns You can create, configure, and manage campaigns with [Qualifio Engage](https://developers.qualifio.com/docs/engage/). -To access the Qualifio Manager page and create or manage campaigns, click the **Manage campaigns in Qualifio** button under the **Ibexa Engage** menu. +To access the Qualifio Manager page and create or manage campaigns, click the **Manage campaigns in Qualifio** button under the **[[= product_name_engage =]]** menu. To display your campaign on the website, use one of the available tools - Campaign block or Campaign custom tag. For more information about creating and managing campaigns, see [Qualifio Engage documentation](https://support.qualifio.com/hc/en-us/categories/202280638-Qualifio-Engage). diff --git a/main.py b/main.py index a504b52b..b2703a4c 100644 --- a/main.py +++ b/main.py @@ -137,7 +137,7 @@ def cards(pages, columns=1, style="cards", force_version=False): description = "" href = page title = custom_title if custom_title else title - title = title.replace("(Ibexa Documentation)", "").strip() + title = title.replace("(Cohesivo Documentation)", "").strip() description = custom_description if custom_description else description else: match = re.search("^# (.*)", content, re.MULTILINE) diff --git a/mkdocs.yml b/mkdocs.yml index 3ae2fc56..5f7e5c9a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,7 @@ not_in_nav: | search_results.md /snippets/* nav: - - Ibexa User Documentation: index.md + - Cohesivo User Documentation: index.md - Getting started: - Get started: getting_started/get_started.md - User interface: getting_started/discover_ui.md @@ -122,10 +122,8 @@ nav: - Recommendations: - Raptor integration: - Recommendation blocks: recommendations/raptor_integration/raptor_recommendation_blocks.md - - Ibexa Engage: - - Ibexa Engage: ibexa_engage/ibexa_engage.md - - DAM: - - Ibexa DAM: dam/ibexa_dam.md + - Qualifio: + - Qualifio: qualifio/qualifio.md - Customer management: - Customer management: customer_management/customer_management.md - Customer Portal: customer_management/customer_portal.md @@ -183,19 +181,17 @@ extra: - title: 'Connect Documentation' url: '/projects/connect' # Global variables - site_display_name: 'Ibexa Documentation' + site_display_name: 'Cohesivo Documentation' product_name_base: 'Ibexa' - product_name: 'Ibexa DXP' - product_name_content: 'Ibexa Content' - product_name_headless: 'Ibexa Headless' - product_name_exp: 'Ibexa Experience' - product_name_com: 'Ibexa Commerce' - product_name_cdp: 'Ibexa CDP' + product_name: 'Cohesivo CMS' + product_name_content: 'Cohesivo Content' + product_name_headless: 'Cohesivo Headless' + product_name_exp: 'Cohesivo Experience' + product_name_com: 'Cohesivo Commerce' + product_name_cdp: 'Raptor CDP' product_name_connect: 'Ibexa Connect' product_name_cloud: 'Ibexa Cloud' - product_name_oss: 'Ibexa OSS' - product_name_dam: 'Ibexa DAM' - product_name_engage: 'Ibexa Engage' + product_name_engage: 'Qualifio' pim_product_name: 'Quable' developer_doc: 'https://doc.ibexa.co/en/6.0' diff --git a/plugins.yml b/plugins.yml index 77a27471..6d8a59ce 100644 --- a/plugins.yml +++ b/plugins.yml @@ -9,6 +9,7 @@ plugins: - tags - redirects: redirect_maps: + 'ibexa_engage/ibexa_engage.md': 'qualifio/qualifio.md' 'content_model.md': 'persona_paths/manage_content_model.md' 'creating_content_basic.md': 'persona_paths/author_content.md' 'creating_forms.md': 'content_management/work_with_forms.md'