Documentation
Feedback
Guides
Storefront Development

Storefront Development
(Legacy) CMS Portal
Migrating your storefront from Legacy CMS Portal to Store Framework
Migrating your storefront from Legacy CMS Portal to Store Framework

VTEX provides different storefront solutions for you to choose from based on your operation’s needs: Store Framework and FastStore. However, there are still stores running the Legacy CMS Portal.

If your store uses Legacy CMS Portal, we strongly recommend migrating it to Store Framework. For implementation details, see the following sections.

If you wish to migrate your store from another commerce platform, the instructions below do not apply. In this case, follow the steps in the Go Live guide.

Instructions

To migrate your store from Legacy CMS Portal to Store Framework, follow these steps:

  1. Setup workspaces
  2. Develop and test
  3. Go live

Consider planning the entire go-live process at least two weeks in advance, as some of the steps below are time-sensitive.

Step 1 - Setting up workspaces

Workspaces are isolated environments, which means they can be understood as different versions of the same VTEX account.

To develop and test your store, we recommend that you create at least one development workspace and one production workspace. But it may be a good idea to create more workspaces based on your development needs. Learn how to manage workspaces effectively in Best practices on workspaces management.

Do not use subaccounts instead of workspaces. This can cause loss of Master Data information, including client profiles, and delays in project changes being displayed on the storefront due to cache unpredictability. It may even cause store downtime when going live with the new storefront.

Setting the Edition app

Once you have created your workspaces, open a support ticket requesting the installation of the vtex.edition-store@3.x or a more recent version of the Edition app in the workspaces created previously. Do not forget to include the names of the workspaces you wish to use in this process.

To check which version of the Edition app is installed in a workspace, run the following command: vtex edition get. Learn about its different versions in the Edition app guide.

Do not request the Edition change for the master workspace of your store. This will cause some features, such as My Account, to stop working properly.

Step 2 - Developing and testing your storefront

At this point, it is up to your development team to plan and develop your store’s frontend experience. Check these guides to learn how to use VTEX IO to create amazing storefronts with Store Framework:

Step 3 - Going live

Once you have developed and tested your new storefront and everything is ready in a production workspace, it is time to go live. This means seamlessly switching the storefront being displayed to shoppers at your store’s domain. Follow these steps to accomplish this task:

  1. Promote the production workspace running your new storefront to master. Learn more about how to promote a workspace to master.
  2. Request VTEX internal DNS pointing change for Store Framework via support ticket. Use the ticket to schedule the change according to the information below at least three business days before your planned go-live date. This last step will cause your new storefront to go live.

When opening the ticket, keep in mind that you must:

  • Open the ticket at least 3 days before the go-live date.
  • Request VTEX internal DNS pointing change only after you have promoted your production workspace to master.
  • Make it clear that you wish to go live in the ticket title.
  • Indicate a time from 9 a.m. to 5 p.m. (UTC-3) for the change to happen.
  • Indicate whether your store has any trade policy conditional rules.
Contributors
4
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 4 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
4
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 4 contributors
On this page