diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index 2c1a1304e5..81d0b0858a 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -14,6 +14,35 @@ config: table-pipe-style: style: leading_and_trailing +# table-column-count: true + blanks-around-tables: true + descriptive-link-text: true +# table-column-style: aligned +# link-fragments: true +# no-alt-text: true + single-trailing-newline: true +# no-emphasis-as-heading: true + no-space-in-code: true + no-space-in-links: true + fenced-code-language: true +# first-line-heading: true +# ol-prefix: one_or_ordered +# list-marker-space: true +# blanks-around-fences: true +# blanks-around-lists: true +# single-title: true +# no-trailing-punctuation: +# punctuation: [".", ":", ";",] +# no-multiple-space-atx: true +# blanks-around-headings: true +# heading-increment: true +# ul-style: dash +# ul-indent: +# indent: 4 +# no-trailing-spaces: true +# no-multiple-blanks: true +# commands-show-output: true + ignores: - "docs/snippets/**" - "docs/index.md" diff --git a/docs/administration/admin_panel/roles_admin_panel.md b/docs/administration/admin_panel/roles_admin_panel.md index cf26343d98..ba27d7ee2e 100644 --- a/docs/administration/admin_panel/roles_admin_panel.md +++ b/docs/administration/admin_panel/roles_admin_panel.md @@ -41,4 +41,4 @@ That way system is be more secure and easier to manage. This approach also improves performance. Role assignments and policies are taken into account during search/load queries. -For more information, see [Permissions overview](permissions.md) and [Permission use cases](permission_use_cases.md). \ No newline at end of file +For more information, see [Permissions overview](permissions.md) and [Permission use cases](permission_use_cases.md). diff --git a/docs/administration/admin_panel/segments_admin_panel.md b/docs/administration/admin_panel/segments_admin_panel.md index a3debe34a8..4b22023e99 100644 --- a/docs/administration/admin_panel/segments_admin_panel.md +++ b/docs/administration/admin_panel/segments_admin_panel.md @@ -16,4 +16,4 @@ Each segment group can contain segments that you can target content for. ![Segment](admin_panel_segment.png) -You can assign users to segments [through the API](segment_api.md#assigning-users). \ No newline at end of file +You can assign users to segments [through the API](segment_api.md#assigning-users). diff --git a/docs/administration/admin_panel/url_management_admin_panel.md b/docs/administration/admin_panel/url_management_admin_panel.md index 1b5fd61b87..132d65d6e3 100644 --- a/docs/administration/admin_panel/url_management_admin_panel.md +++ b/docs/administration/admin_panel/url_management_admin_panel.md @@ -9,4 +9,4 @@ Configure URL aliases to have human-readable URL addresses throughout your syste For more information, see [URL management](url_management.md). -![URL Management](admin_panel_url_management.png "URL Management") \ No newline at end of file +![URL Management](admin_panel_url_management.png "URL Management") diff --git a/docs/administration/admin_panel/workflow_admin_panel.md b/docs/administration/admin_panel/workflow_admin_panel.md index 85bc924ec4..02cb5eb7a6 100644 --- a/docs/administration/admin_panel/workflow_admin_panel.md +++ b/docs/administration/admin_panel/workflow_admin_panel.md @@ -9,4 +9,4 @@ Each workflow consists of stages and transitions between them. For more information, see [Workflow](workflow.md). -![Workflow](admin_panel_workflow.png "Workflow") \ No newline at end of file +![Workflow](admin_panel_workflow.png "Workflow") diff --git a/docs/administration/back_office/content_tree.md b/docs/administration/back_office/content_tree.md index ea4b10b332..f247a0de0a 100644 --- a/docs/administration/back_office/content_tree.md +++ b/docs/administration/back_office/content_tree.md @@ -38,4 +38,4 @@ ibexa: - 2 # Home (Content structure) - 5 # Users - 43 # Media -``` \ No newline at end of file +``` diff --git a/docs/administration/content_organization/object_states.md b/docs/administration/content_organization/object_states.md index 96b304f45e..2c7bfde4d8 100644 --- a/docs/administration/content_organization/object_states.md +++ b/docs/administration/content_organization/object_states.md @@ -20,4 +20,4 @@ By default, [[= product_name =]] contains one object state group: **Lock**, with ![**Lock** Object state](object_state_lock.png "Lock object state") Object states can be used in conjunction with [permissions](permission_overview.md), in particular with the [object state limitation](limitation_reference.md#object-state-limitation). -Their specific use cases depend on your needs and the setup of your permission system. \ No newline at end of file +Their specific use cases depend on your needs and the setup of your permission system. diff --git a/docs/administration/content_organization/sections.md b/docs/administration/content_organization/sections.md index 2a2a369537..9b57b506ae 100644 --- a/docs/administration/content_organization/sections.md +++ b/docs/administration/content_organization/sections.md @@ -39,4 +39,4 @@ If a section is removed, its ID number cannot be reused when a new section is cr Registration form for your website is placed under this address: /register. By default, new users created in this way are placed in the Guest accounts group. -To give your users a possibility to register themselves, follow the instructions on [enabling account registration](8_enable_account_registration.md). \ No newline at end of file +To give your users a possibility to register themselves, follow the instructions on [enabling account registration](8_enable_account_registration.md). diff --git a/docs/api/event_reference/discounts_events.md b/docs/api/event_reference/discounts_events.md index 2d9b6700a4..d7c400b630 100644 --- a/docs/api/event_reference/discounts_events.md +++ b/docs/api/event_reference/discounts_events.md @@ -47,7 +47,7 @@ The following events are dispatched when rendering each step of the discount wiz |[`CreateFormDataEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-Step-CreateFormDataEvent.html)| `ibexa.discounts.form_mapper..create_form_data`| |[`MapCreateDataToStructEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-Step-MapCreateDataToStructEvent.html)|`ibexa.discounts.form_mapper..map_create_data_to_struct`| |[`MapDiscountToFormDataEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-Step-MapDiscountToFormDataEvent.html)| `ibexa.discounts.form_mapper..map_discount_to_form_data`| -|[`MapUpdateDataToStructEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-Step-MapUpdateDataToStructEvent.html)|`ibexa.discounts.form_mapper..map_update_data_to_struct `| +|[`MapUpdateDataToStructEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-Step-MapUpdateDataToStructEvent.html)|`ibexa.discounts.form_mapper..map_update_data_to_struct`| The event classes are shared between steps, but they are dispatched with different names. Each step form mapper dispatches its own set of events. diff --git a/docs/api/event_reference/order_management_events.md b/docs/api/event_reference/order_management_events.md index a1c9e790f1..f68009e320 100644 --- a/docs/api/event_reference/order_management_events.md +++ b/docs/api/event_reference/order_management_events.md @@ -5,6 +5,7 @@ page_type: reference --- # Order management events + | Event | Dispatched by | Properties | |---|---|---| |`BeforeCreateOrderEvent`|`OrderService::createOrder`|`OrderCreateStruct $createStruct`
`?OrderInterface $orderResult = null`| diff --git a/docs/cdp/cdp_activation/cdp_activation.md b/docs/cdp/cdp_activation/cdp_activation.md index c15223bb64..68b957e226 100644 --- a/docs/cdp/cdp_activation/cdp_activation.md +++ b/docs/cdp/cdp_activation/cdp_activation.md @@ -14,4 +14,4 @@ Activation includes configuration, data export and adding Client-side Tracking. "cdp/cdp_activation/cdp_configuration", "cdp/cdp_activation/cdp_data_export", "cdp/cdp_activation/cdp_add_clientside_tracking", -], columns=3) =]] \ No newline at end of file +], columns=3) =]] diff --git a/docs/cdp/cdp_activation/cdp_add_clientside_tracking.md b/docs/cdp/cdp_activation/cdp_add_clientside_tracking.md index b57ccf37c2..2e0bfc9e94 100644 --- a/docs/cdp/cdp_activation/cdp_add_clientside_tracking.md +++ b/docs/cdp/cdp_activation/cdp_add_clientside_tracking.md @@ -32,4 +32,4 @@ Add the user ID information by using below script: raptor.push("setRuid","USER_ID_HERE") ``` -For more information on tracking events, see [the documentation](https://content.raptorservices.com/help-center/tracking-events-for-recommendation). \ No newline at end of file +For more information on tracking events, see [the documentation](https://content.raptorservices.com/help-center/tracking-events-for-recommendation). diff --git a/docs/commerce/checkout/checkout.md b/docs/commerce/checkout/checkout.md index bd19cc8ecd..5759a6c288 100644 --- a/docs/commerce/checkout/checkout.md +++ b/docs/commerce/checkout/checkout.md @@ -56,4 +56,4 @@ Next, the user is moved to cart where the system validates the order against exi If everything is available, customer can move to payment and summary. The system uses information from the past order to pre-fill address, shipping method, and payment details. -For more information, see [reorder documentation](reorder.md). \ No newline at end of file +For more information, see [reorder documentation](reorder.md). diff --git a/docs/commerce/checkout/configure_checkout.md b/docs/commerce/checkout/configure_checkout.md index 4079c6da97..d302f9e55a 100644 --- a/docs/commerce/checkout/configure_checkout.md +++ b/docs/commerce/checkout/configure_checkout.md @@ -58,4 +58,4 @@ They fall back to `billing` and `shipping` predefined formats by default: - `billing` is part of the `ibexa/corporate-accounts` repository - `shipping` is part of the `ibexa/checkout` bundle's default configuration -To modify address formats you create custom ones. \ No newline at end of file +To modify address formats you create custom ones. diff --git a/docs/commerce/storefront/storefront.md b/docs/commerce/storefront/storefront.md index 5eac432f3e..4f7232a0f7 100644 --- a/docs/commerce/storefront/storefront.md +++ b/docs/commerce/storefront/storefront.md @@ -42,4 +42,4 @@ To become familiar with a complete set of templates that covering all functional For more information about overriding the default checkout component, see [Customize checkout](../checkout/customize_checkout.md). - For information about roles and permissions that control access to various components of the purchase process, see [Permission use cases](permission_use_cases.md#commerce). \ No newline at end of file + For information about roles and permissions that control access to various components of the purchase process, see [Permission use cases](permission_use_cases.md#commerce). diff --git a/docs/commerce/transactional_emails/extend_transactional_emails.md b/docs/commerce/transactional_emails/extend_transactional_emails.md index 665ed1cb9a..b231b5e059 100644 --- a/docs/commerce/transactional_emails/extend_transactional_emails.md +++ b/docs/commerce/transactional_emails/extend_transactional_emails.md @@ -164,4 +164,4 @@ final class ResolveCampaginEventSubscriber implements EventSubscriberInterface $event->setCampaign($campaign); } } -``` \ No newline at end of file +``` diff --git a/docs/content_management/field_types/field_type_reference/authorfield.md b/docs/content_management/field_types/field_type_reference/authorfield.md index c26c2dcb11..e967301265 100644 --- a/docs/content_management/field_types/field_type_reference/authorfield.md +++ b/docs/content_management/field_types/field_type_reference/authorfield.md @@ -14,7 +14,7 @@ This field type allows the storage and retrieval of one or more authors. For eac | Attribute | Type | Description | Example | |-----------|------------------------------------------|------------------|-----------| -| `authors` | `\Ibexa\Core\FieldType\Author\Author[] ` | List of authors. | See below | +| `authors` | `\Ibexa\Core\FieldType\Author\Author[]` | List of authors. | See below | Example: diff --git a/docs/content_management/pages/ibexa_connect_scenario_block.md b/docs/content_management/pages/ibexa_connect_scenario_block.md index 999e3c9588..8837d822d7 100644 --- a/docs/content_management/pages/ibexa_connect_scenario_block.md +++ b/docs/content_management/pages/ibexa_connect_scenario_block.md @@ -66,4 +66,4 @@ To do it, extend drop-down list in the **View** field and choose one of the avai Click **Submit** button to confirm. After submitting the block, page refreshes and [[= product_name_connect =]] block displays data from provided [[= product_name_connect =]] webhook. -![Ibexa Connect webhook preview](ibexa_connect_webhook_preview.png) \ No newline at end of file +![Ibexa Connect webhook preview](ibexa_connect_webhook_preview.png) diff --git a/docs/content_management/pages/react_app_block.md b/docs/content_management/pages/react_app_block.md index d3f869a851..ea86b1eb76 100644 --- a/docs/content_management/pages/react_app_block.md +++ b/docs/content_management/pages/react_app_block.md @@ -101,4 +101,4 @@ Then, make sure that your [Page layout template](template_configuration.md#page- {% if encore_entry_exists('react-blocks-js') %} {{ encore_entry_script_tags('react-blocks-js') }} {% endif %} -``` \ No newline at end of file +``` diff --git a/docs/content_management/rich_text/extend_online_editor.md b/docs/content_management/rich_text/extend_online_editor.md index a53063fc87..78ab360eca 100644 --- a/docs/content_management/rich_text/extend_online_editor.md +++ b/docs/content_management/rich_text/extend_online_editor.md @@ -386,7 +386,7 @@ For a full list of standard buttons, see the RichText module's [configuration fi Regular CKEditor plugins can be added to the Online Editor. This procedure is illustrated with the addition of the [Special characters plugin](https://ckeditor.com/docs/ckeditor5/latest/features/special-characters.html). -You can install a CKEditor plugin locally by using `yarn add ` or `npm install`, and deploy it by committing the `yarn.lock` file. +You can install a CKEditor plugin locally by using `yarn add` or `npm install`, and deploy it by committing the `yarn.lock` file. A local installation looks like: ```bash diff --git a/docs/content_management/rich_text/rich_text.md b/docs/content_management/rich_text/rich_text.md index fe5e1d4ce0..5921b7017f 100644 --- a/docs/content_management/rich_text/rich_text.md +++ b/docs/content_management/rich_text/rich_text.md @@ -11,4 +11,4 @@ RichText is a type of field that you add in any content item in [[= product_name "content_management/rich_text/online_editor_guide", "content_management/rich_text/extend_online_editor", "content_management/rich_text/create_custom_richtext_block", -], columns=3) =]] \ No newline at end of file +], columns=3) =]] diff --git a/docs/content_management/workflow/workflow.md b/docs/content_management/workflow/workflow.md index 2086789661..7503d09e53 100644 --- a/docs/content_management/workflow/workflow.md +++ b/docs/content_management/workflow/workflow.md @@ -165,7 +165,7 @@ However, during the publish action, the sent form is validated in the service. Therefore, if there are any errors in the form, you return to the edit page but errors aren't triggered, which can be confusing when you have two or more tabs. To enable form validation in UI before sending it to the next stage of the workflow, add `validate: true` to the transitions of the stage. -In the example below the form is validated in two stages:` to_legal` and `done`: +In the example below the form is validated in two stages: `to_legal` and `done`: ``` yaml hl_lines="15 28" [[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 43) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 55, 63) =]] diff --git a/docs/customer_management/cp_configuration.md b/docs/customer_management/cp_configuration.md index 1c9d52d532..97e2112e25 100644 --- a/docs/customer_management/cp_configuration.md +++ b/docs/customer_management/cp_configuration.md @@ -88,4 +88,4 @@ ibexa: Reviewing pending and past orders in Customer Portal requires that you configure all currencies that any of the customers may use under the `ibexa.system..product_catalog.currencies` key. The first currency from the list is then used for filtering the orders list and calculating the **Average order** and **Total amount** values. -For more information, see [Enable purchasing products](enable_purchasing_products.md). \ No newline at end of file +For more information, see [Enable purchasing products](enable_purchasing_products.md). diff --git a/docs/customer_management/customer_portal.md b/docs/customer_management/customer_portal.md index 555e487b1d..659c4fec75 100644 --- a/docs/customer_management/customer_portal.md +++ b/docs/customer_management/customer_portal.md @@ -19,4 +19,4 @@ With this feature, your customers can self-register, edit their organization inf "users/invitations", "customer_management/cp_page_builder", "customer_management/create_user_registration_form", -], columns=3) =]] \ No newline at end of file +], columns=3) =]] diff --git a/docs/ibexa_engage/create_campaign.md b/docs/ibexa_engage/create_campaign.md index 5cf16b067c..dd789be337 100644 --- a/docs/ibexa_engage/create_campaign.md +++ b/docs/ibexa_engage/create_campaign.md @@ -46,4 +46,4 @@ To do it, select units, and provide width and height values in the proper fields If size fields are blank, the system sets default template values. It's recommended to adjust them for better results. -![Campaign custom tag](campaign_custom_tag.png "Campaign custom tag") \ No newline at end of file +![Campaign custom tag](campaign_custom_tag.png "Campaign custom tag") diff --git a/docs/ibexa_products/ibexa_experience.md b/docs/ibexa_products/ibexa_experience.md index 0283662209..58534551d2 100644 --- a/docs/ibexa_products/ibexa_experience.md +++ b/docs/ibexa_products/ibexa_experience.md @@ -64,7 +64,7 @@ Additionally, you can monitor and manage the information obtained from website v #### Site Factory -[Site Factory ](site_factory.md) is a site management interface, integrated with the back office. +[Site Factory](site_factory.md) is a site management interface, integrated with the back office. It enables you to configure new sites without leaving the administration interface and editing SiteAccess configuration. With this feature you can create and deploy multiple websites at lightning speed and at scale. It allows you to manage expenses and resources while industrializing your web presence. diff --git a/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md b/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md index 8a743eb240..0a9d7ad23f 100644 --- a/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md +++ b/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md @@ -149,7 +149,7 @@ If the Varnish server is protected by Basic Auth, specify the Basic Auth credent Varnish is enabled by default when using [[= product_name_cloud =]] and the `purge_servers` setting is set automatically. To enable Basic Auth on [[= product_name_cloud =]] when using Varnish, specify the credentials using the following environment variables to make sure that Varnish is reachable: -``` +``` bash env:HTTPCACHE_USERNAME=myuser env:HTTPCACHE_PASSWORD=mypasswd ``` diff --git a/docs/personalization/tracking_with_ibexa-tracker.md b/docs/personalization/tracking_with_ibexa-tracker.md index 8357133ab7..e59959da8d 100644 --- a/docs/personalization/tracking_with_ibexa-tracker.md +++ b/docs/personalization/tracking_with_ibexa-tracker.md @@ -26,7 +26,7 @@ To use this mechanism on your pages, copy the code snippet below, and replace: - `` with an empty string for cookie based anonymous user or with the value generated by your user identifier system for logged-in user. In case user activity should not be tracked, 'not_defined' value should be used to still have an event stored without a link to the user. All identifiers can be any form of string. -Paste this snippet into your website template page so that it appears before the closing `` tag. +Paste this snippet into your website template page so that it appears before the closing `` tag. ``` js