Skip to content

Create get started page for OpenShift in VSCode Open walkthrough#2441

Merged
mohitsuman merged 31 commits intoredhat-developer:mainfrom
msivasubramaniaan:2414-create-get-started-for-openshift-in-vscode-open-walkthrough
Jun 16, 2022
Merged

Create get started page for OpenShift in VSCode Open walkthrough#2441
mohitsuman merged 31 commits intoredhat-developer:mainfrom
msivasubramaniaan:2414-create-get-started-for-openshift-in-vscode-open-walkthrough

Conversation

@msivasubramaniaan
Copy link
Copy Markdown
Collaborator

Added Walkthrough steps for the extension

Ref: #2414

@msivasubramaniaan msivasubramaniaan self-assigned this May 31, 2022
@msivasubramaniaan msivasubramaniaan linked an issue May 31, 2022 that may be closed by this pull request
2 tasks
@codecov
Copy link
Copy Markdown

codecov bot commented May 31, 2022

Codecov Report

Merging #2441 (be5d77c) into main (ccc7750) will decrease coverage by 0.03%.
The diff coverage is 40.00%.

@@            Coverage Diff             @@
##             main    #2441      +/-   ##
==========================================
- Coverage   66.62%   66.58%   -0.04%     
==========================================
  Files          55       55              
  Lines        3583     3585       +2     
  Branches      647      648       +1     
==========================================
  Hits         2387     2387              
- Misses       1196     1198       +2     
Impacted Files Coverage Δ
src/openshift/cluster.ts 80.97% <40.00%> (-0.80%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ccc7750...be5d77c. Read the comment docs.

@mohitsuman mohitsuman changed the title Create get started page for open shift in vscode open walkthrough Create get started page for OpenShift in VSCode Open walkthrough Jun 1, 2022
Comment thread package.json Outdated
Comment thread package.json Outdated
Comment thread package.json Outdated
Comment thread package.json Outdated
msivasubramaniaan and others added 6 commits June 2, 2022 12:47
Comment thread package.json Outdated
Comment thread package.json Outdated
Comment thread package.json Outdated
Comment thread package.json Outdated
Copy link
Copy Markdown
Contributor

@mohitsuman mohitsuman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msivasubramaniaan Please update the descriptions accordingly as per the suggestions. We also need to update with the zoom in gifs for every step.

msivasubramaniaan and others added 2 commits June 2, 2022 14:15
Co-authored-by: Mohit Suman <mohit.skn@gmail.com>
Co-authored-by: Mohit Suman <mohit.skn@gmail.com>
Comment thread package.json Outdated
Comment thread package.json Outdated
Comment thread package.json Outdated
@mohitsuman
Copy link
Copy Markdown
Contributor

@msivasubramaniaan the gifs looks good to me. Just commit the suggested changes.

msivasubramaniaan and others added 3 commits June 2, 2022 17:57
Co-authored-by: Mohit Suman <mohit.skn@gmail.com>
Co-authored-by: Mohit Suman <mohit.skn@gmail.com>
Co-authored-by: Mohit Suman <mohit.skn@gmail.com>
@mohitsuman mohitsuman self-requested a review June 2, 2022 12:29
Copy link
Copy Markdown
Contributor

@mohitsuman mohitsuman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread package.json
"description": "Start your application development on OpenShift or Kubernetes",
"steps": [
{
"id": "login",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

This step does not look right to me. Login is just a way to get access to cluster resources and it does not matter how cluster is provisioned or where it is located.

What I see is attempt to mix cluster login, provisioning and location in one step.

I suggest to bubble up one more step. 'Get access to OpenShift cluster' or 'Provision or use existing OpenShift cluster'
Where we can have button to open 'Add Cluster Editor'. Then reduce Login step to just a description and login button.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
Changed the login title and description. Please refer the screenshot

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this covers the use case of differentiating the Login and provision workflow. The description also works for me. LGTM.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it is still two questions answered in one step.

'Connect using OpenShift Local' sounds awkward to me, I would say 'Connect using ssh' or 'Connect to OpenShift using SSH'. Both sounds good to me. Lets try 'Connect to OpenShift Using OpenShift Local' does that sound good? It is not for me.

IMHO first someone who is interested would ask where/how one can get OpenShift instance? Then ask how to work with it or see what is in it through the UI elements provided by extension they've just installed and that would require to log into the cluster.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here OpenShift local refers to renamed CodeReadyContainers. So connect using OpenShift local should open the CRC view we currently have.

Copy link
Copy Markdown
Collaborator

@dgolovin dgolovin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, see my comment above.

Signed-off-by: Denis Golovin dgolovin@redhat.com
@dgolovin dgolovin force-pushed the 2414-create-get-started-for-openshift-in-vscode-open-walkthrough branch from 0af18f3 to ae62748 Compare June 16, 2022 03:48
Signed-off-by: Denis Golovin dgolovin@redhat.com
@dgolovin dgolovin force-pushed the 2414-create-get-started-for-openshift-in-vscode-open-walkthrough branch from ae62748 to be5d77c Compare June 16, 2022 04:17
@mohitsuman mohitsuman merged commit 84701b0 into redhat-developer:main Jun 16, 2022
@msivasubramaniaan msivasubramaniaan deleted the 2414-create-get-started-for-openshift-in-vscode-open-walkthrough branch June 20, 2022 09:54
msivasubramaniaan added a commit to msivasubramaniaan/vscode-openshift-tools that referenced this pull request Jul 26, 2022
…hat-developer#2441)

* added walthrough in package.json

* added steps on the walkthrough

* changed title and description of the steps

* added additional login option and post corresponding message

* Update login description in package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* Update debug description in package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* Update login title in package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* added show registry step and updated the gifs

* used the exisiting message passing

* Update open browser desc package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* Update create component desc package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* Update push component desc package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* updated desc and gifs

* updated desc of show registries

* added openInView into onCommand for makes the step get completes

* Update the main desc package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* Update the login desc package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* Update the show registry desc package.json

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>

* updated the vscode-openshift-tools.gif

* updated the vscode-openshift-tools.gif

* reverted the gif

* change login title and desc

* Add activation event and Provision OpenShift cluster button

Signed-off-by: Denis Golovin dgolovin@redhat.com

* Revert "Add activation event and Provision OpenShift cluster button"

This reverts commit 5e88ae8.

* Rename 'Connect using ...' to 'Provision ...'

Signed-off-by: Denis Golovin dgolovin@redhat.com

Co-authored-by: Mohit Suman <mohit.skn@gmail.com>
Co-authored-by: Denis Golovin <dgolovin@redhat.com>
Signed-off-by: msivasubramaniaan <msivasub@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Get Started for OpenShift in VSCode Open Walkthrough

3 participants