From 4ac723557f378f6df71736fb30e5dcbacf4faa45 Mon Sep 17 00:00:00 2001 From: David Debreczeni Date: Fri, 20 Dec 2024 00:18:26 +0100 Subject: [PATCH] Mention dual-admin transitory peroid to avoid onboarding confusion --- docs/customization/customizing-the-backend.mdx | 16 ++++++++++++++++ .../customization/customizing-the-backend.mdx | 16 ++++++++++++++++ .../customization/customizing-the-backend.mdx | 16 ++++++++++++++++ 3 files changed, 48 insertions(+) diff --git a/docs/customization/customizing-the-backend.mdx b/docs/customization/customizing-the-backend.mdx index bc1d2f6..ebf81a7 100644 --- a/docs/customization/customizing-the-backend.mdx +++ b/docs/customization/customizing-the-backend.mdx @@ -7,6 +7,22 @@ needs-diataxis-rewrite: true This guide will teach you how to customize the Solidus admin panel. +## Transitioning from Spree::Admin to SolidusAdmin + +Please note that currently there are two different admin engines running in parallel: + +1. `solidus_backend` as required by default from the `solidus` gem, under the namespace `Spree::Admin` +2. `solidus_admin` as installed by default for new stores since solidus v4.3 and uses the namespace `SolidusAdmin` + +SolidusAdmin routes have preference over Spree::admin if the following conditions are met: + +1. The `Show Legacy UI` button is switched off at the bottom of the admin sidebar +2. The resource's action is implemented in SolidusAdmin +3. The routes are drawn and not excluded by the `SolidusAdmin::Config['enable_alpha_features']` flag + +During this transitory period make sure you follow instructions that matches the actual admin engine being +used for the particular resource. + ## Designing your feature When adding a feature to the backend UI, it's important that you spend some time designing the ideal diff --git a/versioned_docs/version-4.3/customization/customizing-the-backend.mdx b/versioned_docs/version-4.3/customization/customizing-the-backend.mdx index bc1d2f6..ebf81a7 100644 --- a/versioned_docs/version-4.3/customization/customizing-the-backend.mdx +++ b/versioned_docs/version-4.3/customization/customizing-the-backend.mdx @@ -7,6 +7,22 @@ needs-diataxis-rewrite: true This guide will teach you how to customize the Solidus admin panel. +## Transitioning from Spree::Admin to SolidusAdmin + +Please note that currently there are two different admin engines running in parallel: + +1. `solidus_backend` as required by default from the `solidus` gem, under the namespace `Spree::Admin` +2. `solidus_admin` as installed by default for new stores since solidus v4.3 and uses the namespace `SolidusAdmin` + +SolidusAdmin routes have preference over Spree::admin if the following conditions are met: + +1. The `Show Legacy UI` button is switched off at the bottom of the admin sidebar +2. The resource's action is implemented in SolidusAdmin +3. The routes are drawn and not excluded by the `SolidusAdmin::Config['enable_alpha_features']` flag + +During this transitory period make sure you follow instructions that matches the actual admin engine being +used for the particular resource. + ## Designing your feature When adding a feature to the backend UI, it's important that you spend some time designing the ideal diff --git a/versioned_docs/version-4.4/customization/customizing-the-backend.mdx b/versioned_docs/version-4.4/customization/customizing-the-backend.mdx index bc1d2f6..ebf81a7 100644 --- a/versioned_docs/version-4.4/customization/customizing-the-backend.mdx +++ b/versioned_docs/version-4.4/customization/customizing-the-backend.mdx @@ -7,6 +7,22 @@ needs-diataxis-rewrite: true This guide will teach you how to customize the Solidus admin panel. +## Transitioning from Spree::Admin to SolidusAdmin + +Please note that currently there are two different admin engines running in parallel: + +1. `solidus_backend` as required by default from the `solidus` gem, under the namespace `Spree::Admin` +2. `solidus_admin` as installed by default for new stores since solidus v4.3 and uses the namespace `SolidusAdmin` + +SolidusAdmin routes have preference over Spree::admin if the following conditions are met: + +1. The `Show Legacy UI` button is switched off at the bottom of the admin sidebar +2. The resource's action is implemented in SolidusAdmin +3. The routes are drawn and not excluded by the `SolidusAdmin::Config['enable_alpha_features']` flag + +During this transitory period make sure you follow instructions that matches the actual admin engine being +used for the particular resource. + ## Designing your feature When adding a feature to the backend UI, it's important that you spend some time designing the ideal