From 43d35aec09248de5ccda60b05636d317836f3f46 Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Tue, 22 Oct 2024 10:44:59 -0300 Subject: [PATCH 1/5] Update updating-the-core-package-version.mdx --- .../updating-the-core-package-version.mdx | 21 +++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/faststore/docs/reference/project-structure/updating-the-core-package-version.mdx b/docs/faststore/docs/reference/project-structure/updating-the-core-package-version.mdx index b87fb6cf80..ea9164f899 100644 --- a/docs/faststore/docs/reference/project-structure/updating-the-core-package-version.mdx +++ b/docs/faststore/docs/reference/project-structure/updating-the-core-package-version.mdx @@ -1,15 +1,28 @@ --- -title: "Updating the '@fastore/core' package version" +title: "Updating the '@fastore/cli' package version" --- -If you need to update the [`@fastore/core`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson) package, follow the instructions below: +If you need to update the [`@fastore/cli`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson) package, follow these instructions. 1. Open your FastStore codebase in the code editor of your preference. 2. Open the terminal and run the following: ```bash - yarn add @faststore/core@latest + yarn add @faststore/cli@latest ``` -3. Run `yarn dev` to sync the changes to your project. +3. The following message will appear: + +```bash +error Running this command will add the dependency to the workspace root rather than the workspace itself, which might not be what you want - if you really meant it, make it explicit by running this command again with the -W flag (or --ignore-workspace-root-check). +info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command. +``` + +4. Run the `yarn add @faststore/cli@latest` command again and add the `-W` flag: + +```bash +yarn add @faststore/cli@latest -W +``` + +5. Run `yarn dev` to sync the changes to your project. From 63006f831ce17283c87c707f25337cdbabbd075f Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Tue, 22 Oct 2024 10:48:49 -0300 Subject: [PATCH 2/5] changed doc's filename --- ...e-package-version.mdx => updating-the-cli-package-version.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/faststore/docs/reference/project-structure/{updating-the-core-package-version.mdx => updating-the-cli-package-version.mdx} (100%) diff --git a/docs/faststore/docs/reference/project-structure/updating-the-core-package-version.mdx b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx similarity index 100% rename from docs/faststore/docs/reference/project-structure/updating-the-core-package-version.mdx rename to docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx From c02c1e1bc7e0741df075edbdac4b09c17cb4a450 Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Tue, 22 Oct 2024 14:16:33 -0300 Subject: [PATCH 3/5] mentioned the release note --- .../project-structure/updating-the-cli-package-version.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx index ea9164f899..98ea345c8b 100644 --- a/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx +++ b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx @@ -4,6 +4,8 @@ title: "Updating the '@fastore/cli' package version" If you need to update the [`@fastore/cli`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson) package, follow these instructions. +> ⚠️ Since the publication of [this release note](https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency), the `@faststore/cli` package now depends on the `@faststore/core` package. Before updating the `@faststore/cli` package, make sure to check if this package is already listed in your dependencies. If not, check out the [release note](https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency) related to this change. + 1. Open your FastStore codebase in the code editor of your preference. 2. Open the terminal and run the following: From 349cf5091b5e7b76f2945924e00c05a502828766 Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Tue, 22 Oct 2024 14:26:40 -0300 Subject: [PATCH 4/5] fiz steps --- .../updating-the-cli-package-version.mdx | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx index 98ea345c8b..330dcb396a 100644 --- a/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx +++ b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx @@ -14,17 +14,4 @@ If you need to update the [`@fastore/cli`](https://developers.vtex.com/docs/guid yarn add @faststore/cli@latest ``` -3. The following message will appear: - -```bash -error Running this command will add the dependency to the workspace root rather than the workspace itself, which might not be what you want - if you really meant it, make it explicit by running this command again with the -W flag (or --ignore-workspace-root-check). -info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command. -``` - -4. Run the `yarn add @faststore/cli@latest` command again and add the `-W` flag: - -```bash -yarn add @faststore/cli@latest -W -``` - -5. Run `yarn dev` to sync the changes to your project. +3. Run `yarn dev` to sync the changes to your project. From f63640fa64a29ec9b2b42a81cb2020258dbe9a34 Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:16:54 -0300 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Fanny Chien --- .../project-structure/updating-the-cli-package-version.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx index 330dcb396a..5db25a1618 100644 --- a/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx +++ b/docs/faststore/docs/reference/project-structure/updating-the-cli-package-version.mdx @@ -4,7 +4,7 @@ title: "Updating the '@fastore/cli' package version" If you need to update the [`@fastore/cli`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson) package, follow these instructions. -> ⚠️ Since the publication of [this release note](https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency), the `@faststore/cli` package now depends on the `@faststore/core` package. Before updating the `@faststore/cli` package, make sure to check if this package is already listed in your dependencies. If not, check out the [release note](https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency) related to this change. +> ⚠️ Since the publication of [this release note](https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency), the `@faststore/core` package now depends on the `@faststore/cli` package. Before updating the `@faststore/cli` package, make sure to check if this package is already listed in your dependencies. If not, check out the [release note](https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency) related to this change. 1. Open your FastStore codebase in the code editor of your preference.