minor #11177 [Documentation] Sylius Plus docs part 2; including fixes…

… to links (CoderMaggie)

This PR was merged into the 1.6 branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         | 1.6
| Doc fix?        | yes - broken links for The Book
| New docs?    | yes
| Related tickets | Part 2 of #11054 
| License         | MIT


Commits
-------

ee90d2b [Plus Docs] Multi-source inventory fixtures
073c056 [Plus Docs] Return Requests emails
24933dd [Plus Docs][Cookbook] Custom inventory sources filter
1290e11 [Plus Docs] Improve Docs Organisation
3baf319 [Plus Docs] Review fixes

docs/book/architecture/emails.rst

@@ -74,6 +74,99 @@ You have the following parameters available:
 * ``shipment``: Shipment instance
 * ``order``: Instance of the order, with all its data
 
+.. rst-class:: plus-doc
+
+Return Requests Emails
+----------------------
+
+.. hint::
+
+   What are Return Requests? :doc:`Check here </book/orders/returns>`!
+
+Return Request Confirmation
+'''''''''''''''''''''''''''
+
+This email is sent after return request has been created by a customer.
+
+**Code**: ``sylius_plus_return_request_confirmation``
+
+**The default template**:
+``@SyliusPlusPlugin/Returns/Infrastructure``
+``/Resources/views/Emails/returnRequestConfirmation.html.twig``
+
+Parameters:
+
+* ``order`` - for which the return request has been created
+
+Return Request Acceptation
+''''''''''''''''''''''''''
+
+This email is sent when the administrator accepts a return request.
+
+**Code**: ``sylius_plus_return_request_accepted``
+
+**The default template**:
+``@SyliusPlusPlugin/Returns/Infrastructure``
+``/Resources/views/Emails/returnRequestAcceptedNotification.html.twig``
+
+Parameters:
+
+* ``returnRequest`` which has been accepted
+* ``order`` of the accepted return request
+
+Return Request Rejection
+''''''''''''''''''''''''
+
+This email is sent when the administrator rejects a return request.
+
+**Code**: ``sylius_plus_return_request_rejected``
+
+**The default template**:
+``@SyliusPlusPlugin/Returns/Infrastructure``
+``/Resources/views/Emails/returnRequestRejectedNotification.html.twig``
+
+Parameters:
+
+* ``returnRequest`` which has been rejected
+* ``order`` of the rejected return request
+
+
+Return Request Resolution Change
+''''''''''''''''''''''''''''''''
+
+This email is sent when the administrator changes return request's resolution proposed by a customer.
+
+**Code**: ``sylius_plus_return_request_resolution_changed``
+
+**The default template**:
+``@SyliusPlusPlugin/Returns/Infrastructure``
+``/Resources/views/Emails/returnRequestResolutionChangedNotification.html.twig``
+
+Parameters:
+
+* ``returnRequest`` whose resolution has been changed
+* ``order`` of the modified return request
+
+Return Request: Repaired Items Sent
+'''''''''''''''''''''''''''''''''''
+
+This email is sent when the administrator marks that a return request's repaired items have been sent back to the Customer.
+
+**Code**: ``sylius_plus_return_request_repaired_items_sent``
+
+**The default template**:
+``@SyliusPlusPlugin/Returns/Infrastructure``
+``/Resources/views/Emails/returnRequestRepairedItemsSentNotification.html.twig``
+
+Parameters:
+
+* ``returnRequest`` of which the items were sent
+* ``order`` of the return request
+
+.. image:: ../../_images/sylius_plus/banner.png
+   :align: center
+   :target: http://sylius.com/plus/?utm_source=docs
+
 How to send an Email programmatically?
 --------------------------------------
 

docs/book/customers/map.rst.inc

@@ -1,8 +1,4 @@
-.. raw:: html
-
-    <ul class="simple">
-    <li><p><a class="reference internal" href="customers/customer_and_shopuser.html"><span class="doc">Customer and ShopUser</span></a></p></li>
-    <li><p><a class="reference internal plus-feature" href="customers/customer_pools.html"><span class="doc">Customer Pools</span></a></p></li>
-    <li><p><a class="reference internal" href="customers/adminuser.html"><span class="doc">AdminUser</span></a></p></li>
-    <li><p><a class="reference internal" href="customers/addresses/index.html"><span class="doc">Addresses</span></a></p></li>
-    </ul>
+* :doc:`/book/customers/customer_and_shopuser`
+* :doc:`/book/customers/customer_pools`
+* :doc:`/book/customers/adminuser`
+* :doc:`/book/customers/addresses/index`

