Merge pull request #398 from amit-webkul/doc-updates

⬆️ Updates
bagisto · Sep 17, 2024 · c1a1bac · c1a1bac
2 parents 7d2abe0 + 2917ed6
commit c1a1bac
Show file tree

Hide file tree

Showing 18 changed files with 192 additions and 49 deletions.
diff --git a/docs/2.0/packages/create-system-configuration.md b/docs/2.0/packages/create-system-configuration.md
@@ -66,7 +66,7 @@ return [
             ], [
                 'name'       => 'items',
                 'title'      => 'blog::app.admin.system.settings.items_per_page',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'numeric'
             ]
         ]
@@ -169,7 +169,7 @@ return [
             [
                 'name'  => 'number_type',
                 'title' => 'admin::app.admin.system.number-type',
-                'type'  => 'number',
+                'type'  => 'integer',
             ],
         ],
     ],
@@ -309,7 +309,7 @@ return [
         ], [
             'name'          => 'minimum_order_amount',
             'title'         => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
-            'type'          => 'number',
+            'type'          => 'integer',
             'validation'    => 'required_if:enable,1|numeric',
             'depends'       => 'enable:1',
             'channel_based' => true,
@@ -391,7 +391,7 @@ return [
             [
                 'name'       => 'max_upload_size',
                 'title'      => 'admin::app.admin.system.max-upload-size',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'required|integer|min:1|max:1024',
             ],
             [

diff --git a/docs/2.0/packages/datagrid.md b/docs/2.0/packages/datagrid.md
@@ -57,7 +57,7 @@ In **`Webkul\DataGrid\DataGrid\DataGrid.php`** abstract class, two abstract meth
         $this->addColumn([
             'index'      => 'id',
             'label'      => trans('blog::app.admin.datagrid.id'),
-            'type'       => 'number',
+            'type'       => 'integer',
             'searchable' => false,
             'sortable'   => true,
             'filterable' => true
@@ -203,7 +203,7 @@ class PostDataGrid extends DataGrid
         $this->addColumn([
             'index'      => 'id',
             'label'      => trans('blog::app.admin.datagrid.id'),
-            'type'       => 'number',
+            'type'       => 'integer',
             'searchable' => false,
             'sortable'   => true,
             'filterable' => true,

diff --git a/docs/2.1/packages/create-system-configuration.md b/docs/2.1/packages/create-system-configuration.md
@@ -66,7 +66,7 @@ return [
             ], [
                 'name'       => 'items',
                 'title'      => 'blog::app.admin.system.settings.items_per_page',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'numeric'
             ]
         ]
@@ -171,7 +171,7 @@ return [
             [
                 'name'  => 'number_type',
                 'title' => 'admin::app.admin.system.number-type',
-                'type'  => 'number',
+                'type'  => 'Integer',
             ],
         ],
     ],
@@ -315,7 +315,7 @@ return [
         ], [
             'name'          => 'minimum_order_amount',
             'title'         => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
-            'type'          => 'number',
+            'type'          => 'integer',
             'validation'    => 'required_if:enable,1|numeric',
             'depends'       => 'enable:1',
             'channel_based' => true,
@@ -398,7 +398,7 @@ return [
             [
                 'name'       => 'max_upload_size',
                 'title'      => 'admin::app.admin.system.max-upload-size',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'required|integer|min:1|max:1024',
             ],
             [

diff --git a/docs/2.1/packages/datagrid.md b/docs/2.1/packages/datagrid.md
@@ -57,7 +57,7 @@ In **`Webkul\DataGrid\DataGrid\DataGrid.php`** abstract class, two abstract meth
         $this->addColumn([
             'index'      => 'id',
             'label'      => trans('blog::app.admin.datagrid.id'),
-            'type'       => 'number',
+            'type'       => 'integer',
             'searchable' => false,
             'sortable'   => true,
             'filterable' => true
@@ -203,7 +203,7 @@ class PostDataGrid extends DataGrid
         $this->addColumn([
             'index'      => 'id',
             'label'      => trans('blog::app.admin.datagrid.id'),
-            'type'       => 'number',
+            'type'       => 'integer',
             'searchable' => false,
             'sortable'   => true,
             'filterable' => true,

diff --git a/docs/2.2/advanced/events.md b/docs/2.2/advanced/events.md
@@ -134,7 +134,7 @@ In Bagisto, there are several events fired throughout its operations, allowing d
 | catalog.product.update.after | This event will be fired after product gets updated. | `$product` |
 | catalog.product.delete.before | This event will be fired before product gets deleted. | `$id` |
 | catalog.product.delete.after | This event will be fired after product gets deleted. | `$id`  |
-| products.datagrid.sync | This event will be fired to synicing datagrid product. | `true` |
+| products.datagrid.sync | This event will be fired to syncing datagrid product. | `true` |
 | cms.page.create.before | This event will be fired before cms page gets created. | - |
 | cms.page.create.after | This event will be fired after cms page gets created. | `$page` |
 | cms.page.update.before | This event will be fired before cms page gets updated. | `$id` | 

diff --git a/docs/2.2/architecture/performance.md b/docs/2.2/architecture/performance.md
@@ -2,7 +2,7 @@
 
 [[TOC]]
 
-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.
+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.
 
 Additionally, **Bagisto** has seamlessly integrated [ElasticSearch](https://bagisto.com/en/elasticsearch-for-bagisto/) to further enhance user experience.
 
@@ -34,13 +34,13 @@ Similar to price indexing, the inventory indexing process in Bagisto involves up
 Flat indexing in Bagisto is a vital mechanism designed to enhance the performance and efficiency of product data retrieval.
 The indexer processes products in batches, which is efficient for handling large datasets without overwhelming the system.
 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.
-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.
+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.
 
 ### Catalog Rule Indexing
 
 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.
 
-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.
+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.
 
 ### ElasticSearch
 
@@ -52,37 +52,37 @@ To configure Elasticsearch, please refer to the [Configuration Setup](https://de
 
 ### Reindexing
 
-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.
+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.
 
-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:
+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:
 
 #### Command Signature
 
-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:
+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:
 
 ```shell
 php artisan indexer:index {--type=*} {--mode=*}
 ```    
-- **--type**: Specifies the type of indexers to reindex.
-- **--mode**: Specifies the reindexing mode, either `full` for full reindexing or selective for `selective` reindexing (default).
+- **--type**: Specifies the type of indexers to re-index.
+- **--mode**: Specifies the re-indexing mode, either `full` for full re-indexing or selective for `selective` re-indexing (default).
 
-- **Full Reindexing for All Types**
+- **Full Re-indexing for All Types**
 
 ```shell
 php artisan indexer:index --mode=full
 ```
-This command performs a full reindexing for all indexers by default.
+This command performs a full re-indexing for all indexers by default.
 
 
-- **Selective Reindexing**
+- **Selective Re-indexing**
 
 ```shell
 php artisan indexer:index --type=price
 ```
 
-This command performs selective reindexing specifically for the price indexer.
+This command performs selective re-indexing specifically for the price indexer.
 
-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:
+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:
 
 ```php
 $schedule->command('indexer:index --type=price')->dailyAt('00:01');

diff --git a/docs/2.2/packages/create-system-configuration.md b/docs/2.2/packages/create-system-configuration.md
@@ -66,7 +66,7 @@ return [
             ], [
                 'name'       => 'items',
                 'title'      => 'blog::app.admin.system.settings.items_per_page',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'numeric'
             ]
         ]
@@ -171,7 +171,7 @@ return [
             [
                 'name'  => 'number_type',
                 'title' => 'admin::app.admin.system.number-type',
-                'type'  => 'number',
+                'type'  => 'integer',
             ],
         ],
     ],
@@ -231,7 +231,7 @@ return [
                     ], [
                     ], [
                         'title' => 'option_2',
-                        'value' => 'vallue_2',
+                        'value' => 'value_2',
                     ],
                 ],
             ],
@@ -315,7 +315,7 @@ return [
         ], [
             'name'          => 'minimum_order_amount',
             'title'         => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
-            'type'          => 'number',
+            'type'          => 'integer',
             'validation'    => 'required_if:enable,1|numeric',
             'depends'       => 'enable:1',
             'channel_based' => true,
@@ -398,7 +398,7 @@ return [
             [
                 'name'       => 'max_upload_size',
                 'title'      => 'admin::app.admin.system.max-upload-size',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'required|integer|min:1|max:1024',
             ],
             [

diff --git a/docs/2.2/prologue/contribution-guide.md b/docs/2.2/prologue/contribution-guide.md
@@ -20,6 +20,7 @@ You can contribute to the following projects:
 - Bagisto docs
 - Bagisto rest-api
 - Bagisto booking-product
+- Bagisto laravel-data-faker
 - Laravel-aliexpress-dropship
 - Laravel-aliexpress-dropship-chrome-extension
 - Bagisto-custom-style-extension

diff --git a/docs/2.x/packages/create-system-configuration.md b/docs/2.x/packages/create-system-configuration.md
@@ -66,7 +66,7 @@ return [
             ], [
                 'name'       => 'items',
                 'title'      => 'blog::app.admin.system.settings.items_per_page',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'numeric'
             ]
         ]
@@ -169,7 +169,7 @@ return [
             [
                 'name'  => 'number_type',
                 'title' => 'admin::app.admin.system.number-type',
-                'type'  => 'number',
+                'type'  => 'integer',
             ],
         ],
     ],
@@ -309,7 +309,7 @@ return [
         ], [
             'name'          => 'minimum_order_amount',
             'title'         => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
-            'type'          => 'number',
+            'type'          => 'integer',
             'validation'    => 'required_if:enable,1|numeric',
             'depends'       => 'enable:1',
             'channel_based' => true,
@@ -391,7 +391,7 @@ return [
             [
                 'name'       => 'max_upload_size',
                 'title'      => 'admin::app.admin.system.max-upload-size',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'required|integer|min:1|max:1024',
             ],
             [

diff --git a/docs/2.x/packages/datagrid.md b/docs/2.x/packages/datagrid.md
@@ -57,7 +57,7 @@ In **`Webkul\DataGrid\DataGrid\DataGrid.php`** abstract class, two abstract meth
         $this->addColumn([
             'index'      => 'id',
             'label'      => trans('blog::app.admin.datagrid.id'),
-            'type'       => 'number',
+            'type'       => 'integer',
             'searchable' => false,
             'sortable'   => true,
             'filterable' => true
@@ -203,7 +203,7 @@ class PostDataGrid extends DataGrid
         $this->addColumn([
             'index'      => 'id',
             'label'      => trans('blog::app.admin.datagrid.id'),
-            'type'       => 'number',
+            'type'       => 'integer',
             'searchable' => false,
             'sortable'   => true,
             'filterable' => true,

diff --git a/docs/2.x/prologue/contribution-guide.md b/docs/2.x/prologue/contribution-guide.md
@@ -33,7 +33,7 @@ We welcome proposals for new features and enhancements to the existing Bagisto a
 Before submitting a pull request, it's important to consider the following points to help you choose the appropriate branch:
 
 - **Bug Fixes**: If you're fixing a bug, make sure to port the fix to the master version. 
-- **Critical Bug Fixes**: If you're fixing a critical bug, make sure to port the fix to the latest stable version that supports it (currently v2.1.2).
+- **Critical Bug Fixes**: If you're fixing a critical bug, make sure to port the fix to the latest stable version that supports it (currently v2.2.0).
 - **Feature Requests**: If your request involves a feature with potential breaking changes, send it to the master branch, which corresponds to the upcoming release (v2.x).
 
 ## Compiled Assets

diff --git a/docs/assets/master/images/themes/new-theme-added.png b/docs/assets/master/images/themes/new-theme-added.png
diff --git a/docs/master/advanced/create-data-import.md b/docs/master/advanced/create-data-import.md
@@ -256,3 +256,12 @@ This structured explanation provides a clear overview of the steps involved in s
 - `importBatch()`: This method imports all the rows of your `.csv` files into a batch file and then imports them into the database in a queue. It handles the processing of the data and updates the import batch summary.
 
 These methods play a crucial role in ensuring the integrity and accuracy of the imported data. They help in identifying and handling errors, such as missing or duplicate identifiers, and provide a smooth data transfer process.
+
+### Types of file allowed in the import process.
+
+We support four types of files for data transfer when importing bulk data into the system:
+
+- XML
+- CSV
+- XLSX
+- XLS
diff --git a/docs/master/introduction/requirements.md b/docs/master/introduction/requirements.md
@@ -48,6 +48,4 @@ Bagisto supports the following database servers:
 
 - **MySQL**: Version 8.0.32 or higher is recommended for optimal performance and compatibility.
 
-- **MariaDB**: Version 10.3 or higher is recommended for optimal performance and compatibility.
-
 - **Database Collation**: The recommended collation for the database is **`utf8mb4_unicode_ci`**, which ensures proper handling of Unicode characters and multilingual support.
diff --git a/docs/master/packages/create-system-configuration.md b/docs/master/packages/create-system-configuration.md
@@ -66,7 +66,7 @@ return [
             ], [
                 'name'       => 'items',
                 'title'      => 'blog::app.admin.system.settings.items_per_page',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'numeric'
             ]
         ]
@@ -169,7 +169,7 @@ return [
             [
                 'name'  => 'number_type',
                 'title' => 'admin::app.admin.system.number-type',
-                'type'  => 'number',
+                'type'  => 'string',
             ],
         ],
     ],
@@ -309,7 +309,7 @@ return [
         ], [
             'name'          => 'minimum_order_amount',
             'title'         => 'admin::app.configuration.index.sales.order-settings.minimum-order.minimum-order-amount',
-            'type'          => 'number',
+            'type'          => 'integer',
             'validation'    => 'required_if:enable,1|numeric',
             'depends'       => 'enable:1',
             'channel_based' => true,
@@ -391,7 +391,7 @@ return [
             [
                 'name'       => 'max_upload_size',
                 'title'      => 'admin::app.admin.system.max-upload-size',
-                'type'       => 'number',
+                'type'       => 'integer',
                 'validation' => 'required|integer|min:1|max:1024',
             ],
             [