[Documentation] Rework Plugin Guide

This commit is contained in:
Magdalena Banasiak 2017-09-08 16:05:06 +02:00
parent c0098048b0
commit 9f7adbd621
5 changed files with 44 additions and 49 deletions

View file

@ -79,17 +79,18 @@ The Customization Guide
.. include:: /customization/map.rst.inc
The REST API Reference
----------------------
Sylius Plugins
--------------
:doc:`The API guide </api/index>` covers the REST API of Sylius platform.
The collection of Sylius Plugins together with the guide on Plugins development.
Remember that you can use all the :doc:`customization techniques </customization/index>` in Plugins.
.. toctree::
:hidden:
api/index
plugins/index
.. include:: /api/map.rst.inc
.. include:: /plugins/map.rst.inc
The Cookbook
------------
@ -103,6 +104,18 @@ The Cookbook
.. include:: /cookbook/map.rst.inc
The REST API Reference
----------------------
:doc:`The API guide </api/index>` covers the REST API of Sylius platform.
.. toctree::
:hidden:
api/index
.. include:: /api/map.rst.inc
The BDD Guide
-------------
@ -115,18 +128,6 @@ In :doc:`the BDD Guide </bdd/index>` you will learn how to write clean and reusa
.. include:: /bdd/map.rst.inc
Sylius Plugins
--------------
The collection of Sylius Plugins together with the guide on Plugins development.
.. toctree::
:hidden:
plugins/index
.. include:: /plugins/map.rst.inc
The Contribution Guide
----------------------

View file

@ -38,11 +38,16 @@ more meaningful one. Keep in mind that these changes also need to be done in ``t
4. Implement your awesome features.
-----------------------------------
Looking at existing Sylius plugins like `Lakion\SyliusCmsBundle <https://github.com/Lakion/SyliusCmsBundle>`_
or `Lakion\SyliusElasticSearchBundle <https://github.com/Lakion/SyliusElasticSearchBundle>`_ is
a great way to start developing your own plugins.
Looking at existing Sylius plugins like
Feel free to use `BDD <https://www.agilealliance.org/glossary/bdd/>`_ with `Behat`_, `phpspec`_ and `PhpUnit`_
* `Sylius/ShopAPIPlugin <https://github.com/Sylius/SyliusShopApiPlugin>`_
* `bitbag-commerce/PayUPlugin <https://github.com/Sylius/SyliusShopApiPlugin>`_
* `stefandoorn/sitemap-plugin <https://github.com/stefandoorn/sitemap-plugin>`_
* `bitbag-commerce/CmsPlugin <https://github.com/bitbag-commerce/CmsPlugin>`_
is a great way to start developing your own plugins.
You are strongly encouraged to use `BDD <https://www.agilealliance.org/glossary/bdd/>`_ with `Behat`_, `phpspec`_ and `PhpUnit`_
to ensure your plugin's extraordinary quality.
.. tip::

View file

@ -4,32 +4,37 @@ 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.
.. toctree::
:hidden:
The official list of plugins
----------------------------
creating-plugin
list
.. tip::
**The official list of Sylius Plugins is available on the Sylius website** `here <http://sylius.org/developers/store/plugins>`_.
What are the plugins for?
-------------------------
The plugins are Symfony Bundles that either modify or extend Sylius default behaviour, providing useful features that
The plugins either modify or extend Sylius default behaviour, providing useful features that
are built on top of the Sylius Core.
Exemplary features may be: Social media buttons, newsletter, wishlists etc.
Exemplary features may be: Social media buttons, newsletter, wishlists, payment gateways integrations etc.
Plugin Development Flow
-----------------------
How to make a Sylius Plugin official?
-------------------------------------
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>`.
**2.** Send it to the project maintainers. It can be via email to any member of the Sylius Core team, or `the official Sylius Slack <http://sylius.org/slack>`_.
**2.** Remember about the tests and code quality!
**3.** Wait for your Plugin to be featured in :doc:`the list of plugins </plugins/list>` here in the docs and on the Sylius website.
**3.** Send it to the project maintainers. It can be via email to any member of the Sylius Core team, or `the official Sylius Slack <http://sylius.org/slack>`_.
Learn more
----------
**4.** Wait for your Plugin to be featured `the list of plugins <http://sylius.org/developers/store/plugins>`_ on the Sylius website.
.. toctree::
:hidden:
creating-plugin
.. include:: /plugins/map.rst.inc

View file

@ -1,15 +0,0 @@
Sylius Plugins List
===================
.. note::
This section will grow whenever a new plugin will be provided by the Sylius open-source community!
The current list of Sylius Plugins presents as follows:
.. warning::
Following plugins have been developed before adopting the Plugins naming convention. They will be renamed in the nearest future.
* `Lakion\SyliusCmsBundle <https://github.com/Lakion/SyliusCmsBundle>`_
* `Lakion\SyliusElasticSearchBundle <https://github.com/Lakion/SyliusElasticSearchBundle>`_

View file

@ -1,2 +1 @@
* :doc:`/plugins/creating-plugin`
* :doc:`/plugins/list`