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

Add Getting Started Walkthrough #7512

Merged
merged 38 commits into from
May 17, 2021
Merged

Add Getting Started Walkthrough #7512

merged 38 commits into from
May 17, 2021

Conversation

Colengms
Copy link
Collaborator

@Colengms Colengms commented May 11, 2021

Adds 'walkthrough' content to package.json. That content is currently in English. Because we don't expect to get localized strings before shipping 1.4.0, we plan to stick with English only content for now. (Also, I will need to update localization scripts to enable localization of the MD files). This walkthrough is mostly static, and the plan is to update it considerably as additional support we've requested is added to VS Code.

Currently VS Code Insiders is needed to see the Getting Started UI, as well as setting "workbench.welcomePage.experimental.extensionContributions": true .

Added args to Configuration UI/JSON commands to allow display within a specified ViewColumn. This allows opening of the Configuration UI 'beside' the walkthrough.

Added a CheckForCompiler command that is triggered by the walkthrough and displays a dialog listing found compilers, or a warning that no compilers were found.

Resolves #7273

Colengms and others added 29 commits May 5, 2021 13:21
Extension/package.json Show resolved Hide resolved
Extension/package.json Show resolved Hide resolved
Extension/package.json Outdated Show resolved Hide resolved
Extension/package.json Outdated Show resolved Hide resolved
Extension/package.json Show resolved Hide resolved
Extension/src/LanguageServer/client.ts Outdated Show resolved Hide resolved
Extension/src/LanguageServer/client.ts Outdated Show resolved Hide resolved
Extension/src/LanguageServer/client.ts Show resolved Hide resolved
Extension/src/LanguageServer/settingsPanel.ts Outdated Show resolved Hide resolved
Extension/walkthrough/build-project-linux.md Outdated Show resolved Hide resolved
@michelleangela
Copy link
Contributor

Would it be possible to organize the files in the "walkthrough" folder so it's not a giant list of files? Perhaps create a separate folder for images or create a folder per instruction subject.

Example:

Walkthrough folder

  • images (folder for images not used in any markdown files)
  • installcompiler (folder for files and images for installing compiler)
  • configure (folder for files/images for configuring intellisense)
  • buildanddebug (folder for files and images for build and debug)

@jureid
Copy link
Contributor

jureid commented May 13, 2021

Can we use a different icon that is bigger and easier to see the C/C++ text? The C/C++ text is too small for me to read (GitHub is magnfiying the image):
image

Will reach out to design team and VS Code team for icons.

@jureid
Copy link
Contributor

jureid commented May 13, 2021

Would it be possible to organize the files in the "walkthrough" folder so it's not a giant list of files? Perhaps create a separate folder for images or create a folder per instruction subject.

Example:

Walkthrough folder

  • images (folder for images not used in any markdown files)
  • installcompiler (folder for files and images for installing compiler)
  • configure (folder for files/images for configuring intellisense)
  • buildanddebug (folder for files and images for build and debug)

Yes! I've been wanting to do this, too. I have a few screenshots to update based on Sean's feedback, so when I add those new screenshots I'll organize this folder.

@michelleangela
Copy link
Contributor

Can we use a different icon that is bigger and easier to see the C/C++ text? The C/C++ text is too small for me to read (GitHub is magnfiying the image):
image

Will reach out to design team and VS Code team for icons.

If they're creating a new icon, can they make it so it's also visible for the tab icon?
image

@sean-mcmanus

This comment has been minimized.

@jureid
Copy link
Contributor

jureid commented May 13, 2021

Can we use a different icon that is bigger and easier to see the C/C++ text? The C/C++ text is too small for me to read (GitHub is magnfiying the image):
image

Will reach out to design team and VS Code team for icons.

If they're creating a new icon, can they make it so it's also visible for the tab icon?
image

Yup; I included the tab in the email I sent to them. For our extension page, we just have a generic icon in the tab. Maybe we can use that.

image

Copy link
Collaborator

@sean-mcmanus sean-mcmanus left a comment

Choose a reason for hiding this comment

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

Extension/walkthrough/msvc-build-active-file.png has a visually distracting orange character in the bottom left. Can you remove that?

image

Copy link
Collaborator

@sean-mcmanus sean-mcmanus left a comment

Choose a reason for hiding this comment

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

I'm hitting some issues when the walkthrough is used "too early". The Check Compilers button may not work or the configuration can be blank:
image

@sean-mcmanus
Copy link
Collaborator

sean-mcmanus commented May 14, 2021

I'm hitting some issues when the walkthrough is used "too early". The Check Compilers button may not work or the configuration can be blank:

Well, the Check Compilers behavior seems okay, but I repeatedly get a blank configuration -- that could be an unrelated bug with the configuration UI? It happens randomly or something even long after startup.

@sean-mcmanus
Copy link
Collaborator

I'm hitting some issues when the walkthrough is used "too early". The Check Compilers button may not work or the configuration can be blank:

Well, the Check Compilers behavior seems okay, but I repeatedly get a blank configuration -- that could be an unrelated bug with the configuration UI? It happens randomly or something even long after startup.

It appears to be an existing (?) bug that repros whenever the Configuration UI is opened -- i.e. it's randomly blank, but the repro probability seems a lot higher when invoked from the walkthrough.

@sean-mcmanus
Copy link
Collaborator

It appears to be an existing (?) bug that repros whenever the Configuration UI is opened -- i.e. it's randomly blank, but the repro probability seems a lot higher when invoked from the walkthrough.

Actually, the repro probability increases in the remote scenario, not with the walkthrough. I've opened bug #7523 .

@jureid
Copy link
Contributor

jureid commented May 14, 2021

It appears to be an existing (?) bug that repros whenever the Configuration UI is opened -- i.e. it's randomly blank, but the repro probability seems a lot higher when invoked from the walkthrough.

Actually, the repro probability increases in the remote scenario, not with the walkthrough. I've opened bug #7523 .

I'm seeing the same bug repro in the walkthrough locally

@Colengms Colengms merged commit f7543e3 into main May 17, 2021
@Colengms Colengms deleted the coleng/walkthrough branch May 17, 2021 19:15
@github-actions github-actions bot locked and limited conversation to collaborators Jul 2, 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.

Getting Started experience
5 participants