Skip to content

Commit

Permalink
Issue-590 Holistic review of non-quarkus tooling guides
Browse files Browse the repository at this point in the history
  • Loading branch information
barboras7 committed May 27, 2024
1 parent 692ab3e commit 5bd5af8
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}.

Expand Down Expand Up @@ -44,15 +44,15 @@ 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}.

.Prerequisites
* 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 <<proc-create-service-account-serverless-logic-web-tools, Creating a service account in Red Hat OpenShift application and Data Services>>.
For information about creating a service account, see <<proc-create-service-account-serverless-logic-web-tools, Creating a service account in Red Hat OpenShift Application and Data Services>>.

.Procedure
. To create a Service Registry instance in Red Hat Openshift Application and Data Services console, perform the following steps:
Expand All @@ -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*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ For more information, see <<proc-install-chrome-extension-sw-editor, Installing

.Procedure
. Create a workflow file (`.sw.json` or `.sw.yaml`).
. Push the created workflow file to GitHub, or you can go to the GitHub page and click on the workflow file to open in the editor.
. Push the created workflow file to GitHub, or go to the GitHub page and click on the workflow file to open it in the editor.
+
--
.Serverless Workflow file in GitHub(read-only mode)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ The Serverless Workflow editor contains the following main features:
+
[NOTE]
====
The editor performs validation using JSON schema to the workflow file structure but not the values, and auto-completion works with JSON but not with YAML.
The editor performs validation using JSON schema for the workflow file structure but not for the values, and auto-completion works with JSON but not with YAML.
====

The following extensions are provided that you can use to design the workflow files:

* xref:tooling/serverless-workflow-editor/swf-editor-vscode-extension.adoc[VS Code extension]
* xref:tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc[Chrome GitHub extension]

You can also try it at the xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc[{serverless_logic_web_tools_name}].
You can try designing also online in your browser, see more information at xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc[{serverless_logic_web_tools_name}].


== Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This document describes how to install and use the VS Code extension for Serverl
[[proc-install-vscode-extension-sw-editor]]
== Installing the VS Code Extension for Serverless Workflow editor

Using the VS Code extension for Serverless Workflow editor, enables you to view and edit the workflow specification files in your local projects.
VS Code extension for Serverless Workflow editor enables you to view and edit the workflow specification files in your local projects.

.Serverless Workflow VS Code extension
image::tooling/serverless-workflow-editor/swf-editor-vscode-extension-page.png[]
Expand All @@ -36,7 +36,7 @@ image::tooling/serverless-workflow-editor/swf-editor-vscode-marketplace.png[]
* *Download VSIX file*:
+
--
.. Download the latest {product_name} VS Code extension VSIX file from the link:{kie_tools_releases_page_url}[kie-tools] releases page in GitHub.
.. Download the latest {product_name} VS Code extension VSIX file from the link:{kie_tools_releases_page_url}[kie-tools] releases page in GitHub. Under the specific release of your choice, click "Assets" to see the full list of assets and click on the desired file to download it.

.. Click *Install from VSIX* option from the extensions menu and install the `serverless_workflow_vscode_extension_VERSION.vsix` file in VS Code.

Expand All @@ -46,7 +46,7 @@ image::tooling/serverless-workflow-editor/swf-editor-vscode-vsix-package.png[]

. Once installation is complete, you can create a workflow file or open an existing workflow file in VS Code.
+
When you open a workflow file, VS Code uses the extension automatically.
When you open a workflow file, VS Code uses the installed extension automatically.

== Features in Serverless Workflow editor

Expand Down Expand Up @@ -74,7 +74,7 @@ image::tooling/serverless-workflow-editor/swf-editor-auto-complete-function-refe

Once you select an option from the auto-complete dialog box, a function reference is added with proper reference name and attributes.
--
* Validation: The Serverless Workflow editor performs validation on the workflow files and provides an error-free experience.
* Validation: The Serverless Workflow editor performs validation on the workflow files providing an error-free experience.

[[ref-supported-commands-vscode-extension]]
== Supported commands in Serverless Workflow VS Code extension
Expand Down Expand Up @@ -307,7 +307,7 @@ image::tooling/serverless-workflow-editor/swf-editor-refresh-registry.png[]

[NOTE]
====
The Serverless Workflow editor performs validation using JSON schema to the workflow file structure but not the values, and auto-completion works with JSON but not with YAML.
The Serverless Workflow editor performs validation using JSON schema for the workflow file structure but not for the values, and auto-completion works with JSON but not with YAML.
====

To view the validation warnings and errors, go to *View* → *Problems* or press *Ctrl+Shift+M* to open the *Problems* tab.
Expand Down

0 comments on commit 5bd5af8

Please sign in to comment.