Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Architecture - Resource Layer & State Machine #5489

Merged
merged 2 commits into from
Jul 12, 2016

Conversation

CoderMaggie
Copy link
Member

Q A
Doc fix? yes
New docs? yes
BC breaks? no
Related tickets partially #5275
License MIT

@pjedrzejewski pjedrzejewski added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label Jul 11, 2016
@@ -17,6 +17,11 @@ Resource Layer
We created an abstraction on top of Doctrine, in order to have a consistent and flexible way to manage all the resources. By "resource" we understand every model in the application.
Simplest examples of Sylius resources are "product", "order", "tax_category", "promotion", "user", "shipping_method" and so on...

There are two types of resources in **Sylius**:

* registered by default - their names begin with ``sylius_*`` for example: ``sylius_product``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, aliases are sylius.product, we use dots to separate application name from the resource name.

@CoderMaggie CoderMaggie force-pushed the docs/resource-state-machine branch from ebcae9e to 8777bd3 Compare July 12, 2016 11:36
@pjedrzejewski pjedrzejewski merged commit 7c2fc19 into Sylius:master Jul 12, 2016
@pjedrzejewski
Copy link
Member

Thank you Magda!

There are two types of resources in **Sylius**:

* registered by default - their names begin with ``sylius.*`` for example: ``sylius.product``
* custom resources, from your application which have a separate convention. We place them under ``sylius_resource:`` ``resource_name:`` in the ``config.yml``. For these we reccomend using the naming convenion of ``app.*`` for instance ``app.my_entity``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reccomend -> recommend

@CoderMaggie CoderMaggie deleted the docs/resource-state-machine branch October 4, 2016 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants