kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[Documentation] Fix stuff after reorganization

Browse source
This commit is contained in:
Magdalena Banasiak 2017-11-07 13:41:02 +01:00
parent 728d43afcf
commit c1ec98c2bc
16 changed files with 26 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/introduction.rst
View file

@ -12,4 +12,4 @@ This part of the documentation is about RESTful JSON/XML API for the Sylius plat
.. tip::
We strongly recommend starting with our basic guide to Sylius API in the Cookbook: ":doc:`How to use Sylius API? </cookbook/api>`".
We strongly recommend starting with our basic guide to Sylius API in the Cookbook: ":doc:`How to use Sylius API? </cookbook/api/api>`".

2
docs/book/architecture/emails.rst
View file

@ -6,7 +6,7 @@ E-Mails
Sylius is sending various e-mails and this chapter is a reference about all of them. Continue reading to learn what e-mails are sent, when and how to customize the templates.
To understand how e-mail sending works internally, please refer to :doc:`SyliusMailerBundle documentation </components_and_bundles/bundles/SyliusMailerBundle/index>`.
And to learn more about mailer services configuration, read :doc:`the dedicated cookbook </cookbook/mailer>`.
And to learn more about mailer services configuration, read :doc:`the dedicated cookbook </cookbook/emails/mailer>`.
User Confirmation
-----------------

4
docs/book/orders/promotions.rst
View file

@ -221,5 +221,5 @@ Learn more
* :doc:`Promotion - Component Documentation </components_and_bundles/components/Promotion/index>`
* :doc:`Promotion - Bundle Documentation </components_and_bundles/bundles/SyliusPromotionBundle/index>`
* :doc:`How to create a custom promotion rule? </cookbook/custom-promotion-rule>`
* :doc:`How to create a custom promotion action? </cookbook/custom-promotion-action>`
* :doc:`How to create a custom promotion rule? </cookbook/promotions/custom-promotion-rule>`
* :doc:`How to create a custom promotion action? </cookbook/promotions/custom-promotion-action>`

4
docs/components_and_bundles/bundles/SyliusResourceBundle/configuration.rst
View file

@ -11,7 +11,7 @@ Now you need to configure your first resource. Let's assume you have a *Book* en
.. tip::
You can see a full exemplary configuration of a typical resource
:doc:`here, in the "How to add a custom model?" cookbook </cookbook/custom-model>`.
:doc:`here, in the "How to add a custom model?" cookbook </cookbook/entities/custom-model>`.
Implement the ResourceInterface in your model class.
----------------------------------------------------
@ -78,7 +78,7 @@ Generate API routing.
.. tip::
Learn more about using Sylius REST API in these articles:
:doc:`REST API Reference </api/index>`, :doc:`How to use Sylius API? - Cookbook </cookbook/api>`.
:doc:`REST API Reference </api/index>`, :doc:`How to use Sylius API? - Cookbook </cookbook/api/api>`.
Add the following lines to ``app/config/routing.yml``:

2
docs/cookbook/api/api.rst
View file

@ -49,7 +49,7 @@ This will give you such a response:
Creating a new resource instance via API
----------------------------------------
Use the ``access_token`` in the request that will create a new Supplier (:doc:`that we were creating in another cookbook</cookbook/custom-model>`).
Use the ``access_token`` in the request that will create a new Supplier (:doc:`that we were creating in another cookbook</cookbook/entities/custom-model>`).
.. code-block:: bash

10
docs/cookbook/deployment/cloudways.rst
View file

@ -14,7 +14,7 @@ Now to install Sylius you need to go through series of few steps:
You should `signup at Cloudways <https://platform.cloudways.com/signup>`_ to buy the PHP servers from the above mentioned providers. Simply go to the pricing page and choose your required plan.
You then need to go through the verification process. Once it done login to platform and launch your first Custom PHP application. You can follow the Gif too.
.. image:: ../_images/cloudways-php-server.gif
.. image:: ../../_images/cloudways-php-server.gif
:align: center
Now let’s start the process of installing Sylius on Cloudways.
@ -25,7 +25,7 @@ Now let’s start the process of installing Sylius on Cloudways.
Open the SSH terminal from the **Server Management tab**. You can also use PuTTY for this purpose. Find the SSH credentials under
the **Master Credentials** heading and login to the SSH terminal:
.. image:: ../_images/cloudways-ssh.png
.. image:: ../../_images/cloudways-ssh.png
:align: center
After the login, move to the application folder using the ``cd`` command and run the following command to start installing Sylius:
@ -37,12 +37,12 @@ After the login, move to the application folder using the ``cd`` command and run
The command will start installing the long list of dependencies for Sylius. Once the installation finishes, Sylius will ask for the database credentials.
You can find the database username and password in the Application Access Details.
.. image:: ../_images/cloudways-database.png
.. image:: ../../_images/cloudways-database.png
:align: center
Enter the database details in the SSH terminal:
.. image:: ../_images/cloudways-sylius-database.png
.. image:: ../../_images/cloudways-sylius-database.png
:align: center
Keep the rest of the values to default so that the config file will have the defaults Sylius settings.
@ -70,7 +70,7 @@ Now run the following command:
Finally, the last step is to update the webroot of the application in the Platform. Move to the **Application Settings** tab and update it.
.. image:: ../_images/cloudways-sylius-webroot.png
.. image:: ../../_images/cloudways-sylius-webroot.png
:align: center
Now open the application URL as shown in the Access Details tab.

2
docs/cookbook/deployment/platform-sh.rst
View file

