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
12 changes: 12 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,15 @@ jobs:
with:
reporter: github-check
filter_mode: added

markdownlint:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'

steps:
- uses: actions/checkout@v4

- name: Run markdownlint
uses: DavidAnson/markdownlint-cli2-action@v20
with:
globs: "docs/**/*.md"
47 changes: 47 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
config:
default: false
heading-style: consistent
list-indent: true
no-reversed-links: true
no-missing-space-atx: true
heading-start-left: true
no-multiple-space-blockquote: true
no-blanks-blockquote: true
hr-style: true
no-empty-links: true
code-fence-style: backtick
strong-style: asterisk
table-pipe-style:
style: leading_and_trailing

no-alt-text: true
first-line-heading: true
list-marker-space: true
blanks-around-fences: true
single-title: true
no-multiple-space-atx: true
blanks-around-headings: true
ul-style: dash
ol-prefix:
style: one_or_ordered
ul-indent:
indent: 4
heading-increment: true
blanks-around-tables: true
descriptive-link-text: true
single-trailing-newline: true
no-space-in-code: true
no-space-in-links: true
fenced-code-language: true
no-multiple-blanks: true
commands-show-output: true
no-trailing-spaces: true
blanks-around-lists: true
no-trailing-punctuation:
punctuation: [".", ":", ";",]
no-emphasis-as-heading: true
table-column-count: true

ignores:
- "docs/snippets/**"
- "docs/index.md"
6 changes: 3 additions & 3 deletions docs/ai_actions/work_with_ai_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@

### Create AI actions that control taxonomy suggestions

If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.
If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.

Check notice on line 112 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L112

[Ibexa.SentenceLength] Keep your sentences to less than 30 words.
Raw output
{"message": "[Ibexa.SentenceLength] Keep your sentences to less than 30 words.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 112, "column": 1}}}, "severity": "INFO"}

Check warning on line 112 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L112

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 112, "column": 111}}}, "severity": "WARNING"}

Check notice on line 112 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L112

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 112, "column": 120}}}, "severity": "INFO"}

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

Expand All @@ -120,7 +120,7 @@
- **Language** - sets the base language for the AI action
- **Action type** - sets an action type to serve as a template for the AI action, for example, **Suggest taxonomy**
- **Action handler** - sets the AI model used to process the requests resulting from this AI action.
Pick `taxonomy-text-to-taxonomy`
Pick `taxonomy-text-to-taxonomy`

1. Make settings in the **Global properties** section, as described above.

Expand Down Expand Up @@ -174,7 +174,7 @@

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 =]].
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 =]].

Check notice on line 177 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L177

