FRW-8550 Dynamic Multistore documentation. #2919
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
annakotiuk
reviewed
Nov 20, 2024
annakotiuk
reviewed
Nov 20, 2024
docs/pbc/all/dynamic-multistore/202410.0/base-shop/difference-between-modes.md
Outdated
Show resolved
Hide resolved
annakotiuk
reviewed
Nov 20, 2024
docs/pbc/all/dynamic-multistore/202410.0/base-shop/difference-between-modes.md
Outdated
Show resolved
Hide resolved
annakotiuk
reviewed
Nov 20, 2024
_includes/pbc/all/install-features/202410.0/enable-dynamic-multistore.md
Outdated
Show resolved
Hide resolved
_includes/pbc/all/install-features/202410.0/enable-dynamic-multistore.md
Outdated
Show resolved
Hide resolved
_includes/pbc/all/install-features/202410.0/enable-dynamic-multistore.md
Outdated
Show resolved
Hide resolved
_includes/pbc/all/install-features/202410.0/enable-dynamic-multistore.md
Outdated
Show resolved
Hide resolved
annakotiuk
previously approved these changes
Nov 21, 2024
dimitriyTsemma
added
TW review needed
| @@ -0,0 +1,173 @@ | |||
| --- | |||
| title: Difference in deployment files | |||
There was a problem hiding this comment.
In what context do I need to know these differences?
| @@ -0,0 +1,56 @@ | |||
| This document describes how to enable [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/dynamic-multistore-feature-overview.html) on the latest codebase. | |||
There was a problem hiding this comment.
What do you mean by the latest codebase?
| ### Here are the steps that needs to be performed to enable Dynamic Multistore. | ||
|
|
||
| {% info_block warningBox "Staging environment" %} | ||
| Make sure that **all** steps above are performed (and fully tested) on staging before applying it on production setup, to avoid unexpected downtime and data loss. |
There was a problem hiding this comment.
Perhaps you wanted to say "steps below"?
| {% endinfo_block %} | ||
|
|
||
|
|
||
| 1. Make sure that your custom Backoffice, MerchantPortal, Console Commands, Gateway, BackendAPI code do not use `StoreFacade::getCurrentStore()` as well as `StoreClient::getCurrentStore()` methods, they are no longer available in any other application except GlueStorefront and Storefront. |
There was a problem hiding this comment.
Suggested change
| 1. Make sure that your custom Backoffice, MerchantPortal, Console Commands, Gateway, BackendAPI code do not use `StoreFacade::getCurrentStore()` as well as `StoreClient::getCurrentStore()` methods, they are no longer available in any other application except GlueStorefront and Storefront. | |
| 1. `StoreFacade::getCurrentStore()` and `StoreClient::getCurrentStore()` methods are available only in GlueStorefront and Storefront applications. Replace them with other methods in the following entities: | |
| * Backoffice | |
| * MerchantPortal | |
| * Console Commands | |
| * Gateway | |
| * BackendAPI |
| 3. Be aware that after enabling Dynamic Multistore mode, your basic domain structure will change from store to region for all the applications(Example https://yves.de.mysprykershop.com => https://yves.eu.mysprykershop.com), make sure that it is expected. If external systems are impacted by this - necessary redirects are set, so SEO of your site is not impacted. | ||
| 4. The Dynamic Store feature itself does not require any database changes, in case you've already migrated to the latest demoshop version. | ||
| 5. Dynamic Multistore introduce some changes in RabbitMQ messages structure, so it is **important** that: | ||
| - During server migration we do not have unprocessed messages in the queue. Make sure that all messages are processed **before** enabling Maintenance Mode. |
There was a problem hiding this comment.
How is server migration related to dynamic multistore?
| ## Enable Dynamic Multistore | ||
|
|
||
| {% info_block warningBox "Project version" %} | ||
| If your project version is below 202307.0, you need to update to the latest codebase first, see [Install Dynamic Multistore](/docs/pbc/all/dynamic-multistore/202410.0/base-shop/install-dynamic-multistore.html) page. |
There was a problem hiding this comment.
What do I need to do with the linked document?
There was a problem hiding this comment.
Rephrased, please take a look.
I would prefer not to merge those documents, those are different things.
|
|
||
|
|
||
| 1. Make sure that your custom Backoffice, MerchantPortal, Console Commands, Gateway, BackendAPI code do not use `StoreFacade::getCurrentStore()` as well as `StoreClient::getCurrentStore()` methods, they are no longer available in any other application except GlueStorefront and Storefront. | ||
| 2. Make sure that you custom console commands (and the places where they are executed) updated to the new format, see [details](/docs/pbc/all/dynamic-multistore/{{page.version}}/base-shop/difference-between-modes.html#Deployment file difference). |
There was a problem hiding this comment.
Explain how to do it in this document, jumping between documents is not acceptable. Same for step 5
…ttps://github.com/spryker/spryker-docs into feature/frw-8550-dynamic-multistore-documentation
| - All store aware commands should implement `Spryker\Zed\Kernel\Communication\Console\StoreAwareConsole` and execute actions for specific store if store parameter is provided, or for all the stores in the region otherwise. | ||
| - It is recommended to use `--store` parameter instead of `APPLICATION_STORE` env variable, despite the support of env variable still exists. | ||
| 3. Be aware that after enabling Dynamic Multistore mode, your basic domain structure will change from store to region for all the applications(Example https://yves.de.mysprykershop.com => https://yves.eu.mysprykershop.com), make sure that it is expected. If external systems are impacted by this - necessary redirects are set, so SEO of your site is not impacted. | ||
| 4. The Dynamic Store feature itself does not require any database changes, in case you've already migrated to the latest demoshop version. |
There was a problem hiding this comment.
Who is this information useful for?
There was a problem hiding this comment.
For the developer who enabled DMS ON mode
| 5. Dynamic Multistore introduce some changes in RabbitMQ messages structure, so it is **important** that: | ||
| - During the migration we do not have unprocessed messages in the queue. Make sure that all messages are processed **before** enabling Maintenance Mode. | ||
| - Make sure that `Maintainance Mode` is enabled during migration to make sure that no new messages are added to the queue before the migration is finished. | ||
| (Expected downtime is limited to the deployment time, normally it takes less than 1hr) |
There was a problem hiding this comment.
Downtime of what?
…ttps://github.com/spryker/spryker-docs into feature/frw-8550-dynamic-multistore-documentation
andriitserkovnyi
deleted the
feature/frw-8550-dynamic-multistore-documentation
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket: https://spryker.atlassian.net/browse/FRW-8550