@ -252,7 +252,7 @@ When you get connected please run:
7. Dive deeper
--------------
Learn some more specific topics related to Sylius & Symfony on our :doc:`Advanced Platform.sh Cookbook </cookbook/platform-sh-advanced>`
Learn some more specific topics related to Sylius & Symfony on our :doc:`Advanced Platform.sh Cookbook </cookbook/deployment/platform-sh-advanced>`
Learn more
----------

6
docs/cookbook/entities/custom-model.rst
View file

@ -29,7 +29,7 @@ You need to use such a command in your project directory.
The generator will ask you for the entity name and fields. See how it should look like to match our assumptions.
.. image:: ../_images/generating_entity.png
.. image:: ../../_images/generating_entity.png
:align: center
3. Update the database using migrations
@ -97,13 +97,13 @@ To check if the process was run correctly run such a command:
The output should be:
.. image:: ../_images/container_debug_supplier.png
.. image:: ../../_images/container_debug_supplier.png
:align: center
6. Optionally try to use Sylius API to create new resource
----------------------------------------------------------
See how to work with API in :doc:`the separate cookbook here </cookbook/api>`.
See how to work with API in :doc:`the separate cookbook here </cookbook/api/api>`.
.. note::

8
docs/cookbook/entities/custom-translatable-model.rst
View file

@ -1,7 +1,7 @@
How to add a custom translatable model?
=======================================
In this guide we will create a new translatable model in our system, which is quite similar to :doc:`adding a simple model </cookbook/custom-model>`,
In this guide we will create a new translatable model in our system, which is quite similar to :doc:`adding a simple model </cookbook/entities/custom-model>`,
although it requires some additional steps.
As an example we will take a **translatable Supplier entity**, which may be really useful for shop maintenance.
@ -30,7 +30,7 @@ You need to use such a command in your project directory.
The generator will ask you for the entity name and fields. See how it should look like to match our assumptions.
.. image:: ../_images/generating_translation_entity.png
.. image:: ../../_images/generating_translation_entity.png
:align: center
As you can see we have provided only the desired translatable fields.
@ -110,7 +110,7 @@ Below the final ``SupplierTranslation`` class is presented, it implements the ``
While generating the entity, similarly to the way the translation was generated, we are providing only non-translatable fields.
In our case only the ``enabled`` field.
.. image:: ../_images/generating_basic_entity.png
.. image:: ../../_images/generating_basic_entity.png
:align: center
Having the stubs generated, we need to extend our class with a connection to SupplierTranslation.
@ -270,7 +270,7 @@ To check if the process was run correctly run such a command:
The output should be:
.. image:: ../_images/container_debug_supplier_translation.png
.. image:: ../../_images/container_debug_supplier_translation.png
:align: center
6. Prepare new forms for your entity, that will be aware of its translation

1
docs/cookbook/index.rst
View file

@ -120,4 +120,3 @@ Frontend
frontend/admin-js-and-css
.. include:: /cookbook/frontend/map.rst.inc

4
docs/cookbook/payments/paypal.rst
View file

@ -14,7 +14,7 @@ Add a payment method with the Paypal Expresss gateway in the Admin Panel
Go to the ``http://localhost:8000/admin/payment-methods/new/paypal_express_checkout`` url.
.. image:: ../_images/paypal_express_create.png
.. image:: ../../_images/paypal_express_create.png
:align: center
* Fill in the Paypal configuration form with your developer account data (``username``, ``password`` and ``signature``).
@ -25,7 +25,7 @@ Choosing Paypal Express method in Checkout
From now on Paypal Express will be available in Checkout in the channel you have created it for.
.. image:: ../_images/paypal_express_checkout.png
.. image:: ../../_images/paypal_express_checkout.png
:align: center
**Done!**

2
docs/cookbook/payments/stripe.rst
View file

@ -28,7 +28,7 @@ Go to the ``http://localhost:8000/admin/payment-methods/new/stripe_checkout`` ur
.. tip::
If your are not sure how to do it check how we do it :doc:`for Paypal in this cookbook </cookbook/paypal>`.
If your are not sure how to do it check how we do it :doc:`for Paypal in this cookbook </cookbook/payments/paypal>`.
Choosing Stripe Credit Card method in Checkout
----------------------------------------------

2
docs/cookbook/shop/taxons-menu.rst
View file

@ -8,7 +8,7 @@ How does it look like?
That's a menu that you will find on the default Sylius homepage:
.. image:: ../_images/taxons_menu.png
.. image:: ../../_images/taxons_menu.png
:align: center
How to do it?

2
docs/customization/state_machine.rst
View file

@ -80,7 +80,7 @@ How to remove a state and its transitions?
.. warning::
If you are willing to remove a state or a transition you have to override **the whole states/transitions section**
of the state machine you are willing to modify. See how we do it in the :doc:`customization of the Checkout process </cookbook/checkout>`.
of the state machine you are willing to modify. See how we do it in the :doc:`customization of the Checkout process </cookbook/shop/checkout>`.
How to add a new callback?
~~~~~~~~~~~~~~~~~~~~~~~~~~

2
docs/customization/template.rst
View file

@ -199,7 +199,7 @@ That's it. Your new block should appear in the view.
.. tip::
Learn more about adding custom Admin JS & CSS in the cookbook :doc:`here </cookbook/admin-js-and-css>`.
Learn more about adding custom Admin JS & CSS in the cookbook :doc:`here </cookbook/frontend/admin-js-and-css>`.
How to use themes for customizations?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

4
docs/index.rst
View file

@ -102,8 +102,6 @@ The Cookbook
cookbook/index
.. include:: /cookbook/map.rst.inc
The REST API Reference
----------------------
@ -150,8 +148,6 @@ Support
support/index
.. include:: /support/map.rst.inc
Components & Bundles
--------------------