From ff9c1d8e78d8914eff7f92ec12ef94bd30a32899 Mon Sep 17 00:00:00 2001 From: Magdalena Sadowska Date: Wed, 17 Jul 2019 11:03:23 +0200 Subject: [PATCH] [Docs] Move Plugins section to the Book --- docs/book/index.rst | 14 +++++++++++++- docs/book/map.rst.inc | 1 + docs/book/orders/payments.rst | 2 +- docs/{ => book}/plugins/approved-plugins.rst | 4 ++-- docs/{ => book}/plugins/creating-plugin.rst | 6 ++++++ docs/{ => book}/plugins/index.rst | 2 +- docs/book/plugins/map.rst.inc | 4 ++++ docs/{ => book}/plugins/official-plugins.rst | 2 +- docs/cookbook/shop/cms.rst | 2 +- docs/customization/plugins.rst.inc | 2 +- docs/customization/template.rst | 2 +- .../plugin-installation.rst | 4 ++-- docs/getting-started-with-sylius/summary.rst | 2 +- docs/index.rst | 12 ------------ docs/plugin-development-guide/index.rst | 2 +- docs/plugin-development-guide/specification.rst | 2 +- docs/plugins/map.rst.inc | 3 --- 17 files changed, 37 insertions(+), 29 deletions(-) rename docs/{ => book}/plugins/approved-plugins.rst (94%) rename docs/{ => book}/plugins/creating-plugin.rst (97%) rename docs/{ => book}/plugins/index.rst (95%) create mode 100644 docs/book/plugins/map.rst.inc rename docs/{ => book}/plugins/official-plugins.rst (95%) delete mode 100644 docs/plugins/map.rst.inc diff --git a/docs/book/index.rst b/docs/book/index.rst index e18919df387..2c75e5ad83b 100644 --- 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 \ No newline at end of file +.. 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 index 60e792b1cb7..0924211abc2 100644 --- 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 index 3ef443fb32b..91143102807 100644 --- 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 `_. 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 `. +use our guide on :doc:`extension development `. .. tip:: diff --git a/docs/plugins/approved-plugins.rst b/docs/book/plugins/approved-plugins.rst similarity index 94% rename from docs/plugins/approved-plugins.rst rename to docs/book/plugins/approved-plugins.rst index 3a1758e15c0..70e503f1903 100644 --- a/docs/plugins/approved-plugins.rst +++ b/docs/book/plugins/approved-plugins.rst @@ -8,7 +8,7 @@ on our website `_. 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 `. +**1.** Develop the plugin using :doc:`the official Plugin Development guide `. **2.** Remember about the tests and code quality! diff --git a/docs/plugins/creating-plugin.rst b/docs/book/plugins/creating-plugin.rst similarity index 97% rename from docs/plugins/creating-plugin.rst rename to docs/book/plugins/creating-plugin.rst index cde46239a74..b727d060983 100644 --- a/docs/plugins/creating-plugin.rst +++ b/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 `_, 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 b/docs/book/plugins/index.rst similarity index 95% rename from docs/plugins/index.rst rename to docs/book/plugins/index.rst index da281458c38..92782f330b1 100644 --- a/docs/plugins/index.rst +++ b/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 new file mode 100644 index 00000000000..98c5415b640 --- /dev/null +++ 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 b/docs/book/plugins/official-plugins.rst similarity index 95% rename from docs/plugins/official-plugins.rst rename to docs/book/plugins/official-plugins.rst index 1be67789c0e..7ff64c7b2a2 100644 --- a/docs/plugins/official-plugins.rst +++ b/docs/book/plugins/official-plugins.rst @@ -6,7 +6,7 @@ developed by Sylius can be found in the `github organization ` +* :doc:`How to create a plugin for Sylius? ` * `BitBag plugins `_ * `FriendsOfSylius plugins `_ diff --git a/docs/customization/plugins.rst.inc b/docs/customization/plugins.rst.inc index d77c99dad6e..0ea22a68546 100644 --- 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 `! + All the customizations can be done either in your application directly or in :doc:`Plugins `! diff --git a/docs/customization/template.rst b/docs/customization/template.rst index dc084c4447a..cff5a156792 100644 --- 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 `. + when :doc:`creating Sylius Plugins `. 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 `. diff --git a/docs/getting-started-with-sylius/plugin-installation.rst b/docs/getting-started-with-sylius/plugin-installation.rst index d9dad16d6fa..df4d757101d 100644 --- 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 ` +* :doc:`Plugins ` * :doc:`Plugin development guide ` -* :doc:`Official plugins ` +* :doc:`Official plugins ` diff --git a/docs/getting-started-with-sylius/summary.rst b/docs/getting-started-with-sylius/summary.rst index eec7244636b..e3f20ac038c 100644 --- 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` -- if you want to share your work with the Community, check out the :doc:`Sylius Plugins` chapter +- if you want to share your work with the Community, check out the :doc:`Sylius Plugins` chapter And the most important - if you want to become a part of our collectivity, join our `Slack `_, `Forum `_ and follow `our repository `_ to be always up-to-date diff --git a/docs/index.rst b/docs/index.rst index bc70bc198a3..872118d4ece 100644 --- 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 index afb558a8535..d11724b7c5a 100644 --- 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 index 8169229a710..4011d574089 100644 --- 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`. +:doc:`have your plugin officially accepted`. .. attention:: diff --git a/docs/plugins/map.rst.inc b/docs/plugins/map.rst.inc deleted file mode 100644 index a544697f536..00000000000 --- a/docs/plugins/map.rst.inc +++ /dev/null @@ -1,3 +0,0 @@ -* :doc:`/plugins/creating-plugin` -* :doc:`/plugins/official-plugins` -* :doc:`/plugins/approved-plugins`