[Ibexa.SentenceLength] Keep your sentences to less than 30 words.
Raw output
{"message": "[Ibexa.SentenceLength] Keep your sentences to less than 30 words.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 177, "column": 1}}}, "severity": "INFO"}

## Duplicate AI actions

Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Once the order is placed, users can interact with it by working with the followi
"commerce/payment/payment_management",
"commerce/shipping_management/shipping_management",
"commerce/discounts/discounts"
], columns=3) =]]
], columns=3) =]]
4 changes: 2 additions & 2 deletions docs/commerce/discounts/discounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Depending on the permissions assigned to your [user role](permissions_and_users.

For example, you can create time-limited offers on selected products, ones that apply only to specified regions, currencies, products or customers, or reward your newsletter subscribers with special discount codes.

### Interaction with other modules
## Interaction with other modules

The **Discounts** module interacts with other parts of the system, so that store customers can:

- in the product catalog, see base prices of products together with prices reduced according to active catalog discounts
- in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met
- in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met
- at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts

For more information about discounts, see [Work with discounts](work_with_discounts.md).
13 changes: 6 additions & 7 deletions docs/commerce/discounts/work_with_discounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
To view the details of a discount, click its line in the discount list.
On the discount details screen, you can see an overview of the discount's details.

Discount details include basic information about the discount:
Discount details include basic information about the discount:

- validity period and value of the discount
- region and currency that the discount applies to
Expand Down Expand Up @@ -102,23 +102,22 @@

1. If your store supports multiple markets, you can select a region that the discount applies to.
1. If you are creating a fixed-amount discount, select a currency of the discount.

![Creating a new discount](create_new_discount.png)

1. In the **Promotion information** area, provide a name and description of the promotional campaign, as they should be shown to customers.

![Adding information about the promotion](discounts_promo_info.png)

1. Click **Next** to go to the next screen.



4. In the **Target group** screen, select customers that the new discount is targeted at.
You can choose everyone, or select one or more customer groups.

![Customer selection](discounts_select_customers.png)

5. In the **Products** screen, select products that the discount applies to. You can choose between:

- all products from the catalog, for example, to clear stock before the end of year
- products from a specific category, for example, promotional gadgets for company partners
- specific products or even product variants, to activate slow-moving inventory
Expand All @@ -134,14 +133,14 @@
- entered a specified discount code

If you set the discount code, you can set the number of times that the code can be used:

- by a certain customer
- in total, by all customers

![Cart discount conditions](cart_discount_conditions.png)

7. In the **Discount value** screen, if you are creating a percentage-based discount, in **Customer gets discount value**, enter a percent value that the system uses to calculate the amount deducted from the base price of the product.
Otherwise, enter a monetary value to be deducted from the base price.
Otherwise, enter a monetary value to be deducted from the base price.

Check notice on line 143 in docs/commerce/discounts/work_with_discounts.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/commerce/discounts/work_with_discounts.md#L143

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/commerce/discounts/work_with_discounts.md", "range": {"start": {"line": 143, "column": 38}}}, "severity": "INFO"}

8. In the **Summary** screen, review the details of the discount that you are creating, and click **Save and close** to save the discount.
Depending on the settings, you may see a warning message.
Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/payment/work_with_payment_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ Payment methods describe the way store customers pay for their orders during the
- Method type - method of the payment
- Availability - payment method availability: Active, Inactive

3. Click **Apply** to confirm.
3. Click **Apply** to confirm.
2 changes: 1 addition & 1 deletion docs/commerce/shipping_management/shipping_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The **Shipping management** module interacts with other packages of the system,
[[= cards([
"commerce/shipping_management/work_with_shipping_methods",
"commerce/shipping_management/work_with_shipments"
], columns=2) =]]
], columns=2) =]]
2 changes: 1 addition & 1 deletion docs/commerce/shipping_management/work_with_shipments.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ If your [user role](work_with_permissions.md) has the `Shipment/Edit` permission

- "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm.
- "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm.
- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm.
- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm.
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ This value is then displayed during checkout and added to the total order amount
- Availability - shipping method availability: Active, Inactive
- Region - region that the shipping method applies to

3. Click **Apply** to confirm.
3. Click **Apply** to confirm.
6 changes: 3 additions & 3 deletions docs/content_management/configure_ct_field_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ All sections are later presented as headers on the content item details screen,
Depending on their type, fields can have different combinations of the following general settings.

|Setting|Description|Use|
--------|-----------|---|
|-------|-----------|---|
|Name|A user-friendly name that describes the field, used in the interface. It can be up to 255 characters long and consist of letters, digits, spaces, and special characters.|Required|
|Identifier|An identifier for system use in configuration files, templates, or PHP code. It can be up to 50 characters long and can only contain lowercase letters, digits and underscores. Also used in name patterns for the content type.|Required|
|Description|A detailed description of the field. It's displayed next to it when the user edits the content item.|Optional|
Expand Down Expand Up @@ -102,7 +102,7 @@ When you add or modify a **[Content relation](create_edit_content_items.md#relat
- which content tree location opens in the [content browser](discover_ui.md#content-browser) when the user browses to a related content item
- whether relations can be to content items of a specific type only, or any content type

#### Relation starting location
### Relation starting location

In the **Select starting Location** area, select from the available options:

Expand All @@ -113,7 +113,7 @@ In the **Select starting Location** area, select from the available options:

![Select starting location](img/select_start_location.png "Selecting a starting location")

#### Allowed content types
### Allowed content types

In the **Allowed content types** area, expand the drop-down list and select from the available content types.
No selection means that relations to all content types are allowed.
2 changes: 1 addition & 1 deletion docs/content_management/content_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ It also involves content translation and publication scheduling.
"content_management/content_organization/copy_move_hide_content",
"content_management/content_organization/classify_content",
"content_management/content_organization/manage_locations_urls"
], columns=3) =]]
], columns=3) =]]
2 changes: 1 addition & 1 deletion docs/content_management/content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ By default, the system comes with a large set of field types that cover the most

!!! note "More information"

