From 5bd5af88b52c787a3fcda7db75d6f97d05f810cd Mon Sep 17 00:00:00 2001 From: Barbora Siskova Date: Mon, 27 May 2024 16:03:25 +0200 Subject: [PATCH] Issue-590 Holistic review of non-quarkus tooling guides --- .../serverless-logic-web-tools-deploy-projects.adoc | 2 +- .../serverless-logic-web-tools-github-integration.adoc | 4 ++-- .../serverless-logic-web-tools-overview.adoc | 2 +- ...-tools-redhat-application-services-integration.adoc | 8 ++++---- .../swf-editor-chrome-extension.adoc | 2 +- .../swf-editor-overview.adoc | 4 ++-- .../swf-editor-vscode-extension.adoc | 10 +++++----- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc index 0ef6a6c29..a232bd839 100644 --- a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc +++ b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc @@ -63,7 +63,7 @@ After the deployment of your {product_name} project is successful, you can verif + For more information, see xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-openshift-integration.adoc[Integrating your {product_name} project with OpenShift using {serverless_logic_web_tools_name}]. * Your {product_name} project is deployed successfully. -* Deployed project must be deployed using the *Deploy as a project* option as unchecked, as the deployment page is only available using the pre-built image container. If the option *Deploy as a project* option is checked the tool opens the `index.html` file your project provides, if any. +* Deployed project must be deployed using the *Deploy as a project* option as unchecked, as the deployment page is only available using the pre-built image container. If *Deploy as a project* option is checked, the tool opens the `index.html` file your project provides, if any. .Procedure . Click on the *OpenShift deployments* icon to view a list of deployments. diff --git a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc index 5a0eb2107..0a919a3ce 100644 --- a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc +++ b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc @@ -14,7 +14,7 @@ This document describes how you can configure the integration and synchronize yo You can generate a token from your GitHub account and add the token to the {serverless_logic_web_tools_name}. .Prerequisites -* You have an account in GitHub. +* You have a GitHub account. .Procedure . Go to link:{serverless_logic_web_tools_url}[{serverless_logic_web_tools_name}] web application, and click the *Cogwheel* (⚙️) in the top-right corner of the screen. @@ -28,7 +28,7 @@ Ensure that you select the *repo* option. . Optionally, select *gist*, which enables you to import and update gists. . Copy the generated token and paste it into the *Token* field in {serverless_logic_web_tools_name} GitHub *Settings*. + -The contents of the tab are updated and displays that you are signed into the GitHub and contains all the required permissions. +The contents of the tab are updated and display that you are signed into GitHub and have all the required permissions. [[proc-sync-workspace-github-serverless-logic-web-tools]] == Synchronizing your workspaces with GitHub diff --git a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc index e80b1cf53..9ad800835 100644 --- a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc +++ b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc @@ -18,7 +18,7 @@ The {serverless_logic_web_tools_name} provides three different editors for your [[proc-create-workflow-model-web-tools]] == Creating a workflow model in {serverless_logic_web_tools_name} -You can start by creating a new model from scratch or using one of the samples provided. +You can start by creating a new model from scratch or using one of the samples provided. The samples are available in the "Sample Catalog", which you can find in the menu on the left. Additionally, there is an option to import models, available on the main page of the application. .Procedure . Go to the link:{serverless_logic_web_tools_url}[{serverless_logic_web_tools_name}] web application. diff --git a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-redhat-application-services-integration.adoc b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-redhat-application-services-integration.adoc index 981670ebf..83efa6202 100644 --- a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-redhat-application-services-integration.adoc +++ b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-logic-web-tools/serverless-logic-web-tools-redhat-application-services-integration.adoc @@ -9,7 +9,7 @@ Some of the features in {serverless_logic_web_tools_name} require integration wi This document describes how you can configure the required settings to complete the integration with Red Hat OpenShift Application and Data Services. [[proc-create-service-account-serverless-logic-web-tools]] -== Creating a service account in Red Hat OpenShift application and Data Services +== Creating a service account in Red Hat OpenShift Application and Data Services You can create or use a service account from your Red Hat OpenShift Application and Data Services console and add the service account to the {serverless_logic_web_tools_name}. @@ -44,7 +44,7 @@ The content in the *Service Account* tab updates and displays *Your Service Acco [[proc-create-service-registry-serverless-logic-web-tools]] -== Creating a Service Registry in Red Hat OpenShift application and Data Services +== Creating a Service Registry in Red Hat OpenShift Application and Data Services You can create or use a Service Registry instance from your Red Hat OpenShift Application and Data Services console and add the Service Registry to {serverless_logic_web_tools_name}. @@ -52,7 +52,7 @@ You can create or use a Service Registry instance from your Red Hat OpenShift Ap * You have access to the Red Hat OpenShift Application and Data Services console. * You have created a service account. + -For information about creating a service account, see <>. +For information about creating a service account, see <>. .Procedure . To create a Service Registry instance in Red Hat Openshift Application and Data Services console, perform the following steps: @@ -74,7 +74,7 @@ The list of Service Registry instances updates with your instance. + [IMPORTANT] ==== -You must select the role as Manager or Administrator to have the read and write access. +You must select the role of Manager or Administrator to have read and write access. ==== .. Click *Save*. diff --git a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc index e2b75588b..b059c1153 100644 --- a/serverlessworkflow/modules/ROOT/pages/tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc +++ b/serverlessworkflow/modules/ROOT/pages/tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc @@ -50,7 +50,7 @@ For more information, see <