Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update quick start guid on vscode #1065

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: "🐞 Report a Bug"
description: Create an issue if something does not work as expected.
labels: ["Type/Bug"]
body:
- type: textarea
id: background
attributes:
label: Description
description: Please share a clear and concise description of the problem.
placeholder: Description
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: List the steps you followed when you encountered the issue. Provide sample source code to reproduce the issue where applicable.
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Enter product/component version.
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment Details (with versions)
description: Mention the environment details (OS, Client, etc.) that the product is running on.
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: General Question
url: https://stackoverflow.com/questions/tagged/wso2-micro-integrator
about: "If you have a question then please ask on Stack Overflow using the #wso2-micro-integrator tag."
- name: Chat on help-micro-integrator Discord Channel
url: https://discord.com/invite/Xa5VubmThw
about: "Chat about anything else with the community."
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "🚀 Improvement Request"
description: Suggest an improvement to the product.
labels: ["Type/Improvement"]
body:
- type: textarea
id: limitation
attributes:
label: Current Limitation
description: Describe the the current limitation.
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested Improvement
description: Describe the the improvement you suggest.
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Enter component version.
validations:
required: false
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "💡 New Feature Request"
description: Suggest new functionality and features for the product.
labels: ["Type/NewFeature"]
body:
- type: textarea
id: problem
attributes:
label: Problem
description: What is the problem this feature will solve?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to have.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe any alternatives have you considered
validations:
required: false
- type: input
id: version
attributes:
label: Version
description: Enter product/component version.
validations:
required: false
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: "✍️ Create a Task"
description: Create a new task.
labels: ["Type/Task"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear description of what needs to be done.
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Enter product/component version.
validations:
required: false
14 changes: 6 additions & 8 deletions en/docs/develop/mi-for-vscode/install-wso2-mi-for-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,17 @@ This page walks you through how to get started with the Micro Integrator for VS

## Prerequisites

- Download and install Java SE Development Kit (JDK) version 11 or 17. See [tested JDK versions]({{base_path}}/install-and-setup/setup/reference/product-compatibility/#tested-jdks) for more information.

- Set the `JAVA_HOME` environment variable in the [system settings]({{base_path}}/install-and-setup/install/installing-mi/#setting-up-java_home).

- Download and install [Apache Maven](https://maven.apache.org/download.cgi) (version 3.6.0 onwards).

- Set the path for Apache Maven in the [system's PATH environment variable](https://maven.apache.org/install.html).

- Download and install the Visual Studio Code editor from [here](https://code.visualstudio.com/download).

!!! info
For more information on installing Visual Studio Code, refer to [Visual Studio Code documentation](https://code.visualstudio.com/docs/setup/setup-overview).

!!! Note
The following will be prompt to download by the **Micro Integrator for VS Code** extension if they are not already available when you open your first project:

- **Java Development Kit (JDK)**
- **WSO2 Micro Integrator 4.3.0 Runtime**

## Install the MI VS Code extension

Follow one of the following two options to install the MI VS Code extension.
Expand Down
19 changes: 6 additions & 13 deletions en/docs/get-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,14 @@ In this guide, you'll learn the basics of setting up and using WSO2 MI to create

The following software and configurations are required to proceed with this tutorial:

- **Java Development Kit (JDK):** Version 11 or 17 is required. Set up a [JDK that is compatible]({{base_path}}/install-and-setup/setup/reference/product-compatibility/#tested-jdks). Ensure the JDK is properly configured in your [system's PATH environment variable](({{base_path}}/install-and-setup/install/installing-mi)).

!!! Info
For more information on setting the `JAVA_HOME` environment variable for different operating systems, see the [Install and Setup]({{base_path}}/install-and-setup/install/installing-mi) documentation.

- **Apache Maven:** Ensure [Apache Maven](https://maven.apache.org/download.cgi) is installed (version 3.6.0 onwards) and its path is correctly set within the [system's PATH environment variable](https://maven.apache.org/install.html).

!!! info
For more information on installing Apache Maven, see the [Apache Maven documentation](https://maven.apache.org/install.html).

- **WSO2 Micro Integrator 4.3.0 Runtime:** Set up WSO2 Micro Integrator 4.3.0 runtime on your machine.
1. Download the Micro Integrator 4.3.0 distribution as a ZIP file from [here](https://github.com/wso2/micro-integrator/releases/download/v4.3.0/wso2mi-4.3.0.zip).
2. Extract the ZIP file. Hereafter, this extracted folder will be referred to as the `<MI_HOME>` folder.
- **Visual Studio Code (VS Code):** with the [Micro Integrator for VS Code](https://marketplace.visualstudio.com/items?itemName=WSO2.micro-integrator) extension installed.

!!! Note
The following will be prompt to download by the **Micro Integrator for VS Code** extension if they are not already available when you open your first project:

- **Java Development Kit (JDK)**
- **WSO2 Micro Integrator 4.3.0 Runtime**

After completing the steps above, follow the instructions below to create your first integration solution:

## What you'll build
Expand Down