Skip to content

Commit d41dc22

Browse files
committed
Continue install_shopping_list.md
ibexa/recipes-dev#230
1 parent 093ba65 commit d41dc22

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

docs/commerce/shopping_list/install_shopping_list.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,24 @@ Run the following command to install the package:
1414
composer require ibexa/shopping-list
1515
```
1616

17-
TODO: Describe what install does
17+
The associated recipe declares the bundle and its routes.
1818

1919
Check that the following line have been added by the recipe to `config/bundles.php` file's array:
2020
```php
2121
Ibexa\Bundle\ShoppingList\IbexaShoppingListBundle::class => ['all' => true],
2222
```
2323

24+
And that you have a `config/routes/ibexa_shopping_list.yaml` file configuring the following routes:
25+
26+
```yaml
27+
ibexa.shopping_list:
28+
resource: '@IbexaShoppingListBundle/Resources/config/routing.php'
29+
30+
ibexa.rest.shopping_list:
31+
resource: '@IbexaShoppingListBundle/Resources/config/routing_rest.php'
32+
prefix: '%ibexa.rest.path_prefix%'
33+
```
34+
2435
## Modify database schema
2536
2637
Add the tables needed by the bundle:
@@ -39,13 +50,14 @@ Add the tables needed by the bundle:
3950

4051
TODO: possible charset issue, see https://github.com/ibexa/doctrine-schema/pull/38
4152

42-
TODO: ~~Default shopping list creation for existing customers?~~ The default shopping lists are created when used.
53+
Notice that a user has no shopping list at this stage, not even the default one.
54+
The users' default shopping lists are created when used.
4355

4456
## Configure
4557

4658
By default, the maximum shopping list count per user is 10 and the maximum entries per list is 100.
47-
48-
TODO: explain `list_per_page_limit`
59+
When listing their shopping list, the use see 25 lists per page
60+
(and as it's over the shopping list count, there is always one page of shopping lists in this default scenario).
4961

5062
You can override the following parameters to change their values:
5163

@@ -56,19 +68,6 @@ parameters:
5668
ibexa.site_access.config.default.shopping_list.pagination.list_per_page_limit: 25
5769
```
5870

59-
TODO: Probably a file that will be created by recipe:
60-
61-
```yaml
62-
# config/routes/ibexa_shopping_list.yaml
63-
64-
ibexa.shopping_list:
65-
resource: '@IbexaShoppingListBundle/Resources/config/routing.php'
66-
67-
ibexa.rest.shopping_list:
68-
resource: '@IbexaShoppingListBundle/Resources/config/routing_rest.php'
69-
prefix: '%ibexa.rest.path_prefix%'
70-
```
71-
7271
### Role
7372

7473
Create a new role and then assign it to registered customer groups who should be able to use this feature.

0 commit comments

Comments
 (0)