Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
Merge pull request #1449 from vtex-apps/going-live-with-sf-27102022
Browse files Browse the repository at this point in the history
Going live with sf 27102022
  • Loading branch information
PedroAntunesCosta authored Nov 7, 2022
2 parents b039cd7 + 0f3e687 commit dd6ef2b
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 5 deletions.
61 changes: 61 additions & 0 deletions docs/en/Recipes/store-management/go-live.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Going live with a new store

If you have already set up your store's [commerce features](https://help.vtex.com/tracks) and built the storefront using [Store Framework](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-what-is-vtex-store-framework), it is time to go live.

This article will guide you through the steps you must take to make your ecommerce available to online shoppers.

> ℹ️
>
> The steps below also apply if you are migrating your store from another ecommerce platform.
## Step by step

To go live with your VTEX store, built with [Store Framework](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-what-is-vtex-store-framework), follow these steps:
1. [Set account edition](#step-1---setting-the-edition-app)
2. [Register host](#step-2---registering-the-store's-domain)
3. [Request internal DNS pointing](#step-3---requesting-internal-dns-pointing)
4. [Set up regular DNS pointing](#step-4---setting-up-dns-pointing)

> ⚠️
>
> 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 the Edition app

Open a [support ticket](https://help.vtex.com/en/support) requesting the installation of the `vtex.edition-store@5.x` [Edition app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-edition-app) in your `master` [workspace](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace).

> ℹ️
>
> Once the Store Edition is installed in the master [workspace](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace) of your account, all new workspaces you create will use this same Edition app. Other workspaces that existed previously will remain with the [Edition app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-edition-app) they already had.
You can check the Edition app installed in any given workspace by running the following command in your terminal: `vtex edition get`. Please refer to [Edition apps](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-edition-app) for further information.

### Step 2 - Registering the store's domain

To launch your store, you must own a [domain name](https://en.wikipedia.org/wiki/Domain_name). If you have not already, you can buy one from a domain provider.

[Configure your domain as your store's host](https://help.vtex.com/en/tutorial/configuring-domains-in-license-manager--tutorials_2450) as presented in this guide to make sure that shoppers will be directed to your new VTEX store.

### Step 3 - Requesting internal DNS pointing

VTEX provides different [storefront solutions](https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z). This step ensures that the domain you [registered as your VTEX host](#step-2---registering-the-store's-domain) points users to the storefront built with Store Framework.

Request VTEX internal DNS pointing change for Store Framework via [support ticket](https://help.vtex.com/en/support). When opening your ticket keep in mind that you must:

- Make it clear that you wish to go live in the title of the ticket.
- Indicate a time from 9 to 17 BRT (UTC-3) for the internal pointing change to happen.
- Indicate whether or not your store has any [trade policy conditional rules](https://help.vtex.com/en/tutorial/criar-uma-politica-comercial--563tbcL0TYKEKeOY4IAgAE).

This process takes about three business days. Once you receive a successful reply from the support ticket, you have five days to [set up regular DNS pointing](#step-4---setting-up-dns-pointing).

### Step 4 - Setting up DNS pointing

Within five days of the confirmation of [internal DNS pointing](#step-3---requesting-internal-dns-pointing) you must set up regular DNS pointing. Otherwise, your internal pointing will be automatically excluded and you will need to request it again, as described above.

Unlike the previous step, regular DNS pointing must be set up by you and guarantees that your domain points to VTEX so that the platform can deliver your storefront to shoppers.

To do this, follow the instructions in [Setting up DNS pointing to VTEX](https://help.vtex.com/en/tutorial/configuring-dns-pointing-to-vtex--tutorials_4280).

> ⚠️
>
> DNS pointing propagation takes 24-48 hours to occur completely, which means that the configured address may not be accessible to all people right after configuration.
23 changes: 23 additions & 0 deletions docs/en/Recipes/store-management/going-live.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Going live

When it comes to the VTEX ecosystem, there are a few different scenarios in which you may wish to launch a new store or storefront.

> ℹ️
>
> Learn more about [VTEX CMS options](https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z).
## Go-live scenarios

Click the links below to see specific instructions corresponding to the scenario.

> ℹ️
>
> Note that migrating from another ecommerce platform counts as a new store for the scenarios below.
- [New store built with Store Framework](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-go-live)
- [Migrating from Legacy CMS Portal to Store Framework](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-migrating-storefront-from-legacy-to-io)
- [New store built with Legacy CMS Portal](https://help.vtex.com/en/tutorial/configuring-dns-pointing-to-vtex)

> ⚠️
>
> If your store runs with the Legacy CMS Portal, we strongly recommend migrating it to Store Framework.
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,21 @@ VTEX provides different storefront solutions for you to choose from, according t
If your store runs with the Legacy CMS Portal, we strongly recommend migrating it to Store Framework. For implementation details, please refer to 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](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-go-live).
## Step by step

To migrate your store from Legacy CMS Portal to [Store Framework](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-what-is-vtex-store-framework), follow these steps:
1. [Setup workspaces](#step-1---setup-workspaces)
2. [Develop and test](#step-2---developing-and-testing-your-storefront)
3. [Go live](#step-3---going-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 - Setup workspaces

[Workspaces](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace) are environments isolated from one another. They can be understood as different versions of the same VTEX account.
Expand All @@ -29,7 +37,6 @@ To develop and test your store, we recommend that you create at least one [devel

Once you have created your workspaces, [open a support ticket](https://help.vtex.com/en/support) requesting the installation of the `vtex.edition-store@5.x` [Edition app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-edition-app) in the workspaces created previously. Do not forget to include the names of the workspaces you wish to use in this process.


You can check the Edition app installed in a workspace by running the following command: `vtex edition get`. Please refer to [Edition apps](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-edition-app) for further information.

> ⚠️
Expand All @@ -49,8 +56,11 @@ At this point, it is up to your development team to plan and develop your store
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 that is running your new storefront to master. Learn more about how to [promote a workspace to master](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-promoting-a-workspace-to-master).
2. Request VTEX internal DNS pointing change for Store Framework via [support ticket](https://help.vtex.com/en/support). Use the ticket to schedule the change according to the information below. This last step will cause your new storefront to go live.
2. Request VTEX internal DNS pointing change for Store Framework via [support ticket](https://help.vtex.com/en/support). 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.

> ⚠️
>
> Request VTEX internal DNS pointing change only after you have promoted your production workspace to master. Do this at least three business days prior to your desired Go live date. Indicate a time from 9 to 17 BRT (UTC-3) for the change to happen.
When opening the ticket, keep in mind that you must:

- 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 title of the ticket.
- Indicate a time from 9 to 17 BRT (UTC-3) for the change to happen.
- Indicate whether or not your store has any [trade policy conditional rules](https://help.vtex.com/en/tutorial/criar-uma-politica-comercial--563tbcL0TYKEKeOY4IAgAE).

0 comments on commit dd6ef2b

Please sign in to comment.