Skip to content

Commit 2b18e53

Browse files
IBX-8916: Content update in User documentation - cd. (#314)
* Fixes after review * Capitalization fixes * Capitalization fixes * Capitalization fixes * Content fixes * Capitalization & vale fixes * Fixes - toolbox, elements * New batch of fixes * Screenshot added * Fixes after review * Fixes * Fixes after review * Fixes * Fixes * Fixes * Fixes * fixes
1 parent c4e2b21 commit 2b18e53

File tree

102 files changed

+1104
-1382
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+1104
-1382
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ibexa DXP User Documentation
22

3-
This repository is the source for the [user documentation for Ibexa DXP](https://doc.ezplatform.com/projects/userguide/en/latest),
3+
This repository is the source for [User Documentation for Ibexa DXP](https://doc.ibexa.co/projects/userguide/en/latest/),
44
a digital experience platform that is based on the Symfony Full Stack Framework in PHP.
55

66
# Resources
@@ -9,7 +9,7 @@ a digital experience platform that is based on the Symfony Full Stack Framework
99
1. Ibexa DXP Repository: https://github.com/ibexa/oss
1010
1. Open JIRA board: https://issues.ibexa.co
1111
1. Ibexa Website: https://ibexa.co
12-
1. User documentation: https://doc.ibexa.co/projects/userguide
12+
1. User Documentation: https://doc.ibexa.co/projects/userguide
1313

1414
## How to contribute
1515

@@ -20,7 +20,7 @@ If you'd like to see Ibexa DXP in your language, you can [contribute to the tran
2020
## Build and preview documentation
2121

2222
To build and preview your changes locally, you need to install Python along with its package manager (`pip`).
23-
Other required tools will be installed by using the following command:
23+
To install other required tools, use the following command:
2424

2525
```bash
2626
pip install -r requirements.txt
@@ -33,7 +33,7 @@ mkdocs serve
3333
```
3434

3535
After a short while your documentation should be reachable at http://localhost:8000.
36-
If it isn't, check the output of the command.
36+
If it's not, check the output of the command.
3737

3838
## Where to View
3939

docs/commerce/commerce.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ edition: commerce
99
You can use them to create a unified and streamlined e-commerce platform.
1010
Modules interact with each other, for example, to decrease stock following a sale, or cancel shipments and payments when orders are cancelled.
1111

12-
The solution complements functionalities provided by the [PIM](products.md) offering, and allows you to sell products through the website.
12+
The solution complements functionalities provided by the [PIM](products.md) offering, and allows you to sell products through the website.
1313
With Commerce, you can build your own storefront from a set of generic components, which you can then customize to cover all aspects of the e-commerce experience.
1414

15-
Out of the box, Commerce is configured to follow a specific workflow and support a certain number of processing method types, for example, flat rate and free shipping methods, as well as offline payment methods.
16-
Contact your administrator or development team about customization options.
17-
For more information, see [developer documentation]([[= developer_doc =]]/commerce/commerce/).
15+
Out of the box, Commerce is configured to follow a specific workflow and support a certain number of processing method types, for example, flat rate, free shipping methods, and offline payment methods.
16+
Contact your administrator or development team about customization options.
17+
For more information, see [Developer Documentation]([[= developer_doc =]]/commerce/commerce/).
1818

1919
The following diagram includes statuses and actions that may occur on the order's way along the fulfilment path.
2020

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

23-
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.
23+
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.
2424

25-
Once the order is placed, users can interact with it by working with the following Back Office pages:
25+
Once the order is placed, users can interact with it by working with the following back office pages:
2626

2727
[[= cards([
2828
"commerce/order_management/order_management",

docs/commerce/order_management/order_management.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ edition: commerce
55

66
# Order management
77

8-
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.
8+
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.
99

10-
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 just your own ones.
10+
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.
1111

12-
With the Back Office **Orders** screen, you can search for orders and filter search results.
12+
With the back office **Orders** screen, you can search for orders and filter search results.
1313

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

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

1818
- when store customers pass the checkout stage, stock is decreased and payment and shipment workflows are initiated
1919
- when store customers cancel their orders, the decreased stock is restored and payment and shipment are cancelled
2020

2121
[[= cards([
2222
"commerce/order_management/work_with_orders"
23-
], columns=3) =]]
23+
], columns=3) =]]

docs/commerce/order_management/work_with_orders.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ edition: commerce
66
# Work with orders
77

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

1111
## Filter orders in order list
1212

@@ -35,15 +35,15 @@ Available filters are:
3535

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

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

4040
![Order detail view](order_detail_view.png)
4141

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

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

46-
Where fields have the following meaning:
46+
The fields have the following meaning:
4747

4848
- **Subtotal (net)** - a sum of all product prices without taxes
4949
- **Shipping cost** - a net cost of the selected shipping method
@@ -52,17 +52,15 @@ Where fields have the following meaning:
5252

5353
!!! note "Ordering virtual products"
5454

55-
If the order includes only virtual products then the Shipment and Shipping address sections are not available.
56-
Virtual products don't require shipment when they are the only product in a purchase.
57-
55+
If the order includes only virtual products then the Shipment and Shipping address sections aren't available.
56+
Virtual products don't require shipment when they're the only product in a purchase.
5857

5958
## Change order status
6059

61-
If your [user Role](work_with_permissions.md) includes the `Order/Update` permission, you can change the status of an existing order:
62-
confirm it if the order has "Pending" status, or complete it when it is in "Processing" status.
60+
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's in "Processing" status.
6361
With the `Order/Cancel` permission, you can cancel an existing order.
6462

6563
!!! note "Canceling orders"
6664

67-
When an order is created, stocks are reduced for the products on that order.
65+
When you create an order, stocks are reduced for the products on that order.
6866
When you cancel an order, the stocks are reverted back to their original values.

docs/commerce/payment/payment_management.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ edition: commerce
55

66
# Payment management
77

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

10-
On the Back Office **Payments** screen, you can search for payments and filter the search results, as well as review payment details.
10+
On the back office **Payments** screen, you can search for payments, filter the search results, and review payment details.
1111
Depending on configuration and permissions, you may also be allowed to cancel payments.
1212

13-
If the permissions assigned to your [user Role](permissions_and_users.md) allow, you may also have access to the **Payment methods** screen, where you define, enable, and disable offline payment methods.
13+
If the permissions assigned to your [user role](permissions_and_users.md) allow, you may also have access to the **Payment methods** screen, where you define, enable, or disable offline payment methods.
1414

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

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

1919
[[= cards([
2020
"commerce/payment/work_with_payments",
2121
"commerce/payment/work_with_payment_methods"
22-
], columns=3) =]]
22+
], columns=3) =]]

