Skip to content

Commit c1a1bac

Browse files
Merge pull request #398 from amit-webkul/doc-updates
⬆️ Updates
2 parents 7d2abe0 + 2917ed6 commit c1a1bac

File tree

18 files changed

+192
-49
lines changed

18 files changed

+192
-49
lines changed

docs/2.0/packages/create-system-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ return [
6666
], [
6767
'name' => 'items',
6868
'title' => 'blog::app.admin.system.settings.items_per_page',
69-
'type' => 'number',
69+
'type' => 'integer',
7070
'validation' => 'numeric'
7171
]
7272
]
@@ -169,7 +169,7 @@ return [
169169
[
170170
'name' => 'number_type',
171171
'title' => 'admin::app.admin.system.number-type',
172-
'type' => 'number',
172+
'type' => 'integer',
173173
],
174174
],
175175
],
@@ -309,7 +309,7 @@ return [
309309
], [
310310
'name' => 'minimum_order_amount',
311311
'title' => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
312-
'type' => 'number',
312+
'type' => 'integer',
313313
'validation' => 'required_if:enable,1|numeric',
314314
'depends' => 'enable:1',
315315
'channel_based' => true,
@@ -391,7 +391,7 @@ return [
391391
[
392392
'name' => 'max_upload_size',
393393
'title' => 'admin::app.admin.system.max-upload-size',
394-
'type' => 'number',
394+
'type' => 'integer',
395395
'validation' => 'required|integer|min:1|max:1024',
396396
],
397397
[

docs/2.0/packages/datagrid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ In **`Webkul\DataGrid\DataGrid\DataGrid.php`** abstract class, two abstract meth
5757
$this->addColumn([
5858
'index' => 'id',
5959
'label' => trans('blog::app.admin.datagrid.id'),
60-
'type' => 'number',
60+
'type' => 'integer',
6161
'searchable' => false,
6262
'sortable' => true,
6363
'filterable' => true
@@ -203,7 +203,7 @@ class PostDataGrid extends DataGrid
203203
$this->addColumn([
204204
'index' => 'id',
205205
'label' => trans('blog::app.admin.datagrid.id'),
206-
'type' => 'number',
206+
'type' => 'integer',
207207
'searchable' => false,
208208
'sortable' => true,
209209
'filterable' => true,

docs/2.1/packages/create-system-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ return [
6666
], [
6767
'name' => 'items',
6868
'title' => 'blog::app.admin.system.settings.items_per_page',
69-
'type' => 'number',
69+
'type' => 'integer',
7070
'validation' => 'numeric'
7171
]
7272
]
@@ -171,7 +171,7 @@ return [
171171
[
172172
'name' => 'number_type',
173173
'title' => 'admin::app.admin.system.number-type',
174-
'type' => 'number',
174+
'type' => 'Integer',
175175
],
176176
],
177177
],
@@ -315,7 +315,7 @@ return [
315315
], [
316316
'name' => 'minimum_order_amount',
317317
'title' => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
318-
'type' => 'number',
318+
'type' => 'integer',
319319
'validation' => 'required_if:enable,1|numeric',
320320
'depends' => 'enable:1',
321321
'channel_based' => true,
@@ -398,7 +398,7 @@ return [
398398
[
399399
'name' => 'max_upload_size',
400400
'title' => 'admin::app.admin.system.max-upload-size',
401-
'type' => 'number',
401+
'type' => 'integer',
402402
'validation' => 'required|integer|min:1|max:1024',
403403
],
404404
[

docs/2.1/packages/datagrid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ In **`Webkul\DataGrid\DataGrid\DataGrid.php`** abstract class, two abstract meth
5757
$this->addColumn([
5858
'index' => 'id',
5959
'label' => trans('blog::app.admin.datagrid.id'),
60-
'type' => 'number',
60+
'type' => 'integer',
6161
'searchable' => false,
6262
'sortable' => true,
6363
'filterable' => true
@@ -203,7 +203,7 @@ class PostDataGrid extends DataGrid
203203
$this->addColumn([
204204
'index' => 'id',
205205
'label' => trans('blog::app.admin.datagrid.id'),
206-
'type' => 'number',
206+
'type' => 'integer',
207207
'searchable' => false,
208208
'sortable' => true,
209209
'filterable' => true,

docs/2.2/advanced/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ In Bagisto, there are several events fired throughout its operations, allowing d
134134
| catalog.product.update.after | This event will be fired after product gets updated. | `$product` |
135135
| catalog.product.delete.before | This event will be fired before product gets deleted. | `$id` |
136136
| catalog.product.delete.after | This event will be fired after product gets deleted. | `$id` |
137-
| products.datagrid.sync | This event will be fired to synicing datagrid product. | `true` |
137+
| products.datagrid.sync | This event will be fired to syncing datagrid product. | `true` |
138138
| cms.page.create.before | This event will be fired before cms page gets created. | - |
139139
| cms.page.create.after | This event will be fired after cms page gets created. | `$page` |
140140
| cms.page.update.before | This event will be fired before cms page gets updated. | `$id` |

docs/2.2/architecture/performance.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[[TOC]]
44

5-
In the realm of online stores, [web vitals](https://web.dev/vitals/) have become increasingly crucial. **Bagisto** prioritises good [LCP](https://web.dev/lcp/) and [CLS](https://web.dev/cls/) to ensure an optimal user experience.
5+
In the realm of online stores, [web vitals](https://web.dev/vitals/) have become increasingly crucial. **Bagisto** priorities good [LCP](https://web.dev/lcp/) and [CLS](https://web.dev/cls/) to ensure an optimal user experience.
66

77
Additionally, **Bagisto** has seamlessly integrated [ElasticSearch](https://bagisto.com/en/elasticsearch-for-bagisto/) to further enhance user experience.
88

@@ -34,13 +34,13 @@ Similar to price indexing, the inventory indexing process in Bagisto involves up
3434
Flat indexing in Bagisto is a vital mechanism designed to enhance the performance and efficiency of product data retrieval.
3535
The indexer processes products in batches, which is efficient for handling large datasets without overwhelming the system.
3636
It manages a set of fillable attribute codes that are essential during the creation of the flat index. The flat indexer takes into account various channels and locales, ensuring that product data is accurately indexed for different market segments. A predefined list of attribute codes, such as `sku`, `name`, `price`, `weight`, and `status`, that can be populated during the indexing process.
37-
By default, the Flat Indexer reindexes products based on product creation or update events. However, there are scenarios where you might need to reindex the flat index in response to changes in channels or locales. In such cases, you can manually trigger the reindexing process to ensure that the flat tables reflect the latest channel and locale updates.
37+
By default, the Flat Indexer reindexes products based on product creation or update events. However, there are scenarios where you might need to re-index the flat index in response to changes in channels or locales. In such cases, you can manually trigger the re-indexing process to ensure that the flat tables reflect the latest channel and locale updates.
3838

3939
### Catalog Rule Indexing
4040

4141
Catalog rule indexing in Bagisto ensures that product prices are updated based on any changes to catalog rules, such as offers expiring or being updated. To maintain accurate pricing, Bagisto schedules the catalog rule indexer to run daily. This scheduled task ensures that any modifications to catalog rules are promptly applied to the product prices.
4242

43-
The catalog rule indexing process is set to execute at 00:01 every day. The product prices are consistently recalculated and updated based on the current catalog rules. This automatic reindexing guarantees that any changes in promotional offers, discounts, or other pricing rules are reflected in the product listings without any manual intervention.
43+
The catalog rule indexing process is set to execute at 00:01 every day. The product prices are consistently recalculated and updated based on the current catalog rules. This automatic re-indexing guarantees that any changes in promotional offers, discounts, or other pricing rules are reflected in the product listings without any manual intervention.
4444

4545
### ElasticSearch
4646

@@ -52,37 +52,37 @@ To configure Elasticsearch, please refer to the [Configuration Setup](https://de
5252

5353
### Reindexing
5454

55-
The `ReindexCommands` console command is responsible for reindexing data within Bagisto, facilitating efficient data retrieval and search functionality. This command offers flexibility in selecting specific indexers and reindexing modes to suit varying requirements.
55+
The `Re-indexCommands` console command is responsible for re-indexing data within Bagisto, facilitating efficient data retrieval and search functionality. This command offers flexibility in selecting specific indexers and re-indexing modes to suit varying requirements.
5656

57-
By default, reindexing is executed at the scheduled time or based on specific events, such as product creation or updates. However, there may be situations where you need to manually trigger reindexing. This can be done using the following commands:
57+
By default, re-indexing is executed at the scheduled time or based on specific events, such as product creation or updates. However, there may be situations where you need to manually trigger re-indexing. This can be done using the following commands:
5858

5959
#### Command Signature
6060

61-
The command `php artisan indexer:index` in Bagisto is used to manage the reindexing of various indexers. Here is a detailed description of its usage:
61+
The command `php artisan indexer:index` in Bagisto is used to manage the re-indexing of various indexers. Here is a detailed description of its usage:
6262

6363
```shell
6464
php artisan indexer:index {--type=*} {--mode=*}
6565
```
66-
- **--type**: Specifies the type of indexers to reindex.
67-
- **--mode**: Specifies the reindexing mode, either `full` for full reindexing or selective for `selective` reindexing (default).
66+
- **--type**: Specifies the type of indexers to re-index.
67+
- **--mode**: Specifies the re-indexing mode, either `full` for full re-indexing or selective for `selective` re-indexing (default).
6868

69-
- **Full Reindexing for All Types**
69+
- **Full Re-indexing for All Types**
7070

7171
```shell
7272
php artisan indexer:index --mode=full
7373
```
74-
This command performs a full reindexing for all indexers by default.
74+
This command performs a full re-indexing for all indexers by default.
7575

7676

77-
- **Selective Reindexing**
77+
- **Selective Re-indexing**
7878

7979
```shell
8080
php artisan indexer:index --type=price
8181
```
8282

83-
This command performs selective reindexing specifically for the price indexer.
83+
This command performs selective re-indexing specifically for the price indexer.
8484

85-
Price and price rule indexing are scheduled to reindex at a specific time each day to ensure that the latest pricing information is accurately reflected in searches and displays. The following commands are scheduled to run daily at 00:01 AM:
85+
Price and price rule indexing are scheduled to re-index at a specific time each day to ensure that the latest pricing information is accurately reflected in searches and displays. The following commands are scheduled to run daily at 00:01 AM:
8686

8787
```php
8888
$schedule->command('indexer:index --type=price')->dailyAt('00:01');

docs/2.2/packages/create-system-configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ return [
6666
], [
6767
'name' => 'items',
6868
'title' => 'blog::app.admin.system.settings.items_per_page',
69-
'type' => 'number',
69+
'type' => 'integer',
7070
'validation' => 'numeric'
7171
]
7272
]
@@ -171,7 +171,7 @@ return [
171171
[
172172
'name' => 'number_type',
173173
'title' => 'admin::app.admin.system.number-type',
174-
'type' => 'number',
174+
'type' => 'integer',
175175
],
176176
],
177177
],
@@ -231,7 +231,7 @@ return [
231231
], [
232232
], [
233233
'title' => 'option_2',
234-
'value' => 'vallue_2',
234+
'value' => 'value_2',
235235
],
236236
],
237237
],
@@ -315,7 +315,7 @@ return [
315315
], [
316316
'name' => 'minimum_order_amount',
317317
'title' => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
318-
'type' => 'number',
318+
'type' => 'integer',
319319
'validation' => 'required_if:enable,1|numeric',
320320
'depends' => 'enable:1',
321321
'channel_based' => true,
@@ -398,7 +398,7 @@ return [
398398
[
399399
'name' => 'max_upload_size',
400400
'title' => 'admin::app.admin.system.max-upload-size',
401-
'type' => 'number',
401+
'type' => 'integer',
402402
'validation' => 'required|integer|min:1|max:1024',
403403
],
404404
[

docs/2.2/prologue/contribution-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ You can contribute to the following projects:
2020
- Bagisto docs
2121
- Bagisto rest-api
2222
- Bagisto booking-product
23+
- Bagisto laravel-data-faker
2324
- Laravel-aliexpress-dropship
2425
- Laravel-aliexpress-dropship-chrome-extension
2526
- Bagisto-custom-style-extension

docs/2.x/packages/create-system-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ return [
6666
], [
6767
'name' => 'items',
6868
'title' => 'blog::app.admin.system.settings.items_per_page',
69-
'type' => 'number',
69+
'type' => 'integer',
7070
'validation' => 'numeric'
7171
]
7272
]
@@ -169,7 +169,7 @@ return [
169169
[
170170
'name' => 'number_type',
171171
'title' => 'admin::app.admin.system.number-type',
172-
'type' => 'number',
172+
'type' => 'integer',
173173
],
174174
],
175175
],
@@ -309,7 +309,7 @@ return [
309309
], [
310310
'name' => 'minimum_order_amount',
311311
'title' => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
312-
'type' => 'number',
312+
'type' => 'integer',
313313
'validation' => 'required_if:enable,1|numeric',
314314
'depends' => 'enable:1',
315315
'channel_based' => true,
@@ -391,7 +391,7 @@ return [
391391
[
392392
'name' => 'max_upload_size',
393393
'title' => 'admin::app.admin.system.max-upload-size',
394-
'type' => 'number',
394+
'type' => 'integer',
395395
'validation' => 'required|integer|min:1|max:1024',
396396
],
397397
[

docs/2.x/packages/datagrid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ In **`Webkul\DataGrid\DataGrid\DataGrid.php`** abstract class, two abstract meth
5757
$this->addColumn([
5858
'index' => 'id',
5959
'label' => trans('blog::app.admin.datagrid.id'),
60-
'type' => 'number',
60+
'type' => 'integer',
6161
'searchable' => false,
6262
'sortable' => true,
6363
'filterable' => true
@@ -203,7 +203,7 @@ class PostDataGrid extends DataGrid
203203
$this->addColumn([
204204
'index' => 'id',
205205
'label' => trans('blog::app.admin.datagrid.id'),
206-
'type' => 'number',
206+
'type' => 'integer',
207207
'searchable' => false,
208208
'sortable' => true,
209209
'filterable' => true,

0 commit comments

Comments
 (0)