Skip to content

Add a new Getting Started experience using the new walkthroughs feature#3171

Merged
bwateratmsft merged 30 commits intomainfrom
bmw/gettingStarted2.0
Sep 9, 2021
Merged

Add a new Getting Started experience using the new walkthroughs feature#3171
bwateratmsft merged 30 commits intomainfrom
bmw/gettingStarted2.0

Conversation

@ucheNkadiCode
Copy link
Contributor

@ucheNkadiCode ucheNkadiCode commented Aug 25, 2021

Implements #3055

[bwateratmsft writing below]

Overview

The walkthrough appears as such on the welcome page:
image

If there are Dockerfiles or compose files in the workspace, it is rendered more prominently:
image

Initial view of the page:
image

Steps

Add Docker Files to Workspace

image

Condition to appear: A workspace folder is open
Condition to complete: Running either of the "Add Dockerfiles" or "Add Compose files" commands

Build an Image

image

Condition to appear: A workspace folder is open
Condition to complete: Running the "Build Image" command

Run a Container

image

Condition to appear: Always
Condition to complete: Running either "Run Image", "Compose Up", or "Compose Up (Select Services)", or having run a container in the past (same logic we use to decide whether to show "getting started" or "no containers running" in the explorer view for containers)

Use the Docker Explorer

image

Condition to appear: Always
Condition to complete: Opening the explorer (either via the left side tab or by clicking this button)
Additional note: Clicking the link for "Azure Account extension" will directly open the marketplace page for it within VS Code, so you can immediately install

Push an Image to a Container Registry

image

Condition to appear: Always
Condition to complete: Running the "Push Image" command

Deploy to Azure App Service

image

Condition to appear: Only if the Azure Account extension is installed, and activated (you can activate by opening the explorer view)
Condition to complete: Running either of the "Deploy to App Service" or "Deploy to ACI" commands
Additional note: I'd like to eliminate the requirement to activate the Azure Account extension but unfortunately this is a limitation we cannot work around

Learn More

image

Condition to appear: Always
Condition to complete: When this step is selected
Additional note: The links, in order of appearance: debug a container, run multiple containers, documentation

@ucheNkadiCode ucheNkadiCode requested a review from a team as a code owner August 25, 2021 23:35
@bwateratmsft bwateratmsft changed the title bmw/gettingStarted2.0 Add a new Getting Started experience using the new walkthroughs feature Aug 31, 2021
@bwateratmsft bwateratmsft linked an issue Sep 1, 2021 that may be closed by this pull request
@bwateratmsft
Copy link
Collaborator

bwateratmsft commented Sep 8, 2021

@ucheNkadiCode @BigMorty I added a ton of screenshots and comments to the first comment (from Uche) on this PR. Please take a look. Included is commentary on when the steps will appear and what is needed to complete them.

Please note, these are screenshots of GIFs, so the GIF is frozen wherever it was when I took the screenshot. You can see all the GIFs here.

If you want to test this out yourself:

  1. Get the latest VSCode Insiders build
  2. Install from VSIX: https://dev.azure.com/ms-azuretools/_apis/resources/Containers/5381693/vsix?itemPath=vsix%2Fvscode-docker-1.16.5-alpha.vsix

@ucheNkadiCode
Copy link
Contributor Author

@ucheNkadiCode @BigMorty I added a ton of screenshots and comments to the first comment (from Uche) on this PR. Please take a look. Included is commentary on when the steps will appear and what is needed to complete them.

Please note, these are screenshots of GIFs, so the GIF is frozen wherever it was when I took the screenshot. You can see all the GIFs here.

If you want to test this out yourself:

  1. Get the latest VSCode Insiders build
  2. Install from VSIX: https://dev.azure.com/ms-azuretools/_apis/resources/Containers/5381693/vsix?itemPath=vsix%2Fvscode-docker-1.16.5-alpha.vsix

@bwateratmsft Will the VSIX ultimately have a gif? Because otherwise both the Build an Image and Run an image gifs are frozen in the wrong place. I'd like for the mouse to be hovering over the specific command and highlighting it blue.

@ucheNkadiCode
Copy link
Contributor Author

ucheNkadiCode commented Sep 8, 2021

@bwateratmsft I don't know if I'm a fan of already checking off the "run a container" green if they have already run a container sometime in the past. I find this inconsistent since they may have already built an image or scaffolded a Dockerfile once in the past. Wouldn't we want them to step through the walkthrough and complete each step rather than keep a history of what they've done?

@bwateratmsft
Copy link
Collaborator

@bwateratmsft Will the VSIX ultimately have a gif? Because otherwise both the Build an Image and Run an image gifs are frozen in the wrong place. I'd like for the mouse to be hovering over the specific command and highlighting it blue.

Not the VSIX, but they will be loaded from the web. Don't worry, the GIFs do work.

@bwateratmsft
Copy link
Collaborator

@bwateratmsft I don't know if I'm a fan of already checking off the "run a container" green if they have already run a container sometime in the past. I find this inconsistent since they may have already built an image or scaffolded a Dockerfile once in the past. Wouldn't we want them to step through the walkthrough and complete each step rather than keep a history of what they've done?

I can remove that completion criteria.

@ucheNkadiCode
Copy link
Contributor Author

@bwateratmsft lastly, for the Learn more section, I would like for all of the text below the section header to instead be thrown onto the actual page. I just don't like seeing that completely blank grey area. Let's put those words in there instead.

@bwateratmsft
Copy link
Collaborator

@BigMorty Uche and I wanted your opinion on the Learn More section:

Option A, text in Markdown document to the right (Uche's preference, eliminates a big grey space on the right):
img

Option B, text in step description (Brandon's preference, the Markdown wasn't vertically aligned with the rest of the page and I felt it looked awkward):
img

@BigMorty
Copy link
Contributor

BigMorty commented Sep 8, 2021

Option B would be my choice.

Copy link
Collaborator

@bwateratmsft bwateratmsft left a comment

Choose a reason for hiding this comment

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

Signing off even though it's technically my PR, since Uche and Mike have both seen it and approve.

@bwateratmsft bwateratmsft merged commit 1ad4844 into main Sep 9, 2021
@bwateratmsft bwateratmsft deleted the bmw/gettingStarted2.0 branch September 9, 2021 13:47
@microsoft microsoft locked and limited conversation to collaborators Oct 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Change our start page to the new Getting Started experience

3 participants