Skip to content
Open
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
6 changes: 6 additions & 0 deletions .github/workflows/link_check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@ on:
push:
branches:
- master
- saas
- "[0-9]+.[0-9]+"
workflow_dispatch:
inputs:
force_recheck:
description: "Clear lychee cache and recheck all links from scratch"
type: boolean
default: false
devdoc_saas_branch:
description: "ibexa/documentation-developer branch for SaaS"
type: string
default: "saas"
devdoc_60_branch:
description: "ibexa/documentation-developer branch for 6.0"
type: string
Expand Down Expand Up @@ -82,6 +87,7 @@ jobs:
- name: Clone and build versioned repositories for link remap
run: >-
bash tools/clone-repositories.sh
"${{ inputs.devdoc_saas_branch || 'saas' }}"
"${{ inputs.devdoc_60_branch || '6.0' }}"
"${{ inputs.devdoc_50_branch || '5.0' }}"
"${{ inputs.devdoc_46_branch || '4.6' }}"
Expand Down
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,21 +59,27 @@
The script accepts optional branch names before cloning repositories:

```bash
./tools/clone-repositories.sh [DEVDOC_50] [DEVDOC_46] [USERDOC_50] [USERDOC_46] [CONNECT]
./tools/clone-repositories.sh [DEVDOC_SAAS] [DEVDOC_60] [DEVDOC_50] [DEVDOC_46] [USERDOC_60] [USERDOC_50] [USERDOC_46] [CONNECT]
```

| Argument | Repository | Default |
|--------------|---------------------------------|---------|
| `DEVDOC_50` | `ibexa/documentation-developer` | `5.0` |
| `DEVDOC_46` | `ibexa/documentation-developer` | `4.6` |
| `USERDOC_50` | `ibexa/documentation-user` | `5.0` |
| `USERDOC_46` | `ibexa/documentation-user` | `4.6` |
| `CONNECT` | `ibexa/documentation-connect` | `main` |
| Argument | Repository | Default |
|---------------|---------------------------------|---------|

Check notice on line 66 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L66

[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message": "[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "README.md", "range": {"start": {"line": 66, "column": 4}}}, "severity": "INFO"}
| `DEVDOC_SAAS` | `ibexa/documentation-developer` | `saas` |
| `DEVDOC_60` | `ibexa/documentation-developer` | `6.0` |
| `DEVDOC_50` | `ibexa/documentation-developer` | `5.0` |

Check warning on line 69 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L69

[Ibexa.FirstPersonPronouns] Do not use first person pronouns unless specifically referring to our company.
Raw output
{"message": "[Ibexa.FirstPersonPronouns] Do not use first person pronouns unless specifically referring to our company.", "location": {"path": "README.md", "range": {"start": {"line": 69, "column": 46}}}, "severity": "WARNING"}
| `DEVDOC_46` | `ibexa/documentation-developer` | `4.6` |
| `USERDOC_60` | `ibexa/documentation-user` | `6.0` |

Check notice on line 71 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L71

[Ibexa.ArticlesInHeadings] Avoid articles in headings.
Raw output
{"message": "[Ibexa.ArticlesInHeadings] Avoid articles in headings.", "location": {"path": "README.md", "range": {"start": {"line": 71, "column": 12}}}, "severity": "INFO"}
| `USERDOC_50` | `ibexa/documentation-user` | `5.0` |
| `USERDOC_46` | `ibexa/documentation-user` | `4.6` |
| `CONNECT` | `ibexa/documentation-connect` | `main` |

There is no `USERDOC_SAAS` argument: this repository is the SaaS user documentation, so
links to `/projects/userguide/en/saas/` are checked against the local `site/` build.

Example — checking link for release PRs:

```bash
./tools/clone-repositories.sh release-5.0.10 release-4.6.70 4.6 4.6 main
./tools/clone-repositories.sh saas release-6.0.1 release-5.0.10 release-4.6.70 6.0 5.0 4.6 main
```

The same parameters are available as inputs when triggering the GitHub Actions workflow manually.
Expand Down
2 changes: 0 additions & 2 deletions docs/ai_actions/ai_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Learn how AI Actions can help editors by automating repetitive task
# AI Actions

AI Actions is a set of capabilities that enhance the efficiency and creativity of content editors.
The feature is included in [[= product_name =]] by default but may require some [configuration]([[= developer_doc =]]/ai/ai_actions/configure_ai_actions/) before you can use it.