docs/book/index.rst

@@ -108,6 +108,33 @@ Here you will learn basics about the Theming concept of Sylius. How to change th
 
 .. include:: /book/themes/map.rst.inc
 
+.. rst-class:: plus-doc
+
+Sylius Plus
+-----------
+
+`Sylius Plus <https://sylius.com/plus/>`_, which is a licensed edition of Sylius, gives you all the power of Open Source and much more.
+It comes with a set of enterprise-grade features and technical support from its creators.
+As the state-of-the-art eCommerce platform, it reduces risks and increases your ROI.
+
+Documentation sections of The Book referring to Sylius Plus features are:
+
+.. toctree::
+    :maxdepth: 1
+
+    installation/sylius_plus_installation
+    architecture/emails
+    configuration/channels
+    customers/adminuser
+    customers/customer_pools
+    orders/shipments
+    orders/returns
+
+
+.. image:: ../_images/sylius_plus/banner.png
+    :align: center
+    :target: http://sylius.com/plus/?utm_source=docs
+
 Sylius Plugins
 --------------
 

docs/book/installation/map.rst.inc

@@ -1,8 +1,4 @@
-.. raw:: html
-
-    <ul class="simple">
-    <li><a class="reference internal" href="installation/requirements.html"><span class="doc">System Requirements</span></a></li>
-    <li><a class="reference internal" href="installation/installation.html"><span class="doc">Installation</span></a></li>
-    <li><a class="reference internal plus-feature" href="installation/sylius_plus_installation.html"><span class="doc">Sylius Plus Installation</span></a></li>
-    <li><a class="reference internal" href="installation/upgrading.html"><span class="doc">Upgrading</span></a></li>
-    </ul>
+* :doc:`/book/installation/requirements`
+* :doc:`/book/installation/installation`
+* :doc:`/book/installation/sylius_plus_installation`
+* :doc:`/book/installation/upgrading`

docs/book/introduction/introduction.rst

@@ -31,10 +31,8 @@ There exists a commercial edition of Sylius, which is called `Sylius Plus <https
 Sylius Plus gives you all the power of Open Source and much more. It comes with a set of enterprise-grade features
 and technical support from its creators. As the state-of-the-art eCommerce platform, it reduces risks and increases your ROI.
 
-.. rst-class:: plus-feature
-
 In this documentation you will find also chapters dedicated to features introduced by the Sylius Plus edition, they will
-be marked with a frame just like this section, and a label like this ->
+be marked with a frame just like this section.
 
 The Three Natures of Sylius
 ---------------------------

docs/book/orders/map.rst.inc

@@ -1,16 +1,12 @@
-.. raw:: html
-
-    <ul class="simple">
-    <li><p><a class="reference internal" href="orders/orders.html"><span class="doc">Orders</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/cart-flow.html"><span class="doc">Cart flow</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/taxation.html"><span class="doc">Taxation</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/adjustments.html"><span class="doc">Adjustments</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/promotions.html"><span class="doc">Promotions</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/coupons.html"><span class="doc">Coupons</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/payments.html"><span class="doc">Payments</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/invoices.html"><span class="doc">Invoices</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/shipments.html"><span class="doc">Shipments</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/checkout.html"><span class="doc">Checkout</span></a></p></li>
-    <li><p><a class="reference internal plus-feature" href="orders/returns.html"><span class="doc">Returns</span></a></p></li>
-    <li><p><a class="reference internal" href="orders/refunds.html"><span class="doc">Refunds</span></a></p></li>
-    </ul>
+* :doc:`/book/orders/orders`
+* :doc:`/book/orders/cart-flow`
+* :doc:`/book/orders/taxation`
+* :doc:`/book/orders/adjustments`
+* :doc:`/book/orders/promotions`
+* :doc:`/book/orders/coupons`
+* :doc:`/book/orders/payments`
+* :doc:`/book/orders/invoices`
+* :doc:`/book/orders/shipments`
+* :doc:`/book/orders/checkout`
+* :doc:`/book/orders/returns`
+* :doc:`/book/orders/refunds`

docs/book/orders/returns.rst

@@ -178,6 +178,7 @@ Learn more
 
 * `Sylius/RefundPlugin <https://github.com/Sylius/RefundPlugin>`_
 * :doc:`Refunds </book/orders/refunds>`
