Skip to content

Commit 38efbe6

Browse files
loic425loic425
committed
[Docs][Resource] Warn about legacy section
1 parent e85bcd1 commit 38efbe6

File tree

12 files changed

+52
-0
lines changed

12 files changed

+52
-0
lines changed

‎docs/resource/legacy/configuration.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Configuring Your Resources
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
Now you need to configure your first resource. Let's assume you have a *Book* entity in your application and it has simple fields:
48

59
* id

‎docs/resource/legacy/create_resource.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Creating Resources
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
To display a form, handle its submission or to create a new resource via API,
48
you should use the **createAction** of your **app.controller.book** service.
59

‎docs/resource/legacy/delete_resource.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Deleting Resources
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
Deleting a resource is simple.
48

59
```yaml

‎docs/resource/legacy/forms.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Forms
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
Have you noticed how Sylius generates forms for you? Of course, for many use-cases you may want to create a custom form.
48

59
## Custom Resource Form

‎docs/resource/legacy/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
Legacy Resource Documentation
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
* [Configuring Your Resources](configuration.md)
48
* [Services](services.md)
59
* [Routing](routing.md)

‎docs/resource/legacy/index_resources.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Getting a Collection of Resources
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
7+
{% hint style="warning" %}
8+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
9+
{% endhint %}
10+
311
To get a paginated list of Books, we will use **indexAction** of our controller.
412
In the default scenario, it will return an instance of paginator, with a list of Books.
513

‎docs/resource/legacy/reference.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## Configuration Reference
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
```yaml
48
sylius_resource:
59
resources:

‎docs/resource/legacy/routing.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Routing
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
SyliusResourceBundle ships with a custom route loader that can save you some time.
48

59
## Generating Generic CRUD Routing

‎docs/resource/legacy/services.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Services
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
When you register an entity as a resource, several services are registered for you.
48
For the ``app.book`` resource, the following services are available:
59

‎docs/resource/legacy/show_resource.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Getting a Single Resource
22

3+
{% hint style="warning" %}
4+
This section is deprecated. However, as of now, the Sylius E-Commerce project is still resorting to this configuration so you might want to check it out.
5+
{% endhint %}
6+
37
Your newly created controller service supports basic CRUD operations and is configurable via routing.
48

59
The simplest action is **showAction**. It is used to display a single resource. To use it, the only thing you need to do is register a proper route.

0 commit comments

Comments
 (0)