From fb4bdb1eb9bd5466581cee42c339ab2d59a2c550 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Fr=C3=A9mont?= Date: Tue, 10 Dec 2024 15:13:43 +0100 Subject: [PATCH 1/4] [Docs] Move legacy resource documentation into a legacy dir --- docs/SUMMARY.md | 33 +++++++++---------- docs/resource/index.md | 14 ++------ docs/resource/{ => legacy}/configuration.md | 0 docs/resource/{ => legacy}/create_resource.md | 0 docs/resource/{ => legacy}/delete_resource.md | 0 docs/resource/{ => legacy}/forms.md | 0 docs/resource/legacy/index.md | 13 ++++++++ docs/resource/{ => legacy}/index_resources.md | 0 docs/resource/{ => legacy}/reference.md | 0 docs/resource/{ => legacy}/routing.md | 0 docs/resource/{ => legacy}/services.md | 0 docs/resource/{ => legacy}/show_resource.md | 0 docs/resource/{ => legacy}/state_machine.md | 0 docs/resource/{ => legacy}/update_resource.md | 0 14 files changed, 31 insertions(+), 29 deletions(-) rename docs/resource/{ => legacy}/configuration.md (100%) rename docs/resource/{ => legacy}/create_resource.md (100%) rename docs/resource/{ => legacy}/delete_resource.md (100%) rename docs/resource/{ => legacy}/forms.md (100%) create mode 100644 docs/resource/legacy/index.md rename docs/resource/{ => legacy}/index_resources.md (100%) rename docs/resource/{ => legacy}/reference.md (100%) rename docs/resource/{ => legacy}/routing.md (100%) rename docs/resource/{ => legacy}/services.md (100%) rename docs/resource/{ => legacy}/show_resource.md (100%) rename docs/resource/{ => legacy}/state_machine.md (100%) rename docs/resource/{ => legacy}/update_resource.md (100%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index b4263194..88b3b9ac 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -18,27 +18,26 @@ ## Resource * [Resource Bundle documentation](resource/index.md) - * [Configuration](resource/configuration.md) - * [Configure your operations](resource/configure_your_operations.md) - * [Configure your resource](resource/configure_your_resource.md) * [Create new resource](resource/create_new_resource.md) - * [Create resource](resource/create_resource.md) - * [Delete resource](resource/delete_resource.md) - * [Forms](resource/forms.md) - * [Index resources](resource/index_resources.md) - * [Installation](resource/installation.md) - * [Processors](resource/processors.md) - * [Providers](resource/providers.md) + * [Configure your resource](resource/configure_your_resource.md) + * [Configure your operations](resource/configure_your_operations.md) + * [Validation](resource/validation.md) * [Redirect](resource/redirect.md) - * [Reference](resource/reference.md) * [Resource factories](resource/resource_factories.md) + * [Providers](resource/providers.md) + * [Processors](resource/processors.md) * [Responders](resource/responders.md) - * [Routing](resource/routing.md) - * [Services](resource/services.md) - * [Show resource](resource/show_resource.md) - * [State machine](resource/state_machine.md) - * [Update resource](resource/update_resource.md) - * [Validation](resource/validation.md) + * [Legacy Resource Documentation](resource/legacy/index.md) + * [Configuration](resource/legacy/configuration.md) + * [Services](resource/legacy/services.md) + * [Routing](resource/legacy/routing.md) + * [Forms](resource/legacy/forms.md) + * [Getting a Collection of Resources](resource/legacy/index_resources.md) + * [Creating Resources](resource/legacy/create_resource.md) + * [Updating Resources](resource/legacy/update_resource.md) + * [Deleting Resources](resource/legacy/delete_resource.md) + * [Configuring a state machine](resource/legacy/state_machine.md) + * [Configuration Reference](resource/legacy/reference.md) ## Grid diff --git a/docs/resource/index.md b/docs/resource/index.md index 1c615e84..d0accdee 100644 --- a/docs/resource/index.md +++ b/docs/resource/index.md @@ -30,18 +30,8 @@ So far we support: * [Responders](responders.md) # Deprecated documentation -* [Configuring Your Resources](configuration.md) -* [Services](services.md) -* [Routing](routing.md) -* [Forms](forms.md) -* [Getting a Single Resource](show_resource.md) -* [Getting a Collection of Resources](index_resources.md) -* [Creating Resources](create_resource.md) -* [Updating Resources](update_resource.md) -* [Deleting Resources](delete_resource.md) -* [Configuring a state machine](state_machine.md) -* [Configuration Reference](reference.md) +* [Legacy Resource Documentation](legacy/index.md) ## Learn more -* [Resource Layer in the Sylius platform](https://docs.sylius.com/en/latest/book/architecture/resource_layer.html) - concept documentation +* [Resource Layer in the Sylius platform](https://docs.sylius.com/the-book/architecture/resource-layer) - concept documentation diff --git a/docs/resource/configuration.md b/docs/resource/legacy/configuration.md similarity index 100% rename from docs/resource/configuration.md rename to docs/resource/legacy/configuration.md diff --git a/docs/resource/create_resource.md b/docs/resource/legacy/create_resource.md similarity index 100% rename from docs/resource/create_resource.md rename to docs/resource/legacy/create_resource.md diff --git a/docs/resource/delete_resource.md b/docs/resource/legacy/delete_resource.md similarity index 100% rename from docs/resource/delete_resource.md rename to docs/resource/legacy/delete_resource.md diff --git a/docs/resource/forms.md b/docs/resource/legacy/forms.md similarity index 100% rename from docs/resource/forms.md rename to docs/resource/legacy/forms.md diff --git a/docs/resource/legacy/index.md b/docs/resource/legacy/index.md new file mode 100644 index 00000000..39b999c6 --- /dev/null +++ b/docs/resource/legacy/index.md @@ -0,0 +1,13 @@ +Legacy Resource Documentation + +* [Configuring Your Resources](configuration.md) +* [Services](services.md) +* [Routing](routing.md) +* [Forms](forms.md) +* [Getting a Single Resource](show_resource.md) +* [Getting a Collection of Resources](index_resources.md) +* [Creating Resources](create_resource.md) +* [Updating Resources](update_resource.md) +* [Deleting Resources](delete_resource.md) +* [Configuring a state machine](state_machine.md) +* [Configuration Reference](reference.md) diff --git a/docs/resource/index_resources.md b/docs/resource/legacy/index_resources.md similarity index 100% rename from docs/resource/index_resources.md rename to docs/resource/legacy/index_resources.md diff --git a/docs/resource/reference.md b/docs/resource/legacy/reference.md similarity index 100% rename from docs/resource/reference.md rename to docs/resource/legacy/reference.md diff --git a/docs/resource/routing.md b/docs/resource/legacy/routing.md similarity index 100% rename from docs/resource/routing.md rename to docs/resource/legacy/routing.md diff --git a/docs/resource/services.md b/docs/resource/legacy/services.md similarity index 100% rename from docs/resource/services.md rename to docs/resource/legacy/services.md diff --git a/docs/resource/show_resource.md b/docs/resource/legacy/show_resource.md similarity index 100% rename from docs/resource/show_resource.md rename to docs/resource/legacy/show_resource.md diff --git a/docs/resource/state_machine.md b/docs/resource/legacy/state_machine.md similarity index 100% rename from docs/resource/state_machine.md rename to docs/resource/legacy/state_machine.md diff --git a/docs/resource/update_resource.md b/docs/resource/legacy/update_resource.md similarity index 100% rename from docs/resource/update_resource.md rename to docs/resource/legacy/update_resource.md From 0bf9e2a8b5c157bcd0189206e30d7c8822a16e95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Fr=C3=A9mont?= Date: Wed, 11 Dec 2024 08:09:27 +0100 Subject: [PATCH 2/4] Update docs/SUMMARY.md Co-authored-by: Dmitri Perunov --- docs/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 88b3b9ac..b0e74083 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -32,6 +32,7 @@ * [Services](resource/legacy/services.md) * [Routing](resource/legacy/routing.md) * [Forms](resource/legacy/forms.md) + * [Getting a Single Resource](resource/legacy/show_resource.md) * [Getting a Collection of Resources](resource/legacy/index_resources.md) * [Creating Resources](resource/legacy/create_resource.md) * [Updating Resources](resource/legacy/update_resource.md) From d12fcd4e0bf3887ebe0e950f121d87dc334ea5be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Fr=C3=A9mont?= Date: Thu, 12 Dec 2024 09:12:03 +0100 Subject: [PATCH 3/4] Add missing installation chapter on menu --- docs/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index b0e74083..9b4f878c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -18,6 +18,7 @@ ## Resource * [Resource Bundle documentation](resource/index.md) + * [Installation](resource/installation.md) * [Create new resource](resource/create_new_resource.md) * [Configure your resource](resource/configure_your_resource.md) * [Configure your operations](resource/configure_your_operations.md) From f81a4c9daa339ccb9cc75225f0190ef0122c6d58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Fr=C3=A9mont?= Date: Thu, 12 Dec 2024 09:18:35 +0100 Subject: [PATCH 4/4] [CI] Add docs directory on paths ignore --- .github/workflows/ci.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 5e833f12..b3daee7e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -3,6 +3,7 @@ name: Continuous Integration on: pull_request: paths-ignore: + - "docs/**" - "*.md" workflow_dispatch: ~ workflow_call: ~