mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-14 09:02:12 +00:00
Merge pull request #8231 from lchrusciel/fix-docs
[HOTFIX] [Documentation] Fix links in documenation
This commit is contained in:
commit
31e91cb929
12 changed files with 15 additions and 55 deletions
|
|
@ -77,8 +77,8 @@ How to send an Email programmatically?
|
|||
--------------------------------------
|
||||
|
||||
For sending emails **Sylius** is using a dedicated service - **Sender**. Additionally we have **EmailManagers**
|
||||
for Order Confirmation(`OrderEmailManager <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Bundle/CoreBundle/EmailManager/OrderEmailManager.php>`_)
|
||||
and for Shipment Confirmation(`ShipmentEmailManager <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Bundle/CoreBundle/EmailManager/ShipmentEmailManager.php>`_).
|
||||
for Order Confirmation(`OrderEmailManager <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Bundle/ShopBundle/EmailManager/OrderEmailManager.php>`_)
|
||||
and for Shipment Confirmation(`ShipmentEmailManager <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Bundle/AdminBundle/EmailManager/ShipmentEmailManager.php>`_).
|
||||
|
||||
.. tip::
|
||||
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ PHP required modules and configuration
|
|||
|
||||
.. warning::
|
||||
|
||||
Use your local timezone, for example America/Los_Angeles or Europe/Berlin. See http://www.php.net/timezones for the list of all available timezones.
|
||||
Use your local timezone, for example America/Los_Angeles or Europe/Berlin. See http://php.net/manual/en/timezones.php for the list of all available timezones.
|
||||
|
||||
Database
|
||||
--------
|
||||
|
|
@ -78,7 +78,7 @@ Most of the application folders and files require only read access, but a few fo
|
|||
* var/logs
|
||||
* web/media
|
||||
|
||||
You can read how to set these permissions in the `Symfony - setting up permissions <http://symfony.com/doc/current/book/installation.html#book-installation-permissions>`_ section.
|
||||
You can read how to set these permissions in the `Symfony - setting up permissions <http://symfony.com/doc/current/setup/file_permissions.html>`_ section.
|
||||
|
||||
.. _`gd`: http://php.net/manual/en/book.fileinfo.php
|
||||
.. _`exif`: http://php.net/manual/en/book.exif.php
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ How to install Sylius using Vagrant?
|
|||
# etc/hosts
|
||||
10.0.0.200 sylius.dev www.sylius.dev
|
||||
|
||||
From now on you will be able to access running Sylius application at `<http://sylius.dev/app_dev.php>`_.
|
||||
From now on you will be able to access running Sylius application at ``http://sylius.dev/app_dev.php``.
|
||||
|
||||
.. _Composer: http://packagist.org
|
||||
.. _`Composer installed globally`: http://getcomposer.org/doc/00-intro.md#globally
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ and of course flush your order after that via the manager.
|
|||
|
||||
**What happens during the transition?**
|
||||
|
||||
The method ``process($order)`` of the `CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Core/OrderProcessing/CompositeOrderProcessor.php>`_ is run.
|
||||
The method ``process($order)`` of the `CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Order/Processor/CompositeOrderProcessor.php>`_ is run.
|
||||
|
||||
Selecting shipping
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -163,7 +163,7 @@ and apply a proper transition and flush the order via the manager.
|
|||
|
||||
**What happens during the transition?**
|
||||
|
||||
The method ``process($order)`` of the `CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Core/OrderProcessing/CompositeOrderProcessor.php>`_ is run.
|
||||
The method ``process($order)`` of the `CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Order/Processor/CompositeOrderProcessor.php>`_ is run.
|
||||
Here this method is responsible for: controlling the **shipping charges** which depend on the chosen ShippingMethod,
|
||||
controlling the **promotions** that depend on the shipping method.
|
||||
|
||||
|
|
@ -224,11 +224,8 @@ and apply a proper transition and flush the order via the manager.
|
|||
**What happens during the transition?**
|
||||
|
||||
The method ``process($order)`` of the
|
||||
`CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Core/OrderProcessing/CompositeOrderProcessor.php>`_
|
||||
`CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Order/Processor/CompositeOrderProcessor.php>`_
|
||||
is run and checks all the adjustments on the order.
|
||||
The method ``update($order)`` of the
|
||||
`OrderExchangeRateAndCurrencyUpdater <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Core/OrderProcessing/OrderExchangeRateAndCurrencyUpdater.php>`_ is run.
|
||||
Here this method is responsible for controlling the **exchangeRate** of the order's currency.
|
||||
|
||||
Finalizing
|
||||
~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ Promotion Coupon Generator
|
|||
--------------------------
|
||||
|
||||
Making up new codes might become difficult if you would like to prepare a lot of coupons at once. That is why Sylius
|
||||
provides a service that generates random codes for you - `CouponGenerator <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Promotion/Generator/CouponGenerator.php>`_.
|
||||
provides a service that generates random codes for you - `CouponGenerator <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Promotion/Generator/PromotionCouponGenerator.php>`_.
|
||||
In its **PromotionCouponGeneratorInstruction** you can define the amount of coupons that will be generated, length of their codes, expiration date and usage limit.
|
||||
|
||||
.. code-block:: php
|
||||
|
|
|
|||
|
|
@ -134,7 +134,7 @@ In the example below you can how to create a simple Fixed Discount action, that
|
|||
.. note::
|
||||
|
||||
All **Actions** are assigned to a Promotion and are executed while the Promotion is applied.
|
||||
This happens via the `CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Core/OrderProcessing/CompositeOrderProcessor.php>`_ service.
|
||||
This happens via the `CompositeOrderProcessor <https://github.com/Sylius/Sylius/blob/master/src/Sylius/Component/Order/Processor/CompositeOrderProcessor.php>`_ service.
|
||||
See details of **applying Promotions** below.
|
||||
|
||||
And finally after you have an **PromotionAction** and a **PromotionRule** assigned to the **Promotion** add it to the repository.
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ How to create a TaxRate programmatically?
|
|||
.. note::
|
||||
|
||||
Before creating a tax rate you need to know that you can have different tax zones, in order to apply correct taxes for customers coming from any country in the world.
|
||||
To understand how zones work, please refer to the `Zones <http://docs.sylius.org/en/latest/book/addresses.html#zones>`_ chapter of this book.
|
||||
To understand how zones work, please refer to the `Zones <http://docs.sylius.org/en/latest/book/customers/addresses/zones.html>`_ chapter of this book.
|
||||
|
||||
Use a factory to create a new, empty TaxRate. Provide a ``code``, a ``name``. Set the amount of charge in float.
|
||||
Then choose a calculator and zone (retrieved from the repository beforehand).
|
||||
|
|
@ -134,7 +134,7 @@ Since we are using the concept of :doc:`Channels </book/configuration/channels>`
|
|||
|
||||
.. note::
|
||||
|
||||
To understand how zones work, please refer to the `Zones <http://docs.sylius.org/en/latest/book/addresses.html#zones>`_ chapter of this book.
|
||||
To understand how zones work, please refer to the `Zones <http://docs.sylius.org/en/latest/book/customers/addresses/zones.html>`_ chapter of this book.
|
||||
|
||||
Applying Taxes
|
||||
--------------
|
||||
|
|
|
|||
|
|
@ -158,8 +158,8 @@ Once we have our class we can characterize it with attributes.
|
|||
Or you can just add all attributes needed using a class implementing
|
||||
Doctrine's `Collection`_ interface, e.g. the `ArrayCollection`_ class.
|
||||
|
||||
.. _Collection: http://www.doctrine-project.org/api/common/2.2/class-Doctrine.Common.Collections.Collection.html
|
||||
.. _ArrayCollection: http://www.doctrine-project.org/api/common/2.2/class-Doctrine.Common.Collections.ArrayCollection.html
|
||||
.. _Collection: http://www.doctrine-project.org/api/common/2.3/class-Doctrine.Common.Collections.Collection.html
|
||||
.. _ArrayCollection: http://www.doctrine-project.org/api/common/2.3/class-Doctrine.Common.Collections.ArrayCollection.html
|
||||
|
||||
.. warning::
|
||||
Beware! It's really important to set proper attribute storage type, which should reflect value type that is set in `AttributeValue`.
|
||||
|
|
|
|||
|
|
@ -21,6 +21,3 @@ The **ChannelContext** allows you to manage the currently used sale channel.
|
|||
$channelContext->setChannel($channel);
|
||||
|
||||
$channelContext->getChannel(); // will return the $channel object
|
||||
|
||||
.. note::
|
||||
This service implements :ref:`component_channel_context_channel-context-interface`.
|
||||
|
|
|
|||
|
|
@ -47,27 +47,3 @@ Service Interfaces
|
|||
------------------
|
||||
|
||||
.. _component_channel_context_channel-context-interface:
|
||||
|
||||
ChannelContextInterface
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This interface should be implemented by a service
|
||||
responsible for managing the currently used :ref:`component_channel_model_channel`.
|
||||
|
||||
.. note::
|
||||
For more detailed information go to `Sylius API ChannelContextInterface`_.
|
||||
|
||||
.. _Sylius API ChannelContextInterface: http://api.sylius.org/Sylius/Component/Channel/Model/ChannelContextInterface.html
|
||||
|
||||
.. _component_channel_repository_channel-repository-interface:
|
||||
|
||||
ChannelRepositoryInterface
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This interface should be implemented by repositories responsible
|
||||
for storing the :ref:`component_channel_model_channel` objects.
|
||||
|
||||
.. note::
|
||||
For more detailed information go to `Sylius API ChannelRepositoryInterface`_.
|
||||
|
||||
.. _Sylius API ChannelRepositoryInterface: http://api.sylius.org/Sylius/Component/Channel/Model/ChannelRepositoryInterface.html
|
||||
|
|
|
|||
|
|
@ -61,13 +61,3 @@ This interface is implemented by services responsible for creating collection of
|
|||
.. _Sylius API InventoryUnitFactoryInterface: http://api.sylius.org/Sylius/Component/Inventory/Factory/InventoryUnitFactoryInterface.html
|
||||
|
||||
.. _component_inventory_operator_inventory-operator-interface:
|
||||
|
||||
InventoryOperatorInterface
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This interface is implemented by services responsible for managing inventory units.
|
||||
|
||||
.. note::
|
||||
For more detailed information go to `Sylius API InventoryOperatorInterface`_.
|
||||
|
||||
.. _Sylius API InventoryOperatorInterface: http://api.sylius.org/Sylius/Component/Inventory/Operator/AvailabilityCheckerInterface.html
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Since Sylius is an open-source platform, there is a certain flow in order for th
|
|||
|
||||
**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 <https://slackinvite.me/to/sylius-devs>`_.
|
||||
**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>`_.
|
||||
|
||||
**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.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue