refactor Sylius#11472 [Docs] Move plugins development guide to "The B…

…ook -> Plugins" (pamil) This PR was merged into the 1.8-dev branch. Discussion ---------- It has been moved so that the plugin-related documentation is all in a single place. Starting from this, we can refactor this guide accordingly. Commits ------- a8e429e [Docs] Move plugins development guide to "The Book -> Plugins"
Inventis · May 14, 2020 · af5a3a0 · af5a3a0
2 parents f4a4a5e + a8e429e
commit af5a3a0
Show file tree

Hide file tree

Showing 15 changed files with 22 additions and 27 deletions.
diff --git a/docs/book/orders/payments.rst b/docs/book/orders/payments.rst
@@ -135,7 +135,7 @@ Other Payment Gateways
     Learn more about integrating payment gateways in the :doc:`dedicated guide </cookbook/payments/custom-payment-gateway>` and 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 </plugin-development-guide/index>`.
+use our guide on :doc:`extension development </book/plugins/guide/index>`.
 
 Troubleshooting
 ---------------

diff --git a/docs/plugin-development-guide/idea.rst → docs/book/plugins/guide/idea.rst b/docs/plugin-development-guide/idea.rst → docs/book/plugins/guide/idea.rst
diff --git a/...ugin-development-guide/implementation.rst → docs/book/plugins/guide/implementation.rst b/...ugin-development-guide/implementation.rst → docs/book/plugins/guide/implementation.rst
diff --git a/docs/plugin-development-guide/index.rst → docs/book/plugins/guide/index.rst b/docs/plugin-development-guide/index.rst → docs/book/plugins/guide/index.rst
@@ -9,6 +9,7 @@ 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::
+   :hidden:
 
    idea
    installation
@@ -17,6 +18,8 @@ With respect to that rule, let's create some simple first plugin together!
    implementation
    summary
 
+.. include:: /book/plugins/guide/map.rst.inc
+
 .. seealso::
 
     :doc:`/book/plugins/index`

diff --git a/...plugin-development-guide/installation.rst → docs/book/plugins/guide/installation.rst b/...plugin-development-guide/installation.rst → docs/book/plugins/guide/installation.rst
diff --git a/docs/book/plugins/guide/map.rst.inc b/docs/book/plugins/guide/map.rst.inc
@@ -0,0 +1,6 @@
+* :doc:`/book/plugins/guide/idea`
+* :doc:`/book/plugins/guide/installation`
+* :doc:`/book/plugins/guide/naming`
+* :doc:`/book/plugins/guide/specification`
+* :doc:`/book/plugins/guide/implementation`
+* :doc:`/book/plugins/guide/summary`
diff --git a/docs/plugin-development-guide/naming.rst → docs/book/plugins/guide/naming.rst b/docs/plugin-development-guide/naming.rst → docs/book/plugins/guide/naming.rst
diff --git a/...lugin-development-guide/specification.rst → docs/book/plugins/guide/specification.rst b/...lugin-development-guide/specification.rst → docs/book/plugins/guide/specification.rst
diff --git a/docs/plugin-development-guide/summary.rst → docs/book/plugins/guide/summary.rst b/docs/plugin-development-guide/summary.rst → docs/book/plugins/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/book/plugins/index.rst b/docs/book/plugins/index.rst
@@ -4,7 +4,6 @@ Sylius Plugins
 Sylius as a platform has a lot of space for various customizations and extensions. It aims to provide a simple schema for
 developing plugins. Anything you can imagine can be implemented and added to the Sylius framework as a plugin.
 
-
 What are the plugins for?
 -------------------------
 
@@ -21,6 +20,7 @@ Exemplary features may be: Social media buttons, newsletter, wishlists, payment
     :hidden:
 
     creating-plugin
+    guide/index
     official-plugins
     sylius-store
 

diff --git a/docs/book/plugins/map.rst.inc b/docs/book/plugins/map.rst.inc
@@ -1,4 +1,4 @@
-* :doc:`/book/plugins/index`
 * :doc:`/book/plugins/creating-plugin`
+* :doc:`/book/plugins/guide/index`
 * :doc:`/book/plugins/official-plugins`
 * :doc:`/book/plugins/sylius-store`
diff --git 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 </book/plugins/index>`
-* :doc:`Plugin development guide </plugin-development-guide/index>`
+* :doc:`Plugin development guide </book/plugins/guide/index>`
 * :doc:`Official plugins </book/plugins/official-plugins>`
diff --git a/docs/index.rst b/docs/index.rst
@@ -73,20 +73,6 @@ Theming Guide
 
 .. include:: /theming/map.rst.inc
 
-Plugin Development Guide
-------------------------
-
-If you're wondering how to share awesome features you have/want to have for Sylius with the Open Source community,
-here you will find a comprehensive guide to plugins development from the idea to sharing the plugin with the world.
-Remember that you can use all the :doc:`customization techniques </customization/index>` in Plugins.
-
-.. toctree::
-   :hidden:
-
-   plugin-development-guide/index
-
-.. include:: /plugin-development-guide/map.rst.inc
-
 The Cookbook
 ------------
 

diff --git a/docs/plugin-development-guide/map.rst.inc b/docs/plugin-development-guide/map.rst.inc
diff --git a/docs/redirection_map b/docs/redirection_map
@@ -82,5 +82,12 @@ contributing/organization/core-team.rst book/organization/team.rst
 contributing/organization/index.rst book/organization/index.rst
 contributing/organization/release-process.rst book/organization/release-cycle.rst
 contributing/organization/vision-and-strategy.rst book/organization/index.rst
-contributing/translations/index.rst book/contributing/translations/index.rst
 contributing/support/index.rst book/contributing/support/index.rst
+contributing/translations/index.rst book/contributing/translations/index.rst
+plugin-development-guide/idea.rst book/plugins/guide/idea.rst
+plugin-development-guide/implementation.rst book/plugins/guide/implementation.rst
+plugin-development-guide/index.rst book/plugins/guide/index.rst
+plugin-development-guide/installation.rst book/plugins/guide/installation.rst
+plugin-development-guide/naming.rst book/plugins/guide/naming.rst
+plugin-development-guide/specification.rst book/plugins/guide/specification.rst
+plugin-development-guide/summary.rst book/plugins/guide/summary.rst