Skip to content

Commit

Permalink
IBX-8916: Content update in User documentation - cd. (#314)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
julitafalcondusza authored Oct 21, 2024
1 parent c4e2b21 commit 2b18e53
Show file tree
Hide file tree
Showing 102 changed files with 1,104 additions and 1,382 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ibexa DXP User Documentation

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

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

## How to contribute

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

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

```bash
pip install -r requirements.txt
Expand All @@ -33,7 +33,7 @@ mkdocs serve
```

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

## Where to View

Expand Down
12 changes: 6 additions & 6 deletions docs/commerce/commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ edition: commerce
You can use them to create a unified and streamlined e-commerce platform.
Modules interact with each other, for example, to decrease stock following a sale, or cancel shipments and payments when orders are cancelled.

The solution complements functionalities provided by the [PIM](products.md) offering, and allows you to sell products through the website.
The solution complements functionalities provided by the [PIM](products.md) offering, and allows you to sell products through the website.
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.

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.
Contact your administrator or development team about customization options.
For more information, see [developer documentation]([[= developer_doc =]]/commerce/commerce/).
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.
Contact your administrator or development team about customization options.
For more information, see [Developer Documentation]([[= developer_doc =]]/commerce/commerce/).

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

![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:
Once the order is placed, users can interact with it by working with the following back office pages:

[[= cards([
"commerce/order_management/order_management",
Expand Down
10 changes: 5 additions & 5 deletions docs/commerce/order_management/order_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ 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 just your own ones.
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.
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

[[= cards([
"commerce/order_management/work_with_orders"
], columns=3) =]]
], columns=3) =]]
16 changes: 7 additions & 9 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 @@ -52,17 +52,15 @@ Where fields have the following meaning:

!!! note "Ordering virtual products"

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.

If the order includes only virtual products then the Shipment and Shipping address sections aren't available.
Virtual products don't require shipment when they're 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.
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.
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.
10 changes: 5 additions & 5 deletions docs/commerce/payment/payment_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ 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 and filter the search results, as well as review payment details.
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.

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

![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",
"commerce/payment/work_with_payment_methods"
], columns=3) =]]
], columns=3) =]]
14 changes: 7 additions & 7 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 All @@ -39,7 +39,7 @@ Payment methods describe the way store customers pay for their orders during the

![Payment methods list](payment_methods_list.png)

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

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

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

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

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

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

!!! 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
9 changes: 5 additions & 4 deletions docs/commerce/payment/work_with_payments.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ 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

1. In the left panel, go to **Commerce** -> **Payments**.
2. Narrow down the list of displayed payments in one of the following ways:

- search for payments by typing part of order ID or identifier in the search box
- filter payments by selecting one or more filters

Expand All @@ -33,11 +34,11 @@ Available filters are:

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

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

![Payment detail view](payment_detail_view.png)

## Change payment details

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.
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.
9 changes: 4 additions & 5 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 Ibexa ensures the flexibility that you need to configure shipping methods in a way that is optimal for your business and store customers.
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
14 changes: 7 additions & 7 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:
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.
- "Shipped" -> "Delivered" - click **Deliver** 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.
Loading

0 comments on commit 2b18e53

Please sign in to comment.