[Docs] Move Plugins section to the Book

Inventis · Jul 18, 2019 · ff9c1d8 · ff9c1d8
1 parent 0abeac1
commit ff9c1d8
Show file tree

Hide file tree

Showing 17 changed files with 37 additions and 29 deletions.
diff --git a/docs/book/index.rst b/docs/book/index.rst
@@ -106,4 +106,16 @@ Here you will learn basics about the Theming concept of Sylius. How to change th
 
     themes/index
 
-.. include:: /book/themes/map.rst.inc
+.. include:: /book/themes/map.rst.inc
+
+Sylius Plugins
+--------------
+
+The collection of Sylius Plugins and basic introduction to the concept of plugins.
+
+.. toctree::
+    :hidden:
+
+    plugins/index
+
+.. include:: /book/plugins/map.rst.inc
diff --git a/docs/book/map.rst.inc b/docs/book/map.rst.inc
@@ -6,3 +6,4 @@
 * :doc:`/book/products/index`
 * :doc:`/book/orders/index`
 * :doc:`/book/themes/index`
+* :doc:`/book/plugins/index`
diff --git a/docs/book/orders/payments.rst b/docs/book/orders/payments.rst
@@ -121,7 +121,7 @@ Other Payment Gateways
     Learn more about integrating payment gateways in `the Payum docs <https://github.com/Payum/Payum/blob/master/docs/index.md>`_.
 
 When the Payment Gateway you are trying to use does have a bridge available and you integrate them on your own,
-use our guide on :doc:`extension development </plugins/creating-plugin>`.
+use our guide on :doc:`extension development </plugin-development-guide/index>`.
 
 .. tip::
 

diff --git a/docs/plugins/approved-plugins.rst → docs/book/plugins/approved-plugins.rst b/docs/plugins/approved-plugins.rst → docs/book/plugins/approved-plugins.rst
@@ -8,7 +8,7 @@ on our website <https://sylius.com/plugins/>`_.
 
 When a plugin is approved by Sylius, you can recognize it also by this badge below in its readme file:
 
-.. image:: ../_images/approved_plugin.png
+.. image:: ../../_images/approved_plugin.png
     :scale: 50%
 
 |
@@ -18,7 +18,7 @@ How to have a Plugin approved by Sylius?
 
 Since Sylius is an open-source platform, there is a certain flow in order for the plugin to become officially adopted by the community.
 
-**1.** Develop the plugin using :doc:`the official Plugin Development guide </plugins/creating-plugin>`.
+**1.** Develop the plugin using :doc:`the official Plugin Development guide </book/plugins/creating-plugin>`.
 
 **2.** Remember about the tests and code quality!
 

diff --git a/docs/plugins/creating-plugin.rst → docs/book/plugins/creating-plugin.rst b/docs/plugins/creating-plugin.rst → docs/book/plugins/creating-plugin.rst
@@ -6,6 +6,12 @@ Sylius plugin is nothing more but a regular Symfony bundle adding custom behavio
 The best way to create your own plugin is to use `Sylius plugin skeleton <https://github.com/Sylius/PluginSkeleton>`_,
 which has built-in infrastructure for designing and testing using `Behat`_.
 
+.. note::
+
+    This doc is a very short introduction to plugin development. For a more detailed guide please head to :doc:`/book/plugins/index`.
+
+Quickstart to plugins development:
+
 1. Create project using Composer.
 ---------------------------------
 

diff --git a/docs/plugins/index.rst → docs/book/plugins/index.rst b/docs/plugins/index.rst → docs/book/plugins/index.rst
@@ -24,4 +24,4 @@ Exemplary features may be: Social media buttons, newsletter, wishlists, payment
     official-plugins
     approved-plugins
 
-.. include:: /plugins/map.rst.inc
+.. include:: /book/plugins/map.rst.inc
diff --git a/docs/book/plugins/map.rst.inc b/docs/book/plugins/map.rst.inc
@@ -0,0 +1,4 @@
+* :doc:`/book/plugins/index`
+* :doc:`/book/plugins/creating-plugin`
+* :doc:`/book/plugins/official-plugins`
+* :doc:`/book/plugins/approved-plugins`
diff --git a/docs/plugins/official-plugins.rst → docs/book/plugins/official-plugins.rst b/docs/plugins/official-plugins.rst → docs/book/plugins/official-plugins.rst
@@ -6,7 +6,7 @@ developed by Sylius can be found in the `github organization <http://github.com/
 
 You can recognize a Sylius official plugin by this badge in its readme:
 
-.. image:: ../_images/official_plugin.png
+.. image:: ../../_images/official_plugin.png
     :scale: 50%
 
 |

diff --git a/docs/cookbook/shop/cms.rst b/docs/cookbook/shop/cms.rst
@@ -38,6 +38,6 @@ Find out more about how to install the plugin on `GitHub <https://github.com/Bit
 Learn more
 ----------
 