For detailed information about the content model, see [Developer Documentation]([[= developer_doc =]]/content_management/content_model/#content-information).
For detailed information about the content model, see [Developer Documentation]([[= developer_doc =]]/content_management/content_model/#content-information).
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ You can create and configure segments and segment groups in the **Admin** sectio
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-->
<!--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 @@ -93,4 +93,4 @@ This is different from [hiding locations](manage_locations_urls.md#hide-location
and set a different section or object state for the given content.
Or use other permission-based [**Limitations**](work_with_permissions.md).

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/NQXMhcHiPL1dVRT9Eg3u?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Copy, move or hide content" 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-->
<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/NQXMhcHiPL1dVRT9Eg3u?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Copy, move or hide content" 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-->
4 changes: 2 additions & 2 deletions docs/content_management/create_edit_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ month_change: true
To help you preserve your work, [[= product_name =]] saves drafts of content items automatically.
For more information, see [Autosave](content_versions.md#autosave).

##### Upload multiple content items
### Upload multiple content items

When you view the content item details in the content tree, you can upload files such as images, videos, or PDF documents.
This way you can add multiple sub-items without editing the original content item.
Expand Down Expand Up @@ -272,7 +272,7 @@ For this feature to work as described, the content type must have a **Metadata**

![Selecting Taxonomy entries](img/taxonomy_select_taxonomy_entries.png "Selecting Taxonomy entries")

!!! note "Taxonomy suggestions"
!!! note "Taxonomy suggestions"

If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, instead of manually browsing the taxonomy tree and selecting tags one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/create_edit_content_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ For example, when you add or remove a field to the content type, the change is p
Each content type has the following global properties:

|Setting|Description|Use|
--------|-----------|---|
|-------|-----------|---|
|Name|A name of the content type.|Required|
|Identifier|A unique identifier of the content type in the system. Up to 50 characters and can only consist of letters, numbers and underscores.|Required|
|Description|Additional information that is displayed when a content item is created based on this type.|Optional|
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 @@ -270,4 +270,4 @@ There are several options for saving work on the page:
|Save draft|Save the page draft*.|
|Delete draft|Delete the page draft.|

* To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](content_versions.md#autosave).
- To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](content_versions.md#autosave).
2 changes: 1 addition & 1 deletion docs/content_management/preview_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Additionally, if you select a specific SiteAccess from the **Site context** drop
- if you [disable the Focus mode](../getting_started/discover_ui.md#disable-focus-mode) or click **Exit full view**, the **View** tab appears in the content item's details view, where you can quickly preview the content item

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/5Y1i3W29Jsg6J0za71GL?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Preview an article,
switch between sites and views" 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-->
switch between sites and views" 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-->
2 changes: 1 addition & 1 deletion docs/content_management/publish_instantly.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ All these options are available in the menu when you're in the edit mode.

![Publishing options](img/publishing_options.png "Publishing options")

### Publishing vs. saving
## Publishing vs. saving

Clicking **Save** doesn't immediately publish the content item.
Instead, it saves the [new version](content_versions.md) of the content as a draft.
Expand Down
5 changes: 2 additions & 3 deletions docs/content_management/schedule_publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@
Actions available in the toolbar may vary depending on the custom configuration.
For details, contact your page administrator.


To select, click on all events of the same type you want to add to the toolbar list.

![Calendar widget toolbar](img/selection_action_bar.png "Calendar widget toolbar")
Expand All @@ -136,7 +135,7 @@
|![Reschedule button](img/selection_action_bar_reschedule.png)|Reschedule all selected events.|
|![Discard button](img/selection_action_bar_discard.png)|Cancel the future publication of selected events.|

#### Reschedule or cancel in the dashboard
### Reschedule or cancel in the dashboard

Check notice on line 138 in docs/content_management/schedule_publishing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/schedule_publishing.md#L138

[Ibexa.ArticlesInHeadings] Avoid articles in headings.
Raw output
{"message": "[Ibexa.ArticlesInHeadings] Avoid articles in headings.", "location": {"path": "docs/content_management/schedule_publishing.md", "range": {"start": {"line": 138, "column": 29}}}, "severity": "INFO"}

To reschedule or cancel events with the dashboard, perform the following actions:

Expand All @@ -151,7 +150,7 @@

![Reschedule or cancel with the dashboard](img/reschedule_cancel_dashboard.png "Rescheduling or cancelling with the dashboard")

#### Reschedule or cancel in Calendar
### Reschedule or cancel in Calendar

In the [Calendar widget](#calendar-widget), select all events to have their publication time rescheduled or cancelled.
Using the toolbar buttons, perform one of the following actions:
Expand Down
Loading
Loading