From b03dcaa604bb2f68ca5b206aec2719c2518fcf58 Mon Sep 17 00:00:00 2001 From: Henrique Balbino Date: Sun, 8 Sep 2024 22:43:41 -0300 Subject: [PATCH 1/8] Add troubleshooting guide --- ...rrors-with-my-service-configuration-app.md | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/localization/i-am-getting-errors-with-my-service-configuration-app.md 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 new file mode 100644 index 0000000000..d28644b239 --- /dev/null +++ b/docs/localization/i-am-getting-errors-with-my-service-configuration-app.md @@ -0,0 +1,56 @@ +--- +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 + -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 some errors due to the service that your app is configuring being installed or linked to a different workspace you are working in. That happens because, when creating a new configuration app, the configuration builder first looks for the schema of that configuration 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 + +We present the following solutions for when you are getting errors with the service configuration app: + +1. Avoid errors when installing or linking your configuration app. +2. Publish your configuration app in an alternative workspace. + +### Avoid 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} for the workspace you want to work on. + +2. If your service app is not yet linked or installed, [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) or [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) your service app. +3. [Install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) or [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) your configuration app. + +### Publish 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}` for the workspace you want to work on. + +2. If your service app is not yet linked or installed, [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) or [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-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. From 69d3b04e71d7cf2e8efe69fdaf75133aa45da35c Mon Sep 17 00:00:00 2001 From: Henrique Balbino Date: Sun, 8 Sep 2024 22:51:37 -0300 Subject: [PATCH 2/8] Replace troubleshooting section with reference --- ...entation-developing-service-configuration-apps.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-developing-service-configuration-apps.md b/docs/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-developing-service-configuration-apps.md index 74088f047d..486eb7641f 100644 --- a/docs/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-developing-service-configuration-apps.md +++ b/docs/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-developing-service-configuration-apps.md @@ -219,14 +219,4 @@ Each element in this array consists of: Note that multiple apps can configure the same service. Hence, each element in this array represents a configuration originating from a different app. -## Troubleshooting - -If you are developing a configuration app and the service that your app is configuring is not installed or linked in the same workspace you're working at, you may run into some errors. That happens because, when creating a new configuration app, the configuration builder first looks for the schema of that configuration in all the apps installed in your current workspace. Consequently, if the configuration builder cannot find this specific configuration, linking your app may fail. - -To avoid errors, remember to always have the service you're configuring linked or installed in the same workspace you're developing your configuration app. - -To publish your Configuration app without installing the service in the `master` workspace, you can `link` or `install` the Service app in an alternative branch and then use the `-w` flag when publishing: - -```sh -vtex publish -w {alternativeBranchName} -``` +> ℹ️ If you are getting errors with the service configuration app, see the [troubleshooting guide](https://developers.vtex.com/docs/guides/i-am-getting-errors-with-my-service-configuration-app). From f3e3f37792046c8441eba307c043a676113de44f Mon Sep 17 00:00:00 2001 From: Henrique Balbino Date: Mon, 9 Sep 2024 10:16:44 -0300 Subject: [PATCH 3/8] Move guide from localization folder --- .../i-am-getting-errors-with-my-service-configuration-app.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{localization => troubleshooting/development}/i-am-getting-errors-with-my-service-configuration-app.md (100%) diff --git a/docs/localization/i-am-getting-errors-with-my-service-configuration-app.md b/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md similarity index 100% rename from docs/localization/i-am-getting-errors-with-my-service-configuration-app.md rename to docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md From cd06181a39288d955e91d5d0933bbd1a027a7ff0 Mon Sep 17 00:00:00 2001 From: Henrique Balbino Date: Mon, 9 Sep 2024 10:22:22 -0300 Subject: [PATCH 4/8] Fix tags --- .../i-am-getting-errors-with-my-service-configuration-app.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md b/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md index d28644b239..12ba8ca993 100644 --- a/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md +++ b/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md @@ -5,8 +5,9 @@ hidden: false createdAt: "2024-09-09T10:00:00.000Z" updatedAt: "2024-09-09T10:00:00.000Z" tags: - -apps - -services + - 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 some errors due to the service that your app is configuring being installed or linked to a different workspace you are working in. That happens because, when creating a new configuration app, the configuration builder first looks for the schema of that configuration in all the apps installed in your current workspace. Consequently, linking your app may fail if the configuration builder cannot find this specific configuration. From 5270d19f83f7d8551dbdbdde875845fcbf23dd70 Mon Sep 17 00:00:00 2001 From: Henrique Balbino Date: Mon, 9 Sep 2024 10:25:59 -0300 Subject: [PATCH 5/8] Move back guide to localization folder --- .../i-am-getting-errors-with-my-service-configuration-app.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{troubleshooting/development => localization}/i-am-getting-errors-with-my-service-configuration-app.md (100%) diff --git a/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md b/docs/localization/i-am-getting-errors-with-my-service-configuration-app.md similarity index 100% rename from docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md rename to docs/localization/i-am-getting-errors-with-my-service-configuration-app.md From c85aabd71ed0376e8da5a4a1a7113ad2a802a1b7 Mon Sep 17 00:00:00 2001 From: "George B. de Lima" <106821144+GeorgeLimaDev@users.noreply.github.com> Date: Fri, 27 Sep 2024 01:41:29 -0900 Subject: [PATCH 6/8] New translations i-am-getting-errors-with-my-service-configuration-app.md (English, United States) --- ...rrors-with-my-service-configuration-app.md | 59 ++++++++++--------- 1 file changed, 31 insertions(+), 28 deletions(-) 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 index 12ba8ca993..5626423206 100644 --- 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 @@ -1,57 +1,60 @@ --- -title: "I am getting errors with my service configuration app" -slug: "i-am-getting-errors-with-my-service-configuration-app" +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" +createdAt: 2024-09-09T10:00:00.000Z +updatedAt: 2024-09-09T10:00:00.000Z tags: - - apps - - vtex-io - - services + - 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 some errors due to the service that your app is configuring being installed or linked to a different workspace you are working in. That happens because, when creating a new configuration app, the configuration builder first looks for the schema of that configuration in all the apps installed in your current workspace. Consequently, linking your app may fail if the configuration builder cannot find this specific configuration. +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 -We present the following solutions for when you are getting errors with the service configuration app: +Below, we outline solutions for addressing errors with your service configuration app: 1. Avoid errors when installing or linking your configuration app. 2. Publish your configuration app in an alternative workspace. -### Avoid errors when installing or linking your configuration app +### 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: +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} - ``` + ``` + vtex use workspace {desiredWorkspace} + ``` - > ℹ️ Replace {desiredWorkspace} for the workspace you want to work on. + > ℹ️ Replace {desiredWorkspace} with the workspace you want to work in. -2. If your service app is not yet linked or installed, [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) or [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) your service app. -3. [Install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) or [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) your configuration app. +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. -### Publish your configuration app in an alternative workspace +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} - ``` + ``` + vtex use workspace {desiredWorkspace} + ``` + + Replace `{desiredWorkspace}` with the workspace you want to work in. - Replace `{desiredWorkspace}` for the workspace you want to work on. +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. -2. If your service app is not yet linked or installed, [install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) or [link](https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-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} - ``` +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. + The `-w` flag allows you to choose the workspace of the app you are publishing. From c10e2f027c2deec56e65d9848015c34d054602b9 Mon Sep 17 00:00:00 2001 From: kaio-donadelli Date: Fri, 27 Sep 2024 07:48:02 -0300 Subject: [PATCH 7/8] Fixed formatting. --- ...rrors-with-my-service-configuration-app.md | 41 +++++++++---------- 1 file changed, 19 insertions(+), 22 deletions(-) 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 index 5626423206..f83d1b7669 100644 --- 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 @@ -1,13 +1,13 @@ --- -title: I am getting errors with my service configuration app -slug: i-am-getting-errors-with-my-service-configuration-app +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 +createdAt: "2024-09-09T10:00:00.000Z" +updatedAt: "2024-09-09T10:00:00.000Z" tags: - - apps - - vtex-io - - services + - 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. @@ -25,14 +25,13 @@ To avoid errors, link or install the configuration app in the same workspace the 1. In a terminal, go to the desired workspace using the following VTEX IO CLI command: - ``` - vtex use workspace {desiredWorkspace} - ``` + ``` + vtex use workspace {desiredWorkspace} + ``` - > ℹ️ Replace {desiredWorkspace} with the workspace you want to work in. + > ℹ️ 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 @@ -41,20 +40,18 @@ To publish your configuration app without installing the service in the master w 1. In a terminal, go to the desired workspace using the following VTEX IO CLI command: - ``` - vtex use workspace {desiredWorkspace} - ``` + ``` + vtex use workspace {desiredWorkspace} + ``` - Replace `{desiredWorkspace}` with the workspace you want to work in. + 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} - ``` + ``` + vtex publish -w {desiredWorkspace} + ``` - The `-w` flag allows you to choose the workspace of the app you are publishing. + The `-w` flag allows you to choose the workspace of the app you are publishing. From a076a126ecfe129341689be157c0269359944f0c Mon Sep 17 00:00:00 2001 From: Henrique Balbino Date: Fri, 27 Sep 2024 15:43:46 -0300 Subject: [PATCH 8/8] Update docs/localization/i-am-getting-errors-with-my-service-configuration-app.md Co-authored-by: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> --- .../i-am-getting-errors-with-my-service-configuration-app.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 index f83d1b7669..65b09e4c65 100644 --- 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 @@ -16,8 +16,8 @@ If you are [developing a configuration app](https://developers.vtex.com/docs/gui Below, we outline solutions for addressing errors with your service configuration app: -1. Avoid errors when installing or linking your configuration app. -2. Publish your configuration app in an alternative workspace. +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