+* :doc:`Emails related to Return Requests </book/architecture/emails>`
 
 .. image:: ../../_images/sylius_plus/banner.png
   :align: center

docs/book/products/map.rst.inc

@@ -1,13 +1,9 @@
-.. raw:: html
-
-    <ul class="simple">
-    <li><p><a class="reference internal" href="products/products.html"><span class="doc">Products</span></a></p></li>
-    <li><p><a class="reference internal" href="products/product_reviews.html"><span class="doc">Product Reviews</span></a></p></li>
-    <li><p><a class="reference internal" href="products/product_associations.html"><span class="doc">Product Associations</span></a></p></li>
-    <li><p><a class="reference internal" href="products/attributes.html"><span class="doc">Attributes</span></a></p></li>
-    <li><p><a class="reference internal" href="products/pricing.html"><span class="doc">Pricing</span></a></p></li>
-    <li><p><a class="reference internal" href="products/taxons.html"><span class="doc">Taxons</span></a></p></li>
-    <li><p><a class="reference internal" href="products/inventory.html"><span class="doc">Inventory</span></a></p></li>
-    <li><p><a class="reference internal plus-feature" href="products/multi_source_inventory.html"><span class="doc">Multi-Source Inventory</span></a></p></li>
-    <li><p><a class="reference internal" href="products/search.html"><span class="doc">Search</span></a></p></li>
-    </ul>
+* :doc:`/book/products/products`
+* :doc:`/book/products/product_reviews`
+* :doc:`/book/products/product_associations`
+* :doc:`/book/products/attributes`
+* :doc:`/book/products/pricing`
+* :doc:`/book/products/taxons`
+* :doc:`/book/products/inventory`
+* :doc:`/book/products/multi_source_inventory`
+* :doc:`/book/products/search`

docs/book/products/multi_source_inventory.rst

@@ -119,9 +119,48 @@ How does Multi-Source Inventory work on examples?
    You can see all use cases we have designed in Sylius Plus by browsing the Behat scenarios for inventory in the vendor package
    after installing Sylius Plus.
 
+Multi-source inventory fixtures
+-------------------------------
+
+Inventory Sources fixtures
+''''''''''''''''''''''''''
+
+This fixture creates Inventory Sources without products (empty) enabled in chosen channels:
+
+.. code-block:: yaml
+
+   hamburg_warehouse:
+      code: 'hamburg_warehouse'
+      name: 'Hamburg Warehouse'
+      channels:
+         - 'HOME_WEB'
+         - 'FASHION_WEB'
+
+
+Inventory Source Stocks fixtures
+''''''''''''''''''''''''''''''''
+
+This fixture adds inventory source stock to chosen Inventory Source, you can choose which taxons and channels you want
+to include in each inventory source.
+
+When declaring both options, a union of sets will be resolved.
+
+.. code-block:: yaml
+
+   stocks_in_frankfurt_warehouse:
+       inventory_source: 'frankfurt_warehouse'
+       products_from:
+           taxons_codes:
+               - 'caps'
+               - 'dresses'
+           channels_codes:
+               - 'HOME_WEB'
+               - 'FASHION_WEB'
+
 Learn more
 ----------
 
+* :doc:`Cookbook: How to create a custom inventory sources filter? </cookbook/inventory/custom-inventory-sources-filter>`
 * :doc:`Order concept documentation </book/orders/orders>`
 * :doc:`Single Source Inventory concept documentation </book/products/inventory>`
 

docs/cookbook/index.rst

@@ -78,6 +78,16 @@ Promotions
 
 .. include:: /cookbook/promotions/map.rst.inc
 
+Inventory
+---------
+
+.. toctree::
+    :hidden:
+
+    inventory/custom-inventory-sources-filter
+
+.. include:: /cookbook/inventory/map.rst.inc
+
 Images
 ------