Skip to content

Commit

Permalink
Content fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
julitafalcondusza committed Sep 25, 2024
1 parent c1b6283 commit 818fc12
Show file tree
Hide file tree
Showing 52 changed files with 204 additions and 206 deletions.
2 changes: 1 addition & 1 deletion docs/commerce/commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The following diagram includes statuses and actions that may occur on the order'

![Order processing workflow](img/commerce_workflow.png "Order processing workflow")

From the end-user perspective, once it is properly configured to grant the right permissions to [user roles](../permission_management/permissions_and_users.md), the Commerce solution gives store managers control over the whole order fulfilment process, while allowing customers to monitor the progress of their transactions.
From the end-user perspective, once it's properly configured to grant the right permissions to [user roles](../permission_management/permissions_and_users.md), the Commerce solution gives store managers control over the whole order fulfilment process, while allowing customers to monitor the progress of their transactions.

Once the order is placed, users can interact with it by working with the following back office pages:

Expand Down
4 changes: 2 additions & 2 deletions docs/commerce/order_management/order_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ edition: commerce

# Order management

The Order management module allows users to review order details, track order completion status, and cancel orders that are created when store customers purchase products.
The **Order management** module allows users to review order details, track order completion status, and cancel orders that are created when store customers purchase products.

Depending on the permissions assigned to your [user role](permissions_and_users.md), you might be able to track and manage orders placed by all the store customers, or only your own ones.

With the back office **Orders** screen, you can search for orders and filter search results.

![Orders list](order_list.png "Orders list")

The Order management package interacts with other packages of the system, so that:
The **Order management** package interacts with other packages of the system, so that:

- when store customers pass the checkout stage, stock is decreased and payment and shipment workflows are initiated
- when store customers cancel their orders, the decreased stock is restored and payment and shipment are cancelled
Expand Down
11 changes: 5 additions & 6 deletions docs/commerce/order_management/work_with_orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition: commerce
# Work with orders

In [[= product_name =]], you can view a list of orders and modify their statuses on the **Orders** screen.
By default, depending on your permissions, you can access your own orders or all the orders that exist in the system.
By default, depending on your permissions, you can access your own orders, or all the orders that exist in the system.

## Filter orders in order list

Expand Down Expand Up @@ -35,15 +35,15 @@ Available filters are:

To view the details of an order, click its line in the order list.

On the order details screen, you can view more information about the order, such as customer, payment and shipment details.
On the order details screen, you can view more information about the order, such as customer, payment, and shipment details.

![Order detail view](order_detail_view.png)

In the **Items** tab you can see a list of products included in the order.

![Viewing products included in the order](order_detail_items.png)

Where fields have the following meaning:
The fields have the following meaning:

- **Subtotal (net)** - a sum of all product prices without taxes
- **Shipping cost** - a net cost of the selected shipping method
Expand All @@ -54,15 +54,14 @@ Where fields have the following meaning:

If the order includes only virtual products then the Shipment and Shipping address sections are not available.
Virtual products don't require shipment when they are the only product in a purchase.


## Change order status

If your [user role](work_with_permissions.md) includes the `Order/Update` permission, you can change the status of an existing order:
confirm it if the order has "Pending" status, or complete it when it is in "Processing" status.
confirm it if the order has "Pending" status, or complete it when it's in "Processing" status.
With the `Order/Cancel` permission, you can cancel an existing order.

!!! note "Canceling orders"

When an order is created, stocks are reduced for the products on that order.
When you create an order, stocks are reduced for the products on that order.
When you cancel an order, the stocks are reverted back to their original values.
4 changes: 2 additions & 2 deletions docs/commerce/payment/payment_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition: commerce

# Payment management

The Payment management module allows users to track the status of payments for orders placed by store customers.
The **Payment management** module allows users to track the status of payments for orders placed by store customers.

