From 0f9e58fb8555dcbc5c53fbc3d88677d0628d95ce Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:53:57 -0300 Subject: [PATCH 1/5] add SDK overview --- .../faststore/docs/faststore-sdk/overview.mdx | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/faststore/docs/faststore-sdk/overview.mdx diff --git a/docs/faststore/docs/faststore-sdk/overview.mdx b/docs/faststore/docs/faststore-sdk/overview.mdx new file mode 100644 index 0000000000..5340839584 --- /dev/null +++ b/docs/faststore/docs/faststore-sdk/overview.mdx @@ -0,0 +1,34 @@ +--- +title: "FastStore SDK" +--- + +The FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. By providing a set of functions and interfaces, it simplifies tasks like tracking cart items and handling user sessions. + +The SDK is organized into four modules, each with specific properties and behaviors. This track provides more details about each module. + +- [Shopping cart](#shopping-cart) +- [Session](#session) +- [Search](#search) +- [Analytics](#analytics) + +## Shopping cart + +The Cart module controls the state of the shopping cart data structure in the shopper's browser. You can use them to add items to the cart, remove items, and clear the cart, among other tasks. Learn more about [shopping cart functions](LINK). + +> ℹ️ Learn more about how to validate the cart in the shopper's browser against the information in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#cart). + +## Session + +The Session module manages the state of session information in the shopper's browser. This includes currency, channel, localization, and shopper data. Learn more about the [session SDK module](LINK) data structure and usage. + +> ℹ️ Learn more about how to validate session data in the shopper's browser against the data in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#session). + +## Search + +The Search module offers functions for implementing a faceted search based on URL parameters. Whenever a shopper searches your store or changes the selected facets, the search module generates a unique and serialized URL and then directs the user to that URL. + +Learn more about how to use the [SDK Search module](LINK) in your project. + +## Analytics + +The Analytics module helps you create a simple and extensive event system to feed your data pool. It is biased towards [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4) but supports other analytics providers. Go to the [Analytics](LINK) page to learn more. From 2516f4429b44b30d11db4518aaf53a35e2740c97 Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:49:41 -0300 Subject: [PATCH 2/5] move FastStore SDK overview to loc folder and remove troubleshoot doc --- ...rrors-with-my-service-configuration-app.md | 57 ------------------- .../overview.mdx | 3 + 2 files changed, 3 insertions(+), 57 deletions(-) delete mode 100644 docs/localization/i-am-getting-errors-with-my-service-configuration-app.md rename docs/{faststore/docs/faststore-sdk => localization}/overview.mdx (96%) diff --git a/docs/localization/i-am-getting-errors-with-my-service-configuration-app.md b/docs/localization/i-am-getting-errors-with-my-service-configuration-app.md deleted file mode 100644 index 65b09e4c65..0000000000 --- a/docs/localization/i-am-getting-errors-with-my-service-configuration-app.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "I am getting errors with my service configuration app" -slug: "i-am-getting-errors-with-my-service-configuration-app" -hidden: false -createdAt: "2024-09-09T10:00:00.000Z" -updatedAt: "2024-09-09T10:00:00.000Z" -tags: - - apps - - vtex-io - - services ---- - -If you are [developing a configuration app](https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps), you may be getting errors because the service your app is configuring is installed or linked to a different workspace. This happens because, when creating a new configuration app, the configuration builder first looks for that configuration schema in all the apps installed in your current workspace. Consequently, linking your app may fail if the configuration builder cannot find this specific configuration. - -## Solution - -Below, we outline solutions for addressing errors with your service configuration app: - -1. [Avoid errors when installing or linking your configuration app](#avoiding-errors-when-installing-or-linking-your-configuration-app). -2. [Publish your configuration app in an alternative workspace](#publishing-your-configuration-app-in-an-alternative-workspace). - -### Avoiding errors when installing or linking your configuration app - -To avoid errors, link or install the configuration app in the same workspace the service app is linked or installed. Follow the instructions below: - -1. In a terminal, go to the desired workspace using the following VTEX IO CLI command: - - ``` - vtex use workspace {desiredWorkspace} - ``` - - > ℹ️ Replace {desiredWorkspace} with the workspace you want to work in. - -2. If your service app is not yet linked or installed, [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your service app. -3. [Link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your configuration app. - -### Publishing your configuration app in an alternative workspace - -To publish your configuration app without installing the service in the master workspace, follow the instructions below: - -1. In a terminal, go to the desired workspace using the following VTEX IO CLI command: - - ``` - vtex use workspace {desiredWorkspace} - ``` - - Replace `{desiredWorkspace}` with the workspace you want to work in. - -2. If your service app is not yet linked or installed, [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your service app. -3. Create a new version of your configuration app by following the instructions in [Releasing a new app version](https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version). -4. [Publish](https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) your configuration app using the following command: - - ``` - vtex publish -w {desiredWorkspace} - ``` - - The `-w` flag allows you to choose the workspace of the app you are publishing. diff --git a/docs/faststore/docs/faststore-sdk/overview.mdx b/docs/localization/overview.mdx similarity index 96% rename from docs/faststore/docs/faststore-sdk/overview.mdx rename to docs/localization/overview.mdx index 5340839584..4c6cce22d8 100644 --- a/docs/faststore/docs/faststore-sdk/overview.mdx +++ b/docs/localization/overview.mdx @@ -1,5 +1,8 @@ --- title: "FastStore SDK" +slug: "faststore-sdk" +createdAt: "2024-09-09T10:00:00.000Z" +updatedAt: "" --- The FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. By providing a set of functions and interfaces, it simplifies tasks like tracking cart items and handling user sessions. From 2ffebee185822ae2fb718b36f38556a51cf76d3c Mon Sep 17 00:00:00 2001 From: "George B. de Lima" <106821144+GeorgeLimaDev@users.noreply.github.com> Date: Mon, 4 Nov 2024 14:32:23 -0300 Subject: [PATCH 3/5] Update Crowdin configuration file --- crowdin.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crowdin.yml b/crowdin.yml index 32936ded5c..faee5b6b76 100644 --- a/crowdin.yml +++ b/crowdin.yml @@ -1,5 +1,5 @@ files: - - source: /docs/localization/*.md + - source: /docs/localization/*.* translation: /%original_path%/%original_file_name%_%two_letters_code% translation_replace: _en: '' From 34331143958c31684364f9b3c1a532635698ab7a Mon Sep 17 00:00:00 2001 From: "George B. de Lima" <106821144+GeorgeLimaDev@users.noreply.github.com> Date: Fri, 8 Nov 2024 08:10:18 -0300 Subject: [PATCH 4/5] New translations overview.mdx (English, United States) --- docs/localization/overview.mdx | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/localization/overview.mdx b/docs/localization/overview.mdx index 4c6cce22d8..1d503b0f84 100644 --- a/docs/localization/overview.mdx +++ b/docs/localization/overview.mdx @@ -1,13 +1,13 @@ --- -title: "FastStore SDK" -slug: "faststore-sdk" -createdAt: "2024-09-09T10:00:00.000Z" +title: FastStore SDK +slug: faststore-sdk +createdAt: 2024-09-09T10:00:00.000Z updatedAt: "" --- -The FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. By providing a set of functions and interfaces, it simplifies tasks like tracking cart items and handling user sessions. +The FastStore SDK is a toolkit that provides functions and interfaces for managing the state of key ecommerce features in the browser context. Providing a set of functions and interfaces simplifies tasks like tracking cart items and handling user sessions. -The SDK is organized into four modules, each with specific properties and behaviors. This track provides more details about each module. +The SDK is organized into four modules with specific properties and behaviors. This track provides more details about each module. - [Shopping cart](#shopping-cart) - [Session](#session) @@ -16,15 +16,15 @@ The SDK is organized into four modules, each with specific properties and behavi ## Shopping cart -The Cart module controls the state of the shopping cart data structure in the shopper's browser. You can use them to add items to the cart, remove items, and clear the cart, among other tasks. Learn more about [shopping cart functions](LINK). +The Cart module controls the state of the shopping cart data structure in the shopper's browser. You can use it to add items to the cart, remove items, and clear the cart, among other tasks. Learn more about [shopping cart functions](LINK). -> ℹ️ Learn more about how to validate the cart in the shopper's browser against the information in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#cart). +> ℹ️ Learn more about validating the cart in the shopper browser against the information in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#cart). ## Session -The Session module manages the state of session information in the shopper's browser. This includes currency, channel, localization, and shopper data. Learn more about the [session SDK module](LINK) data structure and usage. +The Session module manages the state of session information in the shopper browser. This includes currency, channel, localization, and shopper information. Learn more about the [session SDK module](LINK) data structure and usage. -> ℹ️ Learn more about how to validate session data in the shopper's browser against the data in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#session). +> ℹ️ Learn more about validating the cart in the shopper browser against the information in the platform with [FastStore API mutations](https://developers.vtex.com/docs/guides/faststore/schema-mutations#session). ## Search @@ -34,4 +34,4 @@ Learn more about how to use the [SDK Search module](LINK) in your project. ## Analytics -The Analytics module helps you create a simple and extensive event system to feed your data pool. It is biased towards [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4) but supports other analytics providers. Go to the [Analytics](LINK) page to learn more. +The Analytics module helps you create a simple, extensive event system to feed your data pool. It is geared towards [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4) but supports other analytics providers. Check the [Analytics](LINK) page to learn more. From 739b56146b6890223169097415641dc17be86594 Mon Sep 17 00:00:00 2001 From: sheilagomes Date: Fri, 8 Nov 2024 08:47:14 -0300 Subject: [PATCH 5/5] Fix formatting --- docs/localization/overview.mdx | 6 +++--- docs/localization/test.md | 9 --------- 2 files changed, 3 insertions(+), 12 deletions(-) delete mode 100644 docs/localization/test.md diff --git a/docs/localization/overview.mdx b/docs/localization/overview.mdx index 1d503b0f84..a8ee828574 100644 --- a/docs/localization/overview.mdx +++ b/docs/localization/overview.mdx @@ -1,7 +1,7 @@ --- -title: FastStore SDK -slug: faststore-sdk -createdAt: 2024-09-09T10:00:00.000Z +title: "FastStore SDK" +slug: "faststore-sdk" +createdAt: "2024-09-09T10:00:00.000Z" updatedAt: "" --- diff --git a/docs/localization/test.md b/docs/localization/test.md deleted file mode 100644 index a16cf06e60..0000000000 --- a/docs/localization/test.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Test" -slug: "test" -hidden: true -createdAt: "2024-08-15T18:10:15.623Z" -updatedAt: "" ---- - -Test.