You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2021/06/03 20:40:03 UTC
[GitHub] [openwhisk-vscode-extension] rabbah commented on a change in pull request #13: Review and update README instructions
rabbah commented on a change in pull request #13:
URL: https://github.com/apache/openwhisk-vscode-extension/pull/13#discussion_r645110341
##########
File path: README.md
##########
@@ -61,16 +61,28 @@ This extension contributes the following commands to the Command palette.
- `Create a wskdeploy project`: creates a wskdeploy project
-## How to debug in your local
+## How to debug in your local environment
-```bash
-git clone https://github.com/apache/openwhisk-vscode-extension.git
-code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VSCode
-```
+### Requirements
+
+- [vscode](https://code.visualstudio.com/) >= 1.41.0
+- [Node.js](https://nodejs.org/en/download/) >= 12.x
+- Have a OpenWhisk deployment available, can get set up by following [guide](https://openwhisk.apache.org/documentation.html#pre-requisites)
+
+### Set up
+
+1. Clone the repository:
-Press `F5` button(run debug)
+ ```bash
+ git clone https://github.com/apache/openwhisk-vscode-extension.git
+ code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VS Code
+ ```
-Learn more about debugging [here](https://github.com/apache/openwhisk-vscode-extension/blob/master/vsc-extension-quickstart.md)
+2. In terminal execute command `npm install` to install extension dependencies
+3. In terminal execute command `npm run webpack-dev` to start up the extension builder in watch mode (allows for making changes to files and rebuilding automatically)
Review comment:
```suggestion
3. In your terminal, execute the command `npm run webpack-dev` to start up the extension builder in watch mode (allows for making changes to files and rebuilding automatically)
```
##########
File path: README.md
##########
@@ -61,16 +61,28 @@ This extension contributes the following commands to the Command palette.
- `Create a wskdeploy project`: creates a wskdeploy project
-## How to debug in your local
+## How to debug in your local environment
-```bash
-git clone https://github.com/apache/openwhisk-vscode-extension.git
-code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VSCode
-```
+### Requirements
+
+- [vscode](https://code.visualstudio.com/) >= 1.41.0
+- [Node.js](https://nodejs.org/en/download/) >= 12.x
+- Have a OpenWhisk deployment available, can get set up by following [guide](https://openwhisk.apache.org/documentation.html#pre-requisites)
+
+### Set up
+
+1. Clone the repository:
-Press `F5` button(run debug)
+ ```bash
+ git clone https://github.com/apache/openwhisk-vscode-extension.git
+ code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VS Code
+ ```
-Learn more about debugging [here](https://github.com/apache/openwhisk-vscode-extension/blob/master/vsc-extension-quickstart.md)
+2. In terminal execute command `npm install` to install extension dependencies
Review comment:
```suggestion
2. In your terminal, execute the command `npm install` to install extension dependencies
```
##########
File path: README.md
##########
@@ -61,16 +61,28 @@ This extension contributes the following commands to the Command palette.
- `Create a wskdeploy project`: creates a wskdeploy project
-## How to debug in your local
+## How to debug in your local environment
-```bash
-git clone https://github.com/apache/openwhisk-vscode-extension.git
-code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VSCode
-```
+### Requirements
+
+- [vscode](https://code.visualstudio.com/) >= 1.41.0
+- [Node.js](https://nodejs.org/en/download/) >= 12.x
+- Have a OpenWhisk deployment available, can get set up by following [guide](https://openwhisk.apache.org/documentation.html#pre-requisites)
Review comment:
```suggestion
- Have an OpenWhisk deployment available, which you set up by following [guide](https://openwhisk.apache.org/documentation.html#pre-requisites) or by using one of the managed OpenWhisk offerings (e.g., from IBM, Adobe or Nimbella).
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org