Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ month_change: true

# Block reference

The following blocks are provided with a clean installation of [[= product_name =]]:
The following blocks are available in [[= product_name =]]:

|Block|Description|
|-----|-----------|
Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

[[= product_name =]] lets you customize and adapt the content model depending on your needs and the type of website you create.

Depending on your organization, if you are an editor or a content creator, it's possible that the content model for your installation has already been created by your administrator or content manager.
Depending on your organization, if you are an editor or a content creator, it's possible that the content model has been created by your administrator or content manager.

Check notice on line 12 in docs/content_management/content_model.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_model.md#L12

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/content_model.md", "range": {"start": {"line": 12, "column": 117}}}, "severity": "INFO"}
However, even a non-technical user can create or modify the content model through the editing interface.

## Content types
Expand All @@ -21,7 +21,7 @@
A content item may only contain the fields that are defined in the content type.

[[= product_name =]] allows you to create, edit, and delete content types and their fields.
A clean installation contains a few basic content types.
[[= product_name =]] comes with a few basic content types.

## Content items versus content types

Expand Down
12 changes: 1 addition & 11 deletions docs/content_management/content_organization/classify_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Sections let you decide which users can have access to which parts of the tree.
To see which section a content item belongs to, [disable the Focus mode](../../getting_started/discover_ui.md#disable-focus-mode), and look at its **Technical details** tab.

You can set up sections by navigating to **Content** -> **Sections**.
A few sections are provided with each installation, and you can add new ones.
[[= product_name =]] comes with a few sections, and you can add new ones.

![List of Sections](img/sections.png "List of Sections")

Expand All @@ -35,11 +35,6 @@ To do it, [disable the Focus mode](../../getting_started/discover_ui.md#disable-

![Object state details](img/object_state_details.png)

!!! note

The functioning of object states can be set up differently in each installation.
Contact your website administrator for information on how to use the states in your case.

## Bookmarks

You can bookmark any content item by clicking the star icon next to the content name.
Expand All @@ -63,9 +58,4 @@ You can create and configure segments and segment groups in the **Admin** sectio

![Segment groups](img/admin_panel_segment_groups.png "Segment groups")

!!! note

Assigning users to segments happens automatically according to rules set up by the administrator.
Contact your website administrator for more information about your setup.

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/uts6qBWYu0PgNqAjODY0?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Work with segments" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ To add URL aliases, go to the **URL** tab, and click **+ Add** in the **Custom U

![Add new URL alias](img/add_new_url.png)

The URL alias must be unique for the whole installation, regardless of the language.
The URL alias must be unique across the whole website, regardless of the language.

![Creating a new URL alias](img/create_new_url_alias.png)

Expand Down
7 changes: 1 addition & 6 deletions docs/content_management/create_edit_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@

In image options you can select an image variation.
Variations can include different sizing options and other filters that are applied to images.
Available image variations must be configured at the developer level.
Available image variations are configured by your integration partner.

Check notice on line 193 in docs/content_management/create_edit_content_items.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/create_edit_content_items.md#L193

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/create_edit_content_items.md", "range": {"start": {"line": 193, "column": 28}}}, "severity": "INFO"}
See [Images]([[= developer_doc =]]/content_management/images/images/) for a technical guide on how to do this.

#### Tables
Expand All @@ -199,11 +199,6 @@

In table options you can define the first row and/or column as headers, add or delete rows and columns in any part of the table, and also merge or split cells.

#### Custom elements

Your installation can also have custom elements available in the Rich Text field.
Contact your website administrator about the details of using them.

### AI Assistant

If [AI Actions](ai_actions.md) have been configured in your application, when writing content, the **Improve text** button is visible in the online editor's toolbox.
Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/create_edit_content_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ For example, when you add or remove a field to the content type, the change is p

!!! note

Rules and templates for displaying content on the website are determined at the developer level.
Rules and templates for displaying content on the website are determined by your integration partner.
That is why content of a new content type that you create may not always display correctly or may cause errors.
It's always best to discuss adding new content types with the administrator of your website, to make sure whether they need to add it to the configuration.
It's always best to discuss adding new content types with your integration partner, to make sure whether they need to add it to the configuration.

!!! caution "Deleting content types"

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/create_edit_pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ You cannot publish a page if you haven't set all the required settings of all bl
!!! tip

Settings and function of custom-made blocks of content depend on their design.
For details on adjusting and using them, contact your website administrator.
For details on adjusting and using them, contact your integration partner.

After you change the block settings, click **Submit** to save the changes or **Discard** to cancel.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

You can view content items which are in different stages under review on **My dashboard** screen, in the **Review queue** table.
The table only shows content items that your role has permissions to edit.
If your installation is [configured to support draft locking]([[= developer_doc =]]/content_management/workflow/workflow/#draft-locking), the table also informs you whether any reviewers are assigned and have claimed their drafts for review.
The table also informs you whether any reviewers are assigned and have claimed their drafts for review.

Check notice on line 24 in docs/content_management/workflow_management/editorial_workflow.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/workflow_management/editorial_workflow.md#L24

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/workflow_management/editorial_workflow.md", "range": {"start": {"line": 24, "column": 50}}}, "severity": "INFO"}

![Review queue in the dashboard](img/dashboard_review_queue.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Review a list of workflows that are available in the installation.
description: Review a list of workflows that are available in Cohesivo.
---

# View workflow list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Pick from a list of dynamic blocks to create a customized dashboard

# Dashboard block reference

The following blocks are provided with a clean installation of [[= product_name =]]:
The following blocks are available in [[= product_name =]]:

|Block|Description|
|-----|-----------|
Expand Down
8 changes: 1 addition & 7 deletions docs/getting_started/discover_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,10 @@ Focus mode is enabled by default when you first log into [[= product_name =]], b
## Help center

The ![Help center](about-info.png){.inline-image} icon appears at the bottom right of multiple screens.
Click it to access documentation, trainings, and other relevant resources straight from the back office.
Help center is also [another place]([[= developer_doc =]]/administration/admin_panel/system_information_admin_panel/) where you can check the [[= product_name =]] version that you're on.
Click it to access documentation, trainings, release notes, and product roadmap highlights straight from the back office.

![Help center](img/help_center.png "Help center")

Contents of the help center are contextual:

- If you are an [editor](editor.md) or [store manager](shop_manager.md) working in a production environment, help center contains links to user documentation, release notes and product roadmap highlights.
- If you are a developer whose task is to set up or extend the application, it additionally shows links to developer documentation, API references and the GraphQL console.

Help center can be [customized]([[= developer_doc =]]/administration/back_office/customize_integrated_help/) to fit the needs of your organization, for example, to include links to your internal style guides.

### Disable help center
Expand Down
17 changes: 5 additions & 12 deletions docs/getting_started/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,19 @@ It features a customizable user interface where you can work with the content, p
- [product management](product_catalog.md)
- [customer management](customer_management.md)

!!! note "Installation"

Only administrators can [install]([[= developer_doc =]]/getting_started/install_cohesivo/) [[= product_name =]].
They should provide you with the address of the installation.

## Access the back office

To access the back office (or the user/editor interface), add `/admin` to the address provided by the administrator.
For example, if your website's URL is `www.my-site.com`, you enter the editing interface through `www.my-site.com/admin`.

If you're the administrator, use the login credentials that were set [during the installation process]([[= developer_doc =]]/getting_started/install_cohesivo/#create-a-database).
Your [[= product_name =]] environment is set up for you as part of your subscription.
Your administrator provides you with its address and your user credentials.

Otherwise, to log in, you must get your user credentials from the administrator, and enter them on the login screen.
To log in, enter the user credentials on the login screen.

![Login screen](img/login_form.png "Login screen")

### Onboarding

When you log in to [[= product_name =]] for the first time, interactive product tours appear.
This in-app walkthroughs guide you through key features and help you get started quickly.
These in-app walkthroughs guide you through key features and help you get started quickly.

You can complete each step of the onboarding tutorials, skip them entirely if you prefer to explore on your own, or restart them anytime from your [user settings](#user-settings) under the **Browsing** section.

Expand Down Expand Up @@ -123,7 +116,7 @@ Here you can [change your user password](get_started.md#change-the-password) and
|Location preview|Enables or disables a thumbnail preview on the content tree.|
|Help center|Enables or disables the [help center](discover_ui.md#help-center). |
|Product tour|Enables or disables the [product tour onboarding](#onboarding) walkthroughs. |
|Product tour scenarios settings|Separate setting for each available product tour scenario. Allows you to mark each scenario as completed or reset its progress. [[% include 'snippets/lts-update_badge.md' %]]|
|Product tour scenarios settings|Separate setting for each available product tour scenario. Allows you to mark each scenario as completed or reset its progress.|
|Side-by-side layout|Decides on which side of the screen the target language column should be displayed in the [side-by-side translation view](translate_content.md#side-by-side-translation-view). |
|Automatic translation for new items|Controls the behavior of the [**Create a new translation** modal](translate_content.md#add-new-translation). When activated, the **Use automatic translation** checkbox is selected and the default translation service for the language pair is preselected. Inactive when no automated translation services are defined. |

Expand Down
2 changes: 1 addition & 1 deletion docs/persona_paths/manage_content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Manage content model

If you have Administrator permissions, you can develop a content model that is used in your [[= product_name =]] installation.
If you have Administrator permissions, you can develop the content model that is used in [[= product_name =]].

Check notice on line 7 in docs/persona_paths/manage_content_model.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/persona_paths/manage_content_model.md#L7

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/persona_paths/manage_content_model.md", "range": {"start": {"line": 7, "column": 79}}}, "severity": "INFO"}
Learn more and create or modify content types.

[[= cards([
Expand Down
6 changes: 1 addition & 5 deletions docs/product_catalog/create_edit_product.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can only create or modify products when your [user role](../permission_manag
To create a product, depending on how the product type is defined, you [may need to provide](products.md#product-completeness) certain pieces of information in their respective [fields](../content_management/content_model.md#fields-and-field-types).

You can create products using either manual or bulk method.
Bulk method can be used only at the developer level.
Bulk method is available through the API.
See [Products]([[= developer_doc =]]/product_catalog/product_api/#products) for a technical guide on how to do this.

1\. Click **Product catalog** -> **Products**.
Expand Down Expand Up @@ -45,8 +45,4 @@ If you're editing an existing one, click the **Update** button.

After you create a product, you can [add image assets to a product](work_with_product_assets.md), [create variants to the main product](work_with_product_variants.md), [define product prices](manage_prices.md), [set the available quantity](manage_availability_and_stock.md) and [classify products into different categories](work_with_product_categories.md).

!!! note

Feature availability may differ depending on the specifics of your installation.

For in-depth information, see [Products]([[= developer_doc =]]/product_catalog/products/) in Developer Documentation.
2 changes: 0 additions & 2 deletions docs/product_catalog/work_with_product_attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ Available attribute types are:
- Selection - one of a list of customizable options
- Symbol - value of product's symbol attribute

If the default list of attributes is not sufficient, ask your development team to [create a custom attribute type]([[= developer_doc =]]/product_catalog/create_custom_attribute_type/).

!!! note "Attribute translations"

Product attributes are not translatable.
Expand Down
8 changes: 0 additions & 8 deletions docs/recent_activity/recent_activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,6 @@ By default, actions on the following items are displayed:
- [Product variant](work_with_product_variants.md)
- [Site](work_with_sites.md)

!!! note

If your implementation requires that other actions are logged, see [custom log entry Developer Documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#add-custom-activity-log-entries).

By default, log entries are kept for 30 days.
This time can be modified through configuration.
For more information, see [Developer Documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#configuration).

Log entries are grouped by date, then by logical bond (like web request, or migration file).

Each activity log entry shows:
Expand Down
11 changes: 3 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ INHERIT: plugins.yml

site_name: User Documentation
repo_url: https://github.com/ibexa/documentation-user
site_url: https://doc.ibexa.co/projects/userguide/en/latest/
edit_uri: blob/5.0/docs
site_url: https://doc.ibexa.co/projects/userguide/en/saas/
edit_uri: blob/saas/docs
hooks:
- hooks/edit_uri.py
- hooks.py
Expand Down Expand Up @@ -158,16 +158,11 @@ extra:
product_name_cdp_base: 'Raptor'
product_name_connect: 'Ibexa Connect'
product_name_cloud: 'Ibexa Cloud'
product_name_oss: 'Cohesivo OSS'
product_name_dam: 'Ibexa DAM'
product_name_engage: 'Qualifio'
pim_product_name: 'Quable'

developer_doc: 'https://doc.ibexa.co/en/6.0'

latest_tag_4_6: '4.6.32'
latest_tag_5_0: '5.0.10'
latest_tag_6_0: '6.0.0'
developer_doc: 'https://doc.ibexa.co/en/saas'

extra_css:
- fonts/MavenPro.css
Expand Down
Loading