EDU-15900 - FastStore: Migração entre repositórios

[barbara-celi]

Types of changes

• New content (guides, endpoints, app documentation)
• Improvement (make a documentation even better)
• Fix (fix a documentation error)
• Spelling and grammar accuracy (self-explanatory)

EDU-15900

[github-actions]

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

• Couldn't find the corresponding page for docs/localization/migrating-your-faststore-project-to-a-new-repository.mdx. Have you added migrating-your-faststore-project-to-a-new-repository to the navigation.json file? Maybe you can find it in https://developers.vtex.com/docs/guides/migrating-your-faststore-project-to-a-new-repository

[github-actions]

Navigation Preview Link

No changes detected in the navigation.json file

[github-actions]

Documentation feedback for docs/localization/migrating-your-faststore-project-to-a-new-repository.mdx

General Feedback

The guide provides instructions on migrating a FastStore project to a new repository. However, it needs significant revisions to fully comply with the specified rules. The frontmatter is incomplete, missing the slug, excerpt, createdAt, and potentially updatedAt fields. The "Before you begin" section uses a non-standard <Steps> tag, which should be replaced with a more appropriate structure. The "Instructions" section lacks imperative titles for each step and could benefit from a more structured approach with clear, actionable steps. The tone and voice also need adjustments to be more direct and concise.

Actionable Feedback

1. Frontmatter: Add the missing slug, excerpt, and createdAt fields. Consider adding updatedAt if the content has been updated.
2. Before you begin: Replace the <Steps> tag with a standard list or descriptive paragraphs. Each prerequisite should be clearly stated.
3. Instructions:
   • Add imperative titles to each step, following the format ### Step N - Imperative title.
   • Ensure each step starts with an imperative verb.
   • Remove unnecessary introductory phrases before the imperative verb.
4. Tone and Voice: Revise the content to be more direct, informative, clear, and concise. Avoid unnecessary explanations and focus on actionable instructions.
5. Links: Standardize the link formatting.
6. Images: Ensure images have appropriate alt text.

Suggested Revision

---
title: "Migrating your FastStore project to a new repository"
slug: "migrating-your-faststore-project-to-a-new-repository"
excerpt: "Learn how to migrate your FastStore project from one repository to another."
createdAt: "2024-07-03T10:00:00Z"
---

In this guide, you will learn how to migrate your FastStore project from one repository to another. This guide applies if:

*   Your FastStore project is hosted in the `vtex-sites` organization and uses WebOps, and you want to migrate it to your account’s GitHub organization.
*   Your FastStore project is hosted in its own organization on GitHub and uses WebOps, and you want to migrate it to a new organization or repository.

> ⚠️ If your FastStore project is hosted in the `vtex-sites` organization and does not use WebOps ([FastStore v1](https://v1.faststore.dev/docs)), and you wish to migrate to your account’s GitHub organization, see the guide [Migrating from FastStore v1 to v3](LINK).

## Before you begin

Before you start, make sure you have the following:

*   **FastStore project using WebOps:** Ensure the FastStore project you want to migrate uses [WebOps](https://developers.vtex.com/docs/guides/faststore/1-onboarding-overview).
*   **Up-to-date `@faststore/cli` package:** Update the `@faststore/cli` package in your project to the latest version. To do so, follow the instructions in [Updating the '@faststore/cli' package version](https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version).
*   **GitHub organization:** Create a GitHub organization where you want to migrate your project. Learn how to do so in the GitHub guide [Creating a new organization from scratch](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch).
*   **GitHub repository:** Create the GitHub repository where you want to migrate your FastStore project. Learn how to do so in the GitHub guide [Creating a new repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository).
*   **Repository ID:** You will need this information during the migration process. To identify the repository ID, follow these instructions:

    1.  Go to the GitHub repository page where you want to host your FastStore project. The URL follows this pattern: `https://github.com/{organizationName}/{repositoryName}`. Replace the curly brackets according to your scenario.
    2.  Open the console in your browser.
    3.  Run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')`. The response is the repository ID.

## Instructions

### Step 1 - Migrate the store code

1.  Clone the current repository to your local environment.
2.  Push the codebase to the new repository.

### Step 2 - Install FastStore WebOps app

1.  In a terminal, log in to your VTEX account by running the following command. Replace `{accountName}` with your store account name (example: `vtex login store`).

    ```bash
    vtex login {accountName}
    ```

2.  Install the FastStore WebOps app by running the following command:

    ```bash
    vtex install vtex.webops
    ```

    > ⚠️ The FastStore WebOps app only works in the production environment, so you must install it only in your account's master environment.

3.  When a confirmation message appears, type `y` to proceed.

    ```bash
    ? Are you sure you want to force this operation on the master workspace on the account store? » (y/N)
    ```

Your account now has the FastStore WebOps app installed. Learn more in [FastStore WebOps app](https://developers.vtex.com/docs/guides/faststore/1-onboarding-overview).

> ❗ Make sure you have given WebOps the requested permissions on the correct repository.

### Step 3 - Identify the app installation ID

1.  Go to the account GitHub organization settings.
2.  Click `GitHub Apps` under `Third-party Access`.
3.  Search for **FastStore WebOps**, then click `Configure` alongside the app name.
4.  Check the URL to get the app installation ID. The URL follows this pattern: `https://github.com/organizations/{organizationName}/settings/installations/{installationId}`, where `{organizationName}` is the name of your organization, and `{installationId}` is the app installation ID.

![App Installation ID](https://vtexhelp.vtexassets.com/assets/docs/src/app-installation-id___4088942cf7166f278e856d656f29e4ea.gif)

### Step 4 - Open a ticket to VTEX support

1.  Open a ticket to [VTEX Support](https://help.vtex.com/en/support) and share the following information:

    *   **Account:** Name of your account.
    *   **Current repository name:** Current repository where your Project is hosted.
    *   **Organization name:** Name of the account’s GitHub organization.
    *   **New repository name:** Name of the repository you want to migrate.
    *   **Repository ID:** The unique identifier of the repository you want to migrate. See how to get this ID in [Identify the repository ID](#identify-the-repository-id) section.
    *   **App installation ID (`installationId`):** The unique identifier of the FastStore WebOps installation on GitHub. See how to get this ID in [Identify the app installation ID](#identify-the-app-installation-id).

The Support team will work on your request and inform you when the process is complete.

> ❗ Don’t start publishing and making changes to the code in the new repository before the process is complete.

---

Was this feedback useful?

• Yes
• No