-* :doc:`How to create a plugin for Sylius? </plugins/creating-plugin>`
+* :doc:`How to create a plugin for Sylius? </book/plugins/creating-plugin>`
 * `BitBag plugins <https://github.com/BitBagCommerce>`_
 * `FriendsOfSylius plugins <https://github.com/FriendsOfSylius/SyliusGoose>`_
diff --git a/docs/customization/plugins.rst.inc b/docs/customization/plugins.rst.inc
@@ -3,4 +3,4 @@ Good to know
 
 .. seealso::
 
-    All the customizations can be done either in your application directly or in :doc:`Plugins </plugins/index>`!
+    All the customizations can be done either in your application directly or in :doc:`Plugins </book/plugins/index>`!
diff --git a/docs/customization/template.rst b/docs/customization/template.rst
@@ -25,7 +25,7 @@ Methods of templates customizing
 
     The second method is **templates customization via events**. You are able to listen on these template events,
     and by that add your own blocks without copying and pasting the whole templates. This feature is really useful
-    when :doc:`creating Sylius Plugins </plugins/creating-plugin>`.
+    when :doc:`creating Sylius Plugins </book/plugins/creating-plugin>`.
 
     The third method is **using Sylius themes**. Creating a Sylius theme requires a few more steps than basic template overriding,
     but allows you to have a different design on multiple channels of the same Sylius instance. :doc:`Learn more about themes here </book/themes/themes>`.

diff --git a/docs/getting-started-with-sylius/plugin-installation.rst b/docs/getting-started-with-sylius/plugin-installation.rst
@@ -35,6 +35,6 @@ There is no need to reinvent the wheel :)
 Learn more
 ##########
 
-* :doc:`Plugins </plugins/index>`
+* :doc:`Plugins </book/plugins/index>`
 * :doc:`Plugin development guide </plugin-development-guide/index>`
-* :doc:`Official plugins </plugins/official-plugins>`
+* :doc:`Official plugins </book/plugins/official-plugins>`
diff --git a/docs/getting-started-with-sylius/summary.rst b/docs/getting-started-with-sylius/summary.rst
@@ -10,7 +10,7 @@ There are a few tips at the end of this tutorial:
 
 - if you're interested in making more customizations, you should read some chapters from :doc:`The Customization Guide</book/index>`
 
-- if you want to share your work with the Community, check out the :doc:`Sylius Plugins</plugins/index>` chapter
+- if you want to share your work with the Community, check out the :doc:`Sylius Plugins</book/plugins/index>` chapter
 
 And the most important - if you want to become a part of our collectivity, join our `Slack <https://sylius.com/slack>`_,
 `Forum <https://forum.sylius.com/>`_ and follow `our repository <https://github.com/Sylius/Sylius>`_ to be always up-to-date

diff --git a/docs/index.rst b/docs/index.rst
@@ -95,18 +95,6 @@ The Customization Guide
 
 .. include:: /customization/map.rst.inc
 
-Sylius Plugins
---------------
-
-The collection of Sylius Plugins and basic introduction to the concept of plugins.
-
-.. toctree::
-   :hidden:
-
-   plugins/index
-
-.. include:: /plugins/map.rst.inc
-
 Plugin Development Guide
 ------------------------
 

diff --git a/docs/plugin-development-guide/index.rst b/docs/plugin-development-guide/index.rst
@@ -19,7 +19,7 @@ With respect to that rule, let's create some simple first plugin together!
 
 .. seealso::
 
-    :doc:`/plugins/index`
+    :doc:`/book/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/plugin-development-guide/specification.rst b/docs/plugin-development-guide/specification.rst
@@ -2,7 +2,7 @@ Specification
 -------------
 
 We strongly encourage you to follow our BDD path in implementing Sylius plugins. In fact, proper tests are one of the requirements to
-:doc:`have your plugin officially accepted</plugins/index>`.
+:doc:`have your plugin officially accepted</book/plugins/index>`.
 
 .. attention::
 

diff --git a/docs/plugins/map.rst.inc b/docs/plugins/map.rst.inc