From 707e7a0b3eea93e66ba6653a29171468c0ae791d Mon Sep 17 00:00:00 2001 From: Sachindu-Nethmin Date: Wed, 18 Mar 2026 08:38:03 +0530 Subject: [PATCH] Update Get Started docs to Microsoft Style Guide and new installer flow - Converted markdown headings and frontmatter titles to sentence case across all 'Get Started' pages. - Removed bold styling from general terms (OS names, hardware, required software) to adhere to Microsoft Style Guide, retaining bold only for UI elements. - Replaced VS Code extension installation instructions with steps for downloading the standalone installer from the WSO2 website. - Updated project creation and runtime instructions to reflect the standalone WSO2 Integrator application instead of the VS Code extension workflow. - Updated documentation references from `VS Code extension` to `WSO2 Integrator IDE`. --- en/docs/get-started/first-project.md | 23 +++++++------ en/docs/get-started/install-ballerina.md | 25 ++++---------- en/docs/get-started/install.md | 37 +++++---------------- en/docs/get-started/key-concepts.md | 28 ++++++++-------- en/docs/get-started/system-requirements.md | 38 +++++++++++----------- en/docs/get-started/understand-the-ide.md | 14 ++++---- 6 files changed, 66 insertions(+), 99 deletions(-) diff --git a/en/docs/get-started/first-project.md b/en/docs/get-started/first-project.md index 41c46eb3..4210b0c7 100644 --- a/en/docs/get-started/first-project.md +++ b/en/docs/get-started/first-project.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -title: Create Your First Project +title: Create your first project description: Generate a new integration project and understand the project structure. --- @@ -8,15 +8,14 @@ description: Generate a new integration project and understand the project struc Create a new WSO2 Integrator project and understand what gets generated. -## Create the Project +## Create the project -1. Open VS Code -2. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`) -3. Select **WSO2 Integrator: Create New Project** -4. Choose a directory and project name -5. The extension generates the project structure +1. Open WSO2 Integrator. +2. Click on **Create New Project** (or go to **File** > **New Project**). +3. Choose a directory and provide a project name. +4. The application generates the project structure. -## Project Structure +## Project structure ``` my-integration/ @@ -28,13 +27,13 @@ my-integration/ └── resources/ # Static resources (schemas, configs) ``` -## Run the Empty Project +## Run the empty project -1. Click the **Run** button in the VS Code toolbar, or -2. Open a terminal and run: `bal run` +1. Click the **Run** button in the WSO2 Integrator toolbar, or +2. Open a terminal, navigate to your project directory, and run: `bal run` 3. You should see the service start successfully -## What's Next +## What's next - [Understand the IDE](understand-the-ide.md) — Learn the visual designer layout - [Build an API Integration](quick-start-api.md) — Your first real integration diff --git a/en/docs/get-started/install-ballerina.md b/en/docs/get-started/install-ballerina.md index 94ef2691..e3a4e0fa 100644 --- a/en/docs/get-started/install-ballerina.md +++ b/en/docs/get-started/install-ballerina.md @@ -6,22 +6,9 @@ description: Download and install the Ballerina distribution that powers WSO2 In # Install Ballerina -WSO2 Integrator is built on the Ballerina programming language. If you're using the WSO2 Integrator VS Code extension, Ballerina is set up automatically. Use this page only if you need a standalone Ballerina installation for CLI-based development. +WSO2 Integrator is built on the Ballerina programming language. Use this page if you need a standalone Ballerina installation for CLI-based development (for CI/CD pipelines, Docker builds, or CLI-only workflows). -## Automatic Installation (Recommended) - -The WSO2 Integrator VS Code extension handles the Ballerina installation for you: - -1. Install the [WSO2 Integrator extension](install.md). -2. Click the **BI** icon in the sidebar. -3. Select **Set up Ballerina distribution** when prompted. -4. Restart VS Code. - -This is the recommended approach for most users. - -## Manual Installation - -If you need Ballerina outside VS Code (for CI/CD pipelines, Docker builds, or CLI-only workflows): +## Installation ### macOS @@ -53,7 +40,7 @@ sudo rpm -i ballerina-2201.13.0-swan-lake-linux-x64.rpm Download the MSI installer from [ballerina.io/downloads](https://ballerina.io/downloads/) and run it. -## Verify Installation +## Verify installation ```bash bal version @@ -64,7 +51,7 @@ Expected output: Ballerina 2201.13.0 (Swan Lake Update 13) ``` -## Managing Multiple Versions +## Managing multiple versions Use the Ballerina Update Tool to manage distributions: @@ -82,7 +69,7 @@ bal dist use 2201.13.0 bal dist update ``` -## What's Next +## What's next -- [Install WSO2 Integrator](install.md) -- Set up the VS Code extension +- [Install WSO2 Integrator](install.md) -- Install the WSO2 Integrator application - [Create Your First Project](first-project.md) -- Generate a project structure diff --git a/en/docs/get-started/install.md b/en/docs/get-started/install.md index a43c86aa..578df1d6 100644 --- a/en/docs/get-started/install.md +++ b/en/docs/get-started/install.md @@ -1,44 +1,25 @@ --- sidebar_position: 4 title: Install WSO2 Integrator -description: Step-by-step installation of the WSO2 Integrator VS Code extension and Ballerina distribution. +description: Step-by-step installation of WSO2 Integrator. --- # Install WSO2 Integrator Get your development environment ready in under 5 minutes. -## Step 1: Install Visual Studio Code +## Download and install -Download and install VS Code from [code.visualstudio.com/download](https://code.visualstudio.com/download). +1. Go to the [WSO2 Integrator downloads page](https://wso2.com/products/downloads/?product=wso2integrator). +2. Enter your business email address to receive a download link. +3. Check your email and click the download link to get the installer for your operating system. +4. Run the downloaded installer and follow the on-screen instructions to complete the setup. -## Step 2: Install the WSO2 Integrator Extension +## Verify installation -1. Open VS Code. -2. Open the Extensions view: - - **Windows / Linux:** `Ctrl + Shift + X` - - **macOS:** `Shift + Cmd + X` -3. Search for **"WSO2 Integrator: BI"**. -4. Click **Install**. +Launch the installed WSO2 Integrator application to verify that the installation was successful. -This installs both the **WSO2 Integrator: BI** extension and the **Ballerina** extension automatically. - -## Step 3: Set Up the Ballerina Distribution - -1. Click the **BI** icon in the VS Code sidebar. -2. Select **"Set up Ballerina distribution"** when prompted. -3. Wait for the download and setup to complete. -4. Restart VS Code. - -## Verify Installation - -After restarting VS Code: - -1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`). -2. Type **"WSO2 Integrator"** -- you should see available commands. -3. Click the **BI** icon in the sidebar to access the integrations view. - -## What's Next +## What's next - [Create Your First Project](first-project.md) -- Generate a project structure - [Understand the IDE](understand-the-ide.md) -- Learn the visual designer diff --git a/en/docs/get-started/key-concepts.md b/en/docs/get-started/key-concepts.md index b1f53fd9..d3a06fff 100644 --- a/en/docs/get-started/key-concepts.md +++ b/en/docs/get-started/key-concepts.md @@ -1,50 +1,50 @@ --- sidebar_position: 3 -title: Key Concepts +title: Key concepts description: The vocabulary you need to understand WSO2 Integrator. --- -# Key Concepts +# Key concepts -This page introduces every major product component in 2–3 sentences. Think of it as your vocabulary guide — it gives you the map. The [Develop](/docs/develop) section is the territory. +This page introduces every major product component in 2–3 sentences. Think of it as your vocabulary guide it gives you the map. The [Develop](/docs/develop) section is the territory. ## Services -Expose your integrations over HTTP, GraphQL, gRPC, WebSocket, or TCP. Services are the most common artifact — they define endpoints that external systems call. → [Build Services](/docs/develop/build/services) +Expose your integrations over HTTP, GraphQL, gRPC, WebSocket, or TCP. Services are the most common artifact they define endpoints that external systems call. → [Build Services](/docs/develop/build/services) ## Automations Scheduled or manually triggered integrations that run without an external request. Use automations for periodic data sync, cleanup tasks, or report generation. → [Build Automations](/docs/develop/build/automations) -## Event Handlers +## Event handlers Reactive integrations triggered by messages from Kafka, RabbitMQ, NATS, or MQTT. Event handlers process streaming data in real time. → [Build Event Handlers](/docs/develop/build/event-handlers) -## File Processors +## File processors Integrations triggered by file arrival on FTP, SFTP, or local directories. Process CSV, JSON, XML, or fixed-width files in batch or one at a time. → [Build File Processing](/docs/develop/build/file-processing) -## AI Agents +## AI agents Intelligent artifacts backed by large language models (LLMs). Agents can reason, use tools, maintain conversation memory, and orchestrate multi-step workflows. → [Build AI Agents](/docs/develop/build/ai-agents) ## Connectors -Pre-built modules for connecting to external systems — Salesforce, databases, Kafka, OpenAI, and 200+ more. Each connector handles authentication, serialization, and error handling. → [Connectors](/docs/connectors) +Pre-built modules for connecting to external systems Salesforce, databases, Kafka, OpenAI, and 200+ more. Each connector handles authentication, serialization, and error handling. → [Connectors](/docs/connectors) -## Visual Data Mapper +## Visual data mapper A drag-and-drop data transformation tool in the VS Code extension. Map fields between source and target schemas visually, with AI-assisted suggestions. → [Visual Data Mapper](/docs/develop/transform/data-mapper) -## Natural Functions +## Natural functions LLM calls treated as typed function calls in your integration code. Define an input type and output type, and the platform handles the prompt, API call, and response parsing. → [AI Agents & Natural Functions](/docs/develop/build/ai-agents) ## Config.toml -The file where you define environment-specific configuration — database URLs, API keys, feature flags. Different environments (dev, test, prod) get different Config.toml files. → [Configuration Management](/docs/develop/build/configuration-management) +The file where you define environment-specific configuration database URLs, API keys, feature flags. Different environments (dev, test, prod) get different Config.toml files. → [Configuration Management](/docs/develop/build/configuration-management) -## Integration Control Plane (ICP) +## Integration control plane (ICP) A dashboard for monitoring, managing, and troubleshooting running integrations in production. View logs, metrics, and trace requests across services. → [ICP](/docs/deploy-operate/observe/icp) @@ -52,6 +52,6 @@ A dashboard for monitoring, managing, and troubleshooting running integrations i The programming language powering everything under the hood. You don't need to be a Ballerina expert to use the visual designer, but knowing the basics unlocks pro-code capabilities. → [Working with Ballerina Pro-Code](/docs/develop/build/ballerina-pro-code) -## Low-Code ↔ Pro-Code +## Low-code ↔ pro-code -Seamless switching between the visual designer and the code editor. Changes in one view are instantly reflected in the other. This is not a code generation tool — it's a bidirectional sync. +Seamless switching between the visual designer and the code editor. Changes in one view are instantly reflected in the other. This is not a code generation tool it's a bidirectional sync. diff --git a/en/docs/get-started/system-requirements.md b/en/docs/get-started/system-requirements.md index f11dce68..dce44328 100644 --- a/en/docs/get-started/system-requirements.md +++ b/en/docs/get-started/system-requirements.md @@ -1,41 +1,41 @@ --- sidebar_position: 1 -title: System Requirements & Prerequisites +title: System requirements & prerequisites description: Hardware, software, and network requirements for WSO2 Integrator development. --- -# System Requirements & Prerequisites +# System requirements & prerequisites Before you install WSO2 Integrator, make sure your development environment meets these requirements. -## Hardware Requirements +## Hardware requirements | Component | Minimum | Recommended | |-----------|---------|-------------| -| **Processor** | 0.2 core (1.0--1.2 GHz) | 1+ core | -| **Memory (Heap)** | 512 MB | 1 GB+ | -| **Disk Space** | 2 GB free | 5+ GB free | +| Processor | 0.2 core (1.0--1.2 GHz) | 1+ core | +| Memory (Heap) | 512 MB | 1 GB+ | +| Disk space | 2 GB free | 5+ GB free | -## Supported Operating Systems +## Supported operating systems | OS | Minimum Version | |---|---| -| **Windows** | Windows 10 or later | -| **Ubuntu** | 24.04 LTS | -| **Red Hat Enterprise Linux** | RHEL 9 | -| **macOS** | macOS 14.6 (Sonoma) or later | +| Windows | Windows 10 or later | +| Ubuntu | 24.04 LTS | +| Red Hat Enterprise Linux | RHEL 9 | +| macOS | macOS 14.6 (Sonoma) or later | ARM architectures are supported, including Apple Silicon (M1/M2/M3/M4) and ARM-based Linux. -## Software Requirements +## Software requirements | Software | Version | Notes | |----------|---------|-------| -| **Visual Studio Code** | Latest stable | Primary IDE -- download from [code.visualstudio.com](https://code.visualstudio.com/download) | -| **Java Runtime (JRE)** | 21 | Required for the Ballerina runtime | -| **Docker** | 20.10+ | Optional -- for containerized deployment | +| Visual Studio Code | Latest stable | Primary IDE -- download from [code.visualstudio.com](https://code.visualstudio.com/download) | +| Java Runtime (JRE) | 21 | Required for the Ballerina runtime | +| Docker | 20.10+ | Optional -- for containerized deployment | -### Supported Java Distributions +### Supported Java distributions Any JRE 21 distribution works. Tested distributions: @@ -46,7 +46,7 @@ Any JRE 21 distribution works. Tested distributions: | OpenJRE | 21 | | Oracle JRE | 21 | -### Java Setup +### Java setup Install a supported JDK/JRE: @@ -77,7 +77,7 @@ export JAVA_HOME=$(/usr/libexec/java_home -v 21) export JAVA_HOME=/usr/lib/jvm/java-21-openjdk-amd64 ``` -## Network Requirements +## Network requirements The development environment needs internet access for: @@ -88,6 +88,6 @@ The development environment needs internet access for: If you're behind a corporate proxy, configure proxy settings in VS Code and in your terminal environment. -## What's Next +## What's next - [Install WSO2 Integrator](install.md) -- Install the VS Code extension and set up Ballerina diff --git a/en/docs/get-started/understand-the-ide.md b/en/docs/get-started/understand-the-ide.md index 54580ec5..ecb84def 100644 --- a/en/docs/get-started/understand-the-ide.md +++ b/en/docs/get-started/understand-the-ide.md @@ -1,24 +1,24 @@ --- sidebar_position: 6 title: Understand the IDE -description: Walkthrough of the VS Code visual designer and development tools. +description: Walkthrough of the WSO2 Integrator visual designer and development tools. --- # Understand the IDE -A quick tour of the WSO2 Integrator VS Code extension and its key features. +A quick tour of the WSO2 Integrator IDE and its key features. -## Visual Designer +## Visual designer -The visual designer shows your integration as a flow diagram. Each node represents a step — receiving a request, calling a connector, transforming data, or returning a response. +The visual designer shows your integration as a flow diagram. Each node represents a step receiving a request, calling a connector, transforming data, or returning a response. -## Low-Code ↔ Pro-Code Switching +## Low-code ↔ pro-code switching Click the toggle button to switch between the visual designer and the Ballerina code editor. Changes made in either view are instantly synced to the other. -## Key UI Elements +## Key UI elements 1. **Project Explorer** — Browse your integration artifacts, connectors, and resources 2. **Artifact Panel** — Add new services, automations, event handlers, or AI agents @@ -27,6 +27,6 @@ Click the toggle button to switch between the visual designer and the Ballerina 5. **Try-It Tool** — Send test requests to running services 6. **Data Mapper** — Open the visual data transformation tool -## What's Next +## What's next - [Build an API Integration](quick-start-api.md) — Put the IDE to work