docs/commerce/payment/work_with_payment_methods.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ edition: commerce
55

66
# Work with payment methods
77

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

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

1313
!!! note "Payment method limitations"
1414

15-
By default, you can only create payment methods of type "Offline".
15+
By default, you can only create payment methods of `Offline` type.
1616
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).
17-
17+
1818
Payment methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch.
1919

20-
## Create new payment method
20+
## Create new payment method
2121

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

@@ -39,7 +39,7 @@ Payment methods describe the way store customers pay for their orders during the
3939

4040
![Payment methods list](payment_methods_list.png)
4141

42-
2\. Find the payment method that you want to edit by using the search field and filters.
42+
2\. Use the search field and filters to find the payment method that you want to edit.
4343

4444
3\. Click the **Edit** button next to the method in the list.
4545

@@ -51,13 +51,13 @@ Payment methods describe the way store customers pay for their orders during the
5151

5252
1\. In the left panel, go to **Commerce** -> **Payment methods**.
5353

54-
2\. Find the payment method that you want to delete by using the search field and filters.
54+
2\. Use the search field and filters to find the payment method that you want to delete.
5555

5656
3\. Select a box next to its name and click **Delete**.
5757

5858
!!! note "Payment methods for existing orders"
5959

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

6363
## Filter payment methods

docs/commerce/payment/work_with_payments.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ edition: commerce
66
# Work with payments
77

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

1111
## Filter payments in payment list
1212

1313
1. In the left panel, go to **Commerce** -> **Payments**.
1414
2. Narrow down the list of displayed payments in one of the following ways:
15+
1516
- search for payments by typing part of order ID or identifier in the search box
1617
- filter payments by selecting one or more filters
1718

@@ -33,11 +34,11 @@ Available filters are:
3334

3435
To view the details of a payment, click its line in the payment list.
3536

36-
On the payment details screen, you can view a summary of information about the payment. Payment details include information about the payment method used, total value and current status of the payment.
37+
On the payment details screen, you can view a summary of information about the payment.
38+
Payment details include information about the payment method used, total value and current status of the payment.
3739

3840
![Payment detail view](payment_detail_view.png)
3941

4042
## Change payment details
4143

42-
If your [user Role](work_with_permissions.md) includes the `Payment/Edit` permission, you can change the status of an existing payment:
43-
confirm it if the payment has "Pending" status.
44+
If your [user role](work_with_permissions.md) includes the `Payment/Edit` permission, you can change the status of an existing payment: confirm it if the payment has "Pending" status.

docs/commerce/shipping_management/shipping_management.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,16 @@ edition: commerce
55

66
# Shipping management
77

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

11-
No two businesses are identical, and Ibexa ensures the flexibility that you need to configure shipping methods in a way that is optimal for your business and store customers.
11+
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.
1212

13-
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.
13+
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.
1414

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

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

2019
[[= cards([
2120
"commerce/shipping_management/work_with_shipping_methods",

docs/commerce/shipping_management/work_with_shipments.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,22 @@ Available filters are:
5050

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

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

5555
## View shipment details
5656

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

59-
On the shipment details screen, you can see an overview of the shipment's details.
59+
On the shipment details screen, you can see an overview of the shipment's details.
6060

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

6363
![Shipment detail view](shipment_detail_view.png)
6464

6565
## Change shipment status
6666

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

69-
- "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm.
70-
- "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm.
71-
- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm.
69+
- "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm.
70+
- "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm.
71+
- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm.

0 commit comments

Comments
 (0)