Once AI Actions are configured, content editors with `Action configuration/View` and `Action configuration/Execute` permissions have access to AI-driven tools.
For example, they can [enhance or improve the text](create_edit_content_items.md#ai-assistant) that they have written, or [generate alternative text](upload_images.md#ai) for images.

Expand Down
38 changes: 0 additions & 38 deletions docs/ai_actions/work_with_ai_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,44 +138,6 @@ If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/

1. Click **Save and close** to apply the changes or **Discard** to discard them and close the window.

### Create AI actions that use [[= product_name_connect =]]

If your organization uses [[= product_name_connect =]], you can build multi-step scenarios that define the logic needed to process your input data, for example, by merging the output of multiple AI services.
One such example could be sending out a text for translation by one service, and then to another to make sure that the resulting translation is written in the right tone.

!!! note "[[= product_name_connect =]] configuration required"

To use AI actions that interface with [[= product_name_connect =]], you must first [configure and initiate the connection]([[= developer_doc =]]/ai/ai_actions/configure_ai_actions/#configure-access-to-ibexa-connect), and [define templates](https://doc.ibexa.co/projects/connect/en/latest/scenarios/scenario_templates/#creating-templates) and/or [scenarios](https://doc.ibexa.co/projects/connect/en/latest/scenarios/creating_a_scenario/) in [[= product_name_connect =]].

1\. Navigate to the Admin Panel and select **AI actions**.

2\. In the **AI actions** list, click **Create**.

3\. In the slide-out pane, make choices like in [Create new AI actions](#create-new-ai-actions) but in the **Action handler** field, select the model that uses an [[= product_name_connect =]] scenario to process the request, for example `connect-image-to-text`, and then click **Create**.

![[[= product_name_connect =]] handler](img/ai_action_connect_handler_selection.png)

4\. In the **Global properties** area, set the required properties.

5\. In the **Settings** area, select an existing scenario from a drop-down list.
The list contains all scenarios that exist in [[= product_name_connect =]].
They may be incompatible with the selected action type and require adjustments on the [[= product_name_connect =]] side.

6\. Optionally, if there are no scenarios for the selected action type, or you want to create a custom scenario, click **Create scenario based on template** and select a template from a drop-down list.

If you do so, when you save the new AI action, a new scenario is automatically created.
You must then fine-tune its settings in [[= product_name_connect =]].

![[[= product_name_connect =]] scenario selection](img/ai_action_settings_connect.png "[[= product_name_connect =]] scenario selection")

!!! note "Link to [[= product_name_connect =]]"

Click **Go to Connect** to review all scenarios that exist in [[= product_name_connect =]].

7\. Click **Save and close** to apply the changes or **Discard** to discard them and close the window.

After you save the AI action, you can click its name in the AI actions list and see all the information, such as Scenario ID, webhook URL, or scenario label, which you may needed when working with scenarios in [[= product_name_connect =]].

## Duplicate AI actions

You can duplicate existing actions, for example, to create a variant version of an action with slightly different settings.
Expand Down
8 changes: 1 addition & 7 deletions docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,7 @@ On the **Properties** tab, set values in the following fields:

!!! caution "Known limitation"

To display two or more identical forms on a single page, have your developer create multiple identical form blocks for your use. This prevents potential issues related to duplicate data submission.

For more information about creating form blocks, see [Creating a newsletter form]([[= developer_doc =]]/content_management/pages/create_custom_page_block/) in Developer Documentation.
To prevent potential issues related to duplicate data submission, avoid embedding two or more identical forms on a single page.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To prevent potential issues related to duplicate data submission, avoid embedding two or more identical forms on a single page.
To prevent potential issues related to duplicate data submission, do not embed two or more identical forms on a single page.


### Gallery block

Expand All @@ -180,10 +178,6 @@ On the **Properties** tab, set values in the following fields:
- **Name** – Enter a name for the page block.
- **Webhook link** — Enter the link for the [[= product_name_connect =]] webhook.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about removing the entire "Ibexa Connect block" here and from the list? You've removed Connect from developer doc entirely.

!!! caution "Using [[= product_name_connect =]] scenario block"

For more information about using [[= product_name_connect =]] scenario block, see [[[= product_name_connect =]] scenario block]([[= developer_doc =]]/content_management/pages/ibexa_connect_scenario_block/) in Developer Documentation.

### Product collection block

Presents curated collections of items for easier exploration and discovery.
Expand Down
1 change: 0 additions & 1 deletion docs/content_management/configure_ct_field_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ You modify them in the **Field definitions** section, the **Landing page** field
### Block display

You can define which page blocks are available to an editor in the page edit mode.
You do it, for example, when a [developer creates a new block]([[= developer_doc =]]/content_management/pages/create_custom_page_block/) and you want to allow adding it to the page.

Expand the **Select blocks** section and select page blocks that you want to be included in the page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ You can also copy the whole subtree (a content item with all content under it in
Copying very large subtrees may take too much time and server effort.
That is why the system administrator may set a limit on how many content items can be copied at the same time.

See [Copy subtree limit]([[= developer_doc =]]/administration/back_office/back_office_configuration/#copy-subtree-limit) in Developer Documentation on how to set this up.

Copying creates a new content item.
If you only want to have the same content item to another place in the content tree, add another location to it.

Expand Down
11 changes: 3 additions & 8 deletions docs/content_management/create_edit_pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,7 @@ Page Builder has two main views that you can use while creating a page:

[Layout](configure_ct_field_settings.md#available-page-layouts) divides the page into the defined zones. The zones are placeholders for the blocks.

The page layouts that an editor has access to are up to you to choose.

The default, built-in Page layout has only one zone, but developers can create other layouts in configuration.
For more information, see [Configure layout]([[= developer_doc =]]/templating/render_content/render_page/#configure-layout).

While editing, you can switch layout for your page.
While editing, you can switch layout for your page from the available ones.
To do it, click **Switch layouts** button.

### Add blocks
Expand Down Expand Up @@ -139,15 +134,15 @@ To change this behavior, click on **Edit** icon, find the setting, and change it
![User settings - blocks](img/user_settings_blocks.png "User settings - blocks settings")

[[= product_name =]] comes with a set of ready-to-use page blocks,
but [developers can add their own]([[= developer_doc =]]/content_management/pages/create_custom_page_block/).
but your integration partner can add custom ones.
Comment on lines 136 to +137

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this declaration true? I thought we won't customize SaaS?
I'd rather remove this promise.

Suggested change
[[= product_name =]] comes with a set of ready-to-use page blocks,
but [developers can add their own]([[= developer_doc =]]/content_management/pages/create_custom_page_block/).
but your integration partner can add custom ones.
[[= product_name =]] comes with a set of ready-to-use page blocks.


For a list of blocks available out of the box, see [Block reference](block_reference.md).

!!! note

Before you add a block that involves products, product types, or product categories, make sure your that your [user role](../permission_management/permissions_and_users.md) has the `Product/View` and `Product type/View` permission.

Before you add a [recommendation block](raptor_recommendation_blocks.md), make sure that the [[= product_name_cdp_base =]] integration is properly [configured]([[= developer_doc =]]/recommendations/raptor_integration/connector_installation_configuration/).
Before you add a [recommendation block](raptor_recommendation_blocks.md), make sure that the [[= product_name_cdp_base =]] integration is properly configured.

You can work with the block, for example, duplicate it, change its position, or delete it.
Hover over the block and the toolbar appears.
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/translate_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@

To see the translation services that are available in your system, go to **Admin** -> **Languages** -> **Translation services** tab.

The tab lists all translation services that have been [configured by the developer]([[= developer_doc =]]/multisite/translations_management/configure_translations_management/#configure-translation-providers).
The tab lists all translation services that have been configured.

Check notice on line 101 in docs/content_management/translate_content.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/translate_content.md#L101

[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/translate_content.md", "range": {"start": {"line": 101, "column": 50}}}, "severity": "INFO"}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The tab lists all translation services that have been configured.
The tab lists all available translation services.

That's safer

Each service shows its name, vendor, and whether it's enabled.
Disabled services don't appear as choices in the **Create a new translation** modal.

Expand Down
7 changes: 2 additions & 5 deletions docs/customer_management/build_customer_portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# Create and edit Customer Portal

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Customer Portal is going away entirely...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be removed in a separate PR


To create and edit a Customer Portal with Page Builder, you need to first set it up in configuration.
For detailed instructions on how to do it, go to [Create Customer Portal]([[= developer_doc =]]/customer_management/cp_page_builder/).

The Customer Portal creation and edition are based on Page Builder and work on the same principles.
If you're unfamiliar with how Page Builder works, see [Create and edit Pages](create_edit_pages.md).
Expand All @@ -15,8 +14,6 @@
To create a new Customer Portal, go to **Content** and from the menu select **Content structure**.
There, navigate to the root folder for your Customer Portals.
If you don't have one, you can add it yourself.
Remember to specify its `location_id` in the configuration, you can find it under **Technical details**.
For more information, see [Configure Page Builder access to Customer Portal]([[= developer_doc =]]/customer_management/cp_page_builder/#configure-page-builder-access-to-customer-portal).

Inside a root folder you can select **Create content** from the right-side toolbar.
On the list of content items, you can see two possibilities: **Customer Portal** and **Customer Portal Page**.
Expand All @@ -38,7 +35,7 @@

![Page Builder view](img/cp_page_builder.png)

If provided ready-to-use Page blocks aren't sufficient, you can [add your own blocks]([[= developer_doc =]]/content_management/pages/create_custom_page_block/).
If provided ready-to-use Page blocks aren't sufficient, your integration partner can add custom blocks.

Before you publish or save the Customer Portal page, edit its title and description in the field view, you can find it in the top toolbar on the left side.

Expand Down Expand Up @@ -73,4 +70,4 @@
Customer Portal is only available to users that are members of the company.
Even if a user has all sufficient permissions but is not a member of a company, they cannot see the Customer Portal.

Customer Portal must also be assigned to the company's Customer Group. To learn more see, [assigning portals to Customer Groups]([[= developer_doc =]]/customer_management/cp_page_builder/#assign-portal-to-customer-group).
Customer Portal must also be assigned to the company's Customer Group.

Check notice on line 73 in docs/customer_management/build_customer_portal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/customer_management/build_customer_portal.md#L73

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/customer_management/build_customer_portal.md", "range": {"start": {"line": 73, "column": 27}}}, "severity": "INFO"}
5 changes: 1 addition & 4 deletions docs/getting_started/content_tree/content_tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@ The **Content tree** area is an expandable content menu of your website.

The same tree structure is used in other areas of the Content menu, such as **Media** or **Forms**.

Unique icons for each content type instantly show you what type of content you are selecting. To add custom icons to your content tree, follow the [configuration tutorial in developer documentation]([[= developer_doc =]]/administration/back_office/back_office_elements/custom_icons/#customize-content-type-icons).

For more information about custom configuration, go to [Content tree]([[= developer_doc =]]/administration/back_office/content_tree/) in developer documentation.

Unique icons for each content type instantly show you what type of content you are selecting.
Within the content tree, hidden content is greyed out in the tree view.

To simplify the content tree, big lists are collapsed and include a **Show more** icon.
Expand Down
2 changes: 0 additions & 2 deletions docs/getting_started/discover_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,6 @@ Click it to access documentation, trainings, release notes, and product roadmap

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

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

Help center is enabled by default, but you can toggle it in [user settings](get_started.md#browsing).
Expand Down
1 change: 0 additions & 1 deletion docs/image_management/edit_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ This way, a responsive image can be cropped to fit the viewport, so the area tha
!!! note

Cropping to focal point is not automatic. The website's templates must be adapted for this to happen.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'd need to make this change to our default templates before it is released, to make this feature work.

I checked and the focal point button is there but it won't have an effect, right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed on Slack - it's available through REST

See [Use focal point]([[= developer_doc =]]/templating/embed_and_list_content/render_images/#use-focal-point) in Developer Documentation for an example of implementing such cropping.

Click the **Show point** button to see a target on the preview.
Drag the target to a point on the image that you want to focus on.
Expand Down
3 changes: 1 addition & 2 deletions docs/product_catalog/create_edit_product.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +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 is available through the API.
See [Products]([[= developer_doc =]]/product_catalog/product_api/#products) for a technical guide on how to do this.
Bulk method is available through the [API]([[= developer_doc =]]/api/api/).

1\. Click **Product catalog** -> **Products**.

Expand Down
2 changes: 1 addition & 1 deletion docs/product_catalog/products.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For more information about creating products, see [Create product](create_edit_p

## Product completeness

Before your customers can purchase products, the website [administrator must configure]([[= developer_doc =]]/product_catalog/enable_purchasing_products/) at least one region and one currency for the shop, and VAT rates for each of the regions.
Before your customers can purchase products, the website administrator must configure at least one region and one currency for the shop, and VAT rates for each of the regions.
You must then set:

- VAT rates for the product type
Expand Down
2 changes: 1 addition & 1 deletion docs/product_catalog/quable_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ month_change: false
# [[= pim_product_name =]] integration

[[= product_name =]] can be connected to [[[= pim_product_name =]]](https://www.quable.com/en) as an external product information management (PIM) system.
After the feature is [configured]([[= developer_doc =]]/product_catalog/quable/install_quable/), [[= pim_product_name =]] becomes the central place for managing product data.
Once configured, [[= pim_product_name =]] becomes the central place for managing product data.
All product information is maintained in [[= pim_product_name =]] and automatically made available in [[= product_name =]].

This allows teams to work with consistent product data in the [[= product_name =]] interface, without duplicating or manually transferring information between systems.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_management/manage_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ As you can see, the interface is the same as when working with regular content i

!!! caution

If you are creating a new user group, remember to [exclude it in product tour configuration]([[= developer_doc =]]/administration/back_office/configure_product_tour#user-group-restrictions) if necessary.
If you are creating a new user group, exclude it from the product tour configuration if necessary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess product tour will be enabled for everybody, unless the setting is added to the UI (as a toggle in user rup editing screeen, not there yet, though).

I would remove this sentence completely (for now).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content about ibexa/integrated-help will be removed for now


![Users section](img/users_section.png)

Expand Down
Loading
Loading