diff --git a/docs/getting-started-with-sylius/plugin-installation.rst b/docs/getting-started-with-sylius/plugin-installation.rst index a2dc716ce9..d9dad16d6f 100644 --- a/docs/getting-started-with-sylius/plugin-installation.rst +++ b/docs/getting-started-with-sylius/plugin-installation.rst @@ -36,5 +36,5 @@ Learn more ########## * :doc:`Plugins ` -* :doc:`Plugin development guide ` +* :doc:`Plugin development guide ` * :doc:`Official plugins ` diff --git a/docs/index.rst b/docs/index.rst index dc84d595b7..bc70bc198a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -98,8 +98,7 @@ The Customization Guide Sylius Plugins -------------- -The collection of Sylius Plugins together with the guide on Plugins development. -Remember that you can use all the :doc:`customization techniques ` in Plugins. +The collection of Sylius Plugins and basic introduction to the concept of plugins. .. toctree:: :hidden: @@ -108,6 +107,20 @@ Remember that you can use all the :doc:`customization techniques ` in Plugins. + +.. toctree:: + :hidden: + + plugin-development-guide/index + +.. include:: /plugin-development-guide/map.rst.inc + The Cookbook ------------ diff --git a/docs/plugins/plugin-development-guide/idea.rst b/docs/plugin-development-guide/idea.rst similarity index 100% rename from docs/plugins/plugin-development-guide/idea.rst rename to docs/plugin-development-guide/idea.rst diff --git a/docs/plugins/plugin-development-guide/implementation.rst b/docs/plugin-development-guide/implementation.rst similarity index 100% rename from docs/plugins/plugin-development-guide/implementation.rst rename to docs/plugin-development-guide/implementation.rst diff --git a/docs/plugins/plugin-development-guide/index.rst b/docs/plugin-development-guide/index.rst similarity index 65% rename from docs/plugins/plugin-development-guide/index.rst rename to docs/plugin-development-guide/index.rst index 21d831a9a2..afb558a853 100644 --- a/docs/plugins/plugin-development-guide/index.rst +++ b/docs/plugin-development-guide/index.rst @@ -1,5 +1,5 @@ -Plugin Development Guide -======================== +🏗️ Plugin Development Guide +============================ Sylius plugins are one of the most powerful ways to extend Sylius functionalities. They're not bounded by Sylius release cycle and can be developed quicker and more effectively. They also allow sharing our (developers) work in an open-source community, which is not possible with @@ -9,7 +9,6 @@ BDD methodology says the most accurate way to explain some process is using an e With respect to that rule, let's create some simple first plugin together! .. toctree:: - :numbered: idea installation @@ -17,3 +16,10 @@ With respect to that rule, let's create some simple first plugin together! specification implementation summary + +.. seealso:: + + :doc:`/plugins/index` + The collection of Sylius Plugins and basic introduction to the concept of plugins. + :doc:`/customization/index` + Sylius customization techniques available to use also in plugins. diff --git a/docs/plugins/plugin-development-guide/installation.rst b/docs/plugin-development-guide/installation.rst similarity index 100% rename from docs/plugins/plugin-development-guide/installation.rst rename to docs/plugin-development-guide/installation.rst diff --git a/docs/plugin-development-guide/map.rst.inc b/docs/plugin-development-guide/map.rst.inc new file mode 100644 index 0000000000..80ef7d2db5 --- /dev/null +++ b/docs/plugin-development-guide/map.rst.inc @@ -0,0 +1,7 @@ +* :doc:`/plugin-development-guide/index` +* :doc:`/plugin-development-guide/idea` +* :doc:`/plugin-development-guide/installation` +* :doc:`/plugin-development-guide/naming` +* :doc:`/plugin-development-guide/specification` +* :doc:`/plugin-development-guide/implementation` +* :doc:`/plugin-development-guide/summary` diff --git a/docs/plugins/plugin-development-guide/naming.rst b/docs/plugin-development-guide/naming.rst similarity index 100% rename from docs/plugins/plugin-development-guide/naming.rst rename to docs/plugin-development-guide/naming.rst diff --git a/docs/plugins/plugin-development-guide/specification.rst b/docs/plugin-development-guide/specification.rst similarity index 100% rename from docs/plugins/plugin-development-guide/specification.rst rename to docs/plugin-development-guide/specification.rst diff --git a/docs/plugins/plugin-development-guide/summary.rst b/docs/plugin-development-guide/summary.rst similarity index 96% rename from docs/plugins/plugin-development-guide/summary.rst rename to docs/plugin-development-guide/summary.rst index fe1822d821..3f298df30a 100644 --- a/docs/plugins/plugin-development-guide/summary.rst +++ b/docs/plugin-development-guide/summary.rst @@ -5,7 +5,7 @@ Congratulations! You've created your first, fully tested and documented, customi As a result, you should see a new field in product variant form: -.. image:: ../../_images/product_variant_available_on_demand.png +.. image:: ../_images/product_variant_available_on_demand.png :align: center As you can see, there are some things to do at the beginning of development, but now, when you are already familiar with diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index b3d07bf88c..da281458c3 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -15,13 +15,12 @@ Exemplary features may be: Social media buttons, newsletter, wishlists, payment .. tip:: - **The list of all Sylius Plugins (offcial and approved) is available on the Sylius website** `here `_. + **The list of all Sylius Plugins (official and approved) is available on the Sylius website** `here `_. .. toctree:: :hidden: creating-plugin - plugin-development-guide/index official-plugins approved-plugins diff --git a/docs/plugins/map.rst.inc b/docs/plugins/map.rst.inc index 609f8bb0f1..a544697f53 100644 --- a/docs/plugins/map.rst.inc +++ b/docs/plugins/map.rst.inc @@ -1,4 +1,3 @@ * :doc:`/plugins/creating-plugin` -* :doc:`/plugins/plugin-development-guide/index` * :doc:`/plugins/official-plugins` * :doc:`/plugins/approved-plugins`