On the back office **Payments** screen, you can search for payments, filter the search results, and review payment details.
Depending on configuration and permissions, you may also be allowed to cancel payments.
Expand All @@ -14,7 +14,7 @@ If the permissions assigned to your [user role](permissions_and_users.md) allow,

![Payments list](payment_list.png "Payments list")

The Payment management module interacts with other packages of the system, so that payment processing is cancelled automatically when you cancel your order.
The **Payment management** module interacts with other packages of the system, so that payment processing is cancelled automatically when you cancel your order.

[[= cards([
"commerce/payment/work_with_payments",
Expand Down
10 changes: 5 additions & 5 deletions docs/commerce/payment/work_with_payment_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ edition: commerce

# Work with payment methods

If your [user role](work_with_permissions.md) includes the `Payment method/Create` permission, you can create payment methods.
If your [user role](work_with_permissions.md) has the `Payment method/Create` permission, you can create payment methods.
With the `Payment method/Edit` permission, you can modify existing ones.

Payment methods describe the way store customers pay for their orders during the checkout process.

!!! note "Payment method limitations"

By default, you can only create payment methods of type "Offline".
By default, you can only create payment methods of `Offline` type.
If your organization needs other payment method types, contact your administrator or development team about [creating a custom payment method type]([[= developer_doc =]]/commerce/payment/extend_payment/#define-custom-payment-method-type).

Payment methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch.

## Create new payment method
## Create new payment method

1\. In the left panel, go to **Commerce** -> **Payment methods**, and click **Create**.

Expand Down Expand Up @@ -57,7 +57,7 @@ Payment methods describe the way store customers pay for their orders during the

!!! note "Payment methods for existing orders"

You cannot delete a payment method if it is active or if it is used by unpaid orders.
You cannot delete a payment method if it's active or if it's used by unpaid orders.
You must first deactivate the method that you want to delete by toggling the **Availability** switch off.

## Filter payment methods
Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/payment/work_with_payments.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition: commerce
# Work with payments

In [[= product_name =]], you can view a list of payments and modify their statuses on the **Payments** screen.
By default, depending on your permissions, you can access payments for your own orders or all the payments that exist in the system.
By default, depending on your permissions, you can access payments for your own orders, or all the payments that exist in the system.

## Filter payments in payment list

Expand Down
7 changes: 3 additions & 4 deletions docs/commerce/shipping_management/shipping_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@ edition: commerce

# Shipping management

Shipping processes are present in almost every e-commerce business.
Shipping processes are present in almost every e-commerce business.
[[= product_name =]] comes with a number of storefront and backend features to help users manage shipping.

No two businesses are identical, and [[= product_name_base =]] ensures the flexibility that you need to configure shipping methods in a way that is optimal for your business and store customers.

If the permissions assigned to your [user role](permissions_and_users.md) allow, the Shipping management module enables you to define and manage shipping methods of different types on the **Shipping methods** screen.
If the permissions assigned to your [user role](permissions_and_users.md) allow, the **Shipping management** module enables you to define and manage shipping methods of different types on the **Shipping methods** screen.

![Shipping methods list](shipping_methods_list.png "Shipping methods list")

The Shipping management module interacts with other packages of the system,
so that shipment processing is cancelled automatically when the customer cancels their order.
The **Shipping management** module interacts with other packages of the system, so that shipment processing is cancelled automatically when the customer cancels their order.

[[= cards([
"commerce/shipping_management/work_with_shipping_methods",
Expand Down
10 changes: 5 additions & 5 deletions docs/commerce/shipping_management/work_with_shipments.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,22 @@ Available filters are:

To filter the list, set one of the filters and click `Apply` button.

You can also clear all chosen filters - to do it, click `Clear filters`.
You can also clear all chosen filters - to do it, click `Clear filters`.

## View shipment details

To view the details of a shipment, click its line in the shipment list.

On the shipment details screen, you can see an overview of the shipment's details.
On the shipment details screen, you can see an overview of the shipment's details.

Shipment details include basic information about the shipment, customer details, shipping address, total value, order ID and the date of the last update.
Shipment details include basic information about the shipment, customer details, shipping address, total value, order ID, and the date of the last update.

![Shipment detail view](shipment_detail_view.png)

## Change shipment status

If your [user role](work_with_permissions.md) has the `Shipment/Edit` permission, you can change the status of an existing shipment:

- "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm.
- "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm.
- "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.
16 changes: 8 additions & 8 deletions docs/commerce/shipping_management/work_with_shipping_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,33 @@ edition: commerce

# Work with shipping methods

If your [user role](work_with_permissions.md) includes the `Shipping method/Create` permission, you can create shipping methods.
If your [user role](work_with_permissions.md) includes the `Shipping method/Create` permission, you can create shipping methods.
With the `Shipping method/Edit` permission, you can modify existing ones.

Shipping methods describe how goods can be shipped to a store customer, with different rates for different geographic locations.
Example shipping methods are overnight delivery, self-pickup, DHL and so on.
Shipping methods describe how goods can be shipped to a store customer, with different rates for different geographic locations.
Example shipping methods are overnight delivery, self-pickup, or DHL.

!!! note "Shipping method limitations"

By default, you can only create shipping methods of 'Flat rate' and 'Free shipping' type.
By default, you can only create shipping methods of 'Flat rate' and 'Free shipping' type.

Shipping methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch.

"Flat rate" shipping means delivering goods at a fixed, predefined cost, regardless of the number and type of items in the cart.
"Flat rate" shipping means delivering goods at a fixed, predefined cost, regardless of the number, and type of items in the cart.

## Create new shipping method

1\. In the left panel, go to **Commerce** -> **Shipping methods**, and click **Create**.

2\. Select the language for the new shipping method, its type, and region it will apply to.
2\. Select the language for the new shipping method, its type, and region that you want it applies to.

3\. In the next screen provide information about the new shipping method.

![Creating a new shipping method](create_new_shipping_method.png)

Details about shipping cost differ between shipping methods:

- Flat rate requires setting a specific fixed cost for shipping, expressed as net value in a given currency.
- Flat rate requires setting a specific fixed cost for shipping, expressed as net value in a given currency.
This value is then displayed during checkout and added to the total order amount when the store customer selects a specific shipping method.
- Free shipping requires setting the minimum order value (in a given currency) above which the shipping is free.

Expand Down Expand Up @@ -65,7 +65,7 @@ This value is then displayed during checkout and added to the total order amount

!!! note "Shipping methods for existing orders"

You cannot delete a shipping method if it is active or if it is used by open orders.
You cannot delete a shipping method if it's active or if it's used by open orders.
You must first deactivate the method that you want to delete by toggling the **Availability** switch off.

## Filter shipping methods
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ On the **Properties** tab, set values in the following fields:
- **Folder** — Click **Select content**, browse the content, and select a folder containing images to display.

After submitting the settings, all images in the folder are shown in the Gallery block.
Selecting a folder containing content items other than images results in displaying only a link to the folder where they are stored.
Selecting a folder containing content items other than images results in displaying only a link to the folder where they're stored.

## [[= product_name_connect =]] block

Expand Down
12 changes: 6 additions & 6 deletions docs/content_management/configure_ct_field_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ You can only create or modify content types when your [user role](../permission_

3\. If your application requires a more granular organization of fields within a content type, click **+ Add** to add more sections.

When you add a **Metadata** section, it is later presented as an additional tab in [content item](content_items.md) editing screen.
You can use it for tags, product categories, and so on.
When you add other sections, they are later presented as anchors in content item editing screen.
When you add a **Metadata** section, it's later presented as an additional tab in [content item](content_items.md) editing screen.
You can use it for example for tags or product categories.
When you add other sections, they're later presented as anchors in content item editing screen.
All sections are later presented as headers on the content item details screen, the **View** tab.

4\. Add, reorder or remove fields as required:
Expand All @@ -38,8 +38,8 @@ All sections are later presented as headers on the content item details screen,

7\. To discard your changes and close the window:

- If you are creating a new content type, click **Discard**.
- If you are updating an existing content type, click **Delete draft**.
- If you're creating a new content type, click **Discard**.
- If you're updating an existing content type, click **Delete draft**.

## General settings

Expand All @@ -49,7 +49,7 @@ Depending on their type, fields can have different combinations of the following
--------|-----------|---|
|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|

Check warning on line 50 in docs/content_management/configure_ct_field_settings.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/configure_ct_field_settings.md#L50

[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/content_management/configure_ct_field_settings.md", "range": {"start": {"line": 50, "column": 76}}}, "severity": "WARNING"}
|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 is displayed next to it when the user edits the content item.|Optional|
|Description|A detailed description of the field. It's displayed next to it when the user edits the content item.|Optional|
|Required|Indicates whether a value of the field is required for the content item to be saved or published.|Optional|
|Searchable|Indicates whether a value of the field is included in the search.|Optional|
|Translatable|Indicates whether a value of the field can be translated.|Optional|
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Content items are containers that Ibexa DXP uses to store content d
A content item is a single piece of content: an article, a blog post, an image, or a product.
Each content item has general characteristics, such as name and identifier.
It also contains [fields](content_model.md#fields-and-field-types).
These fields can differ depending on what kind of content you are dealing with.
These fields can differ depending on what kind of content you're dealing with.
An *article* content item may consist of fields such as *title*, *name*, *author*, *body*, *image*, *subscriber teaser*, etc.
A *product* content item may have *product name*, *category*, *price*, *size*, *color*, etc. as fields.

Expand Down
16 changes: 8 additions & 8 deletions docs/content_management/content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ but also all media (images, videos, etc.) and user accounts.
[[= 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 is possible that the content model for your installation has already been created by your administrator or content manager.
However, even a non-technical user can easily create or modify the content model through the editing interface.
it's possible that the content model for your installation has already been created by your administrator or content manager.
However, even a non-technical user can create or modify the content model through the editing interface.

## Content types

Expand All @@ -31,14 +31,14 @@ A [content item](content_items.md) is an instance of a particular content type,

When a content item is created, it inherits the fields from its content type.
However, the values of the fields (their "contents") are empty, and you need to fill them separately for each content item.
The fields in a content type are only definitions. This means that they describe what fields of what kinds will be present in a content item, but as a rule they do not provide these fields' values.
The fields in a content type are only definitions. This means that they describe what fields of what kinds are present in a content item, but as a rule they do not provide these fields' values.

As a consequence, all content items of the same content type will share the same set of fields, but their field values will be different.
As a consequence, all content items of the same content type share the same set of fields, but their field values are different.

For example, you need to store book information.
You create a new content type called "Book" and add to it fields such as Title, Author, Genre, ISBN, etc.
Next, based on this content type, you can create any number of content items.
The empty fields will be ready to be filled in with the information about each specific book:
You can fill the empty fields with the information about each specific book:

![Content model diagram](img/content_model_diagram.png "Content model diagram")

Expand All @@ -52,9 +52,9 @@ for example, *Text line*, *Rich text*, *Email*, *Author list*, *Content relation

## Content model in summary

**content types:**
**Content types:**

- A content type defines fields that a content item will be composed of.
- A content type defines fields that a content item is composed of.
- Every field is modeled after a field type which defines the kind of data it contains.

**Content items:**
Expand All @@ -65,7 +65,7 @@ for example, *Text line*, *Rich text*, *Email*, *Author list*, *Content relation
**Fields and field types:**

- [[= product_name =]] comes with a collection of essential field types.
- It is possible to extend the system by creating custom field types for special needs.
- It's possible to extend the system by creating custom field types for special needs.

!!! note "More information"

Expand Down
Loading

0 comments on commit 818fc12

Please sign in to comment.