Get Started Walkthrough for vscode knative #276

sudhirverma · 2022-08-04T11:28:24Z

codecov-commenter · 2022-08-04T11:32:32Z

Codecov Report

Merging #276 (b46b2d5) into main (01c64f6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #276   +/-   ##
=======================================
  Coverage   77.19%   77.19%           
=======================================
  Files          87       87           
  Lines        3561     3561           
  Branches      604      604           
=======================================
  Hits         2749     2749           
  Misses        812      812

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

lstocchi

By a quick glance it looks good. I would change something in the descriptions but i'll leave the english review to Mohit as i suck.
Only 3 notes:

maybe it's better to add an action in the create new function step that opens up the wizard to create a func. In IJ i cannot do it as the plugin works with all Jetbrains IDEs (IJ, GoLand, Pycharm,...) and they work differently but in vscode i guess it should be easier.
Is it really necessary to have the add/remove env variable/volumes explained?
in the invoke step i would mention the function need to be run before to invoke it.

sudhirverma · 2022-08-05T09:16:29Z

2. Is it really necessary to have the add/remove env variable/volumes explained?

@mohitsuman should we include the add/remove env variable/volumes in getting started or should I skip it?

mohitsuman · 2022-08-06T11:58:44Z

package.json

+    "walkthroughs": [
+      {
+        "id": "knativeWalkthrough",
+        "title": "Getting started with Knative",


Suggested change

"title": "Getting started with Knative",

"title": "Getting Started with Knative and Serverless Functions",

mohitsuman · 2022-08-06T12:02:27Z

package.json

+      {
+        "id": "knativeWalkthrough",
+        "title": "Getting started with Knative",
+        "description": "Start managing serverless applications on OpenShift and Kubernetes",


Suggested change

"description": "Start managing serverless applications on OpenShift and Kubernetes",

"description": "Develop & Deploy Serverless Functions using VSCode",

mohitsuman · 2022-08-06T12:15:03Z

package.json

+        "steps": [
+          {
+            "id": "Create Function",
+            "title": "Create a new function project",


Suggested change

"title": "Create a new function project",

"title": "Create Function",

mohitsuman · 2022-08-06T12:19:31Z

package.json

+          {
+            "id": "Create Function",
+            "title": "Create a new function project",
+            "description": "To create a new function click on \"plus icon(Create Function)\" in Functions view title.\n By providing Name, selecting language eg:(go, node, python, quarkus, rust, springboot and typescript), selecting template eg:(http or cloudevents), selecting location, and click on create function. The new function is now visible in the Function tree view.",


Suggested change

"description": "To create a new function click on \"plus icon(Create Function)\" in Functions view title.\n By providing Name, selecting language eg:(go, node, python, quarkus, rust, springboot and typescript), selecting template eg:(http or cloudevents), selecting location, and click on create function. The new function is now visible in the Function tree view.",

"description": "Creates a Function in the mentioned directory with the specified language/runtime selected and handles HTTP events.",

Also add a Button to Create Component below the description. This will directly open the webview to select the workflow.

mohitsuman · 2022-08-06T12:26:33Z

package.json

+          },
+          {
+            "id": "Build Function",
+            "title": "Build function",


Suggested change

"title": "Build function",

"title": "Build Function",

mohitsuman · 2022-10-08T14:24:04Z

package.json

+          {
+            "id": "Invoke Function",
+            "title": "Invoke a Function",
+            "description": "Invokes the Function by sending a request to the current running Function instance, either locally or remote.\nOnly a function which has the source code opened in the IDE can be invoked. Right click on the function you want to invoke (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Invoke\". Provide all necessary details and click on invoke.",


Suggested change

"description": "Invokes the Function by sending a request to the current running Function instance, either locally or remote.\nOnly a function which has the source code opened in the IDE can be invoked. Right click on the function you want to invoke (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Invoke\". Provide all necessary details and click on invoke.",

"description": "Invokes the function by sending a test request to the currently running function instance, either locally or remote.\nOnly a function which has the source code opened in the IDE can be invoked. Right-click on the function you want to invoke (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Invoke\". Provide all necessary details and click on Invoke.",

mohitsuman · 2022-10-08T14:26:06Z

package.json

+          {
+            "id": "Add environment variable",
+            "title": "Add environment variable to the function configuration",
+            "description": "Only a function which has the source code opened in the IDE can be configure to add environment variables.\n Right click on the function you want to add environment variables (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Add Config\" and then click on \"Add Environment Variables\". An Interactive prompt will open in terminal to add Environment variables.",


Suggested change

"description": "Only a function which has the source code opened in the IDE can be configure to add environment variables.\n Right click on the function you want to add environment variables (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Add Config\" and then click on \"Add Environment Variables\". An Interactive prompt will open in terminal to add Environment variables.",

"description": "Only a function which has the source code opened in the IDE can be configured to add environment variables.\n Right-click on the function you want to add environment variables (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \" Add Config\" and then click on \" Add Environment Variables\". An Interactive prompt will open in the terminal to add Environment variables.",

mohitsuman · 2022-10-08T14:26:40Z

package.json

+          {
+            "id": "Add volumes",
+            "title": "Add volume to the function configuration.",
+            "description": "Only a function which has the source code opened in the IDE can be configure to add volumes.\n Right click on the function you want to add volume (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Add Config\" and then click on \"Add volumes\". An Interactive prompt will open in terminal to add Secrets and ConfigMaps as Volume.",


Suggested change

"description": "Only a function which has the source code opened in the IDE can be configure to add volumes.\n Right click on the function you want to add volume (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Add Config\" and then click on \"Add volumes\". An Interactive prompt will open in terminal to add Secrets and ConfigMaps as Volume.",

"description": "Only a function which has the source code opened in the IDE can be configured to add volumes.\n Right-click on the function you want to add volume (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \" Add Config\" and then click on \" Add volumes\". An Interactive prompt will open in the terminal to add Secrets and ConfigMaps as Volume.",

mohitsuman · 2022-10-08T14:26:57Z

package.json

+          {
+            "id": "Remove environment variable",
+            "title": "Remove environment variable from the function configuration",
+            "description": "Only a function which has the source code opened in the IDE can be configure to remove environment variables.\n Right click on the function you want to remove environment variables (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Remove Config\" and then click on \"Remove Environment Variables\". An Interactive prompt will open in terminal to remove environment variables.",


Suggested change

"description": "Only a function which has the source code opened in the IDE can be configure to remove environment variables.\n Right click on the function you want to remove environment variables (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Remove Config\" and then click on \"Remove Environment Variables\". An Interactive prompt will open in terminal to remove environment variables.",

"description": "Only a function which has the source code opened in the IDE can be configured to remove environment variables.\n Right-click on the function you want to remove environment variables (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Remove Config\" and then click on \"Remove Environment Variables\". An Interactive prompt will open in the terminal to remove environment variables.",

mohitsuman · 2022-10-08T14:27:15Z

package.json

+          {
+            "id": "Remove volumes",
+            "title": "Remove volume from the function configuration",
+            "description": "Only a function which has the source code opened in the IDE can be configure to remove volumes.\n Right click on the function you want to remove volume (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Remove Config\" and then click on \"Remove volumes\". An Interactive prompt will open in terminal to remove volume mounts from the function.",


Suggested change

"description": "Only a function which has the source code opened in the IDE can be configure to remove volumes.\n Right click on the function you want to remove volume (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Remove Config\" and then click on \"Remove volumes\". An Interactive prompt will open in terminal to remove volume mounts from the function.",

"description": "Only a function which has the source code opened in the IDE can be configured to remove volumes.\n Right-click on the function you want to remove volume (look for its node in the Functions tree), open the context menu (right-click on the node) and click on \"Remove Config\" and then click on \"Remove volumes\". An Interactive prompt will open in the terminal to remove volume mounts from the function.",

sudhirverma force-pushed the 262 branch from 8a003cf to ba4002c Compare August 4, 2022 15:59

sudhirverma requested review from mohitsuman and lstocchi August 4, 2022 16:10

sudhirverma changed the title ~~Get Started Walkthrough for vscode knative [WIP]~~ Get Started Walkthrough for vscode knative Aug 4, 2022

lstocchi reviewed Aug 5, 2022

View reviewed changes

sudhirverma added 2 commits August 24, 2022 13:30

Get Started Walkthrough for vscode knative

eb48997

Fix tetilr and description

729dec9

sudhirverma force-pushed the 262 branch from ba4002c to 729dec9 Compare August 24, 2022 08:00

mohitsuman requested changes Oct 8, 2022

View reviewed changes

Fix description and title

1da6485

sudhirverma requested a review from mohitsuman October 10, 2022 09:34

mohitsuman approved these changes Oct 10, 2022

View reviewed changes

mohitsuman merged commit 9e06c3a into redhat-developer:main Oct 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get Started Walkthrough for vscode knative #276

Get Started Walkthrough for vscode knative #276

sudhirverma commented Aug 4, 2022

codecov-commenter commented Aug 4, 2022 •

edited

Loading

lstocchi left a comment •

edited

Loading

sudhirverma commented Aug 5, 2022

mohitsuman Aug 6, 2022

mohitsuman Aug 6, 2022

mohitsuman Aug 6, 2022

mohitsuman Aug 6, 2022

mohitsuman Aug 6, 2022

mohitsuman Aug 6, 2022

mohitsuman Oct 8, 2022

mohitsuman Oct 8, 2022

mohitsuman Oct 8, 2022

mohitsuman Oct 8, 2022

mohitsuman Oct 8, 2022

	"title": "Getting started with Knative",
	"title": "Getting Started with Knative and Serverless Functions",

	"description": "Start managing serverless applications on OpenShift and Kubernetes",
	"description": "Develop & Deploy Serverless Functions using VSCode",

	"title": "Create a new function project",
	"title": "Create Function",

	"description": "To create a new function click on \"plus icon(Create Function)\" in Functions view title.\n By providing Name, selecting language eg:(go, node, python, quarkus, rust, springboot and typescript), selecting template eg:(http or cloudevents), selecting location, and click on create function. The new function is now visible in the Function tree view.",
	"description": "Creates a Function in the mentioned directory with the specified language/runtime selected and handles HTTP events.",

Get Started Walkthrough for vscode knative #276

Get Started Walkthrough for vscode knative #276

Conversation

sudhirverma commented Aug 4, 2022

codecov-commenter commented Aug 4, 2022 • edited Loading

Codecov Report

lstocchi left a comment • edited Loading

Choose a reason for hiding this comment

sudhirverma commented Aug 5, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Aug 4, 2022 •

edited

Loading

lstocchi left a comment •

edited

Loading