microsoft / vscode-wiki Goto Github PK

Until now I assumed this wiki is the same as (and probably direct source of) vscode repo's wiki.
(I never worked with GitHub wikis)

Now I found out they apparently aren't and files and their histories even differ.

So what is this repo actually for and why do you keep two copies of the wiki?

Thanks a ton for answering!

In https://github.com/Microsoft/vscode/wiki/Running-the-Endgame#schedule-template the link to the OSS Tool doesn't work. The repo linked either don't exist or is private.

The link in question:

https://github.com/Microsoft/vscode-distro/blob/master/distro-tools/README.md

In Selfhosting-on-Windows-WSL.md, WSL2 link currently points to:

https://docs.microsoft.com/en-us/windows/wsl/wsl2-install

Instead, it should point to:

https://docs.microsoft.com/en-us/windows/wsl/install

Noe: the list of languages might change. should be Note: the list of languages might change. in Roadmap.md

Being a legend, it doesn't accurately represent the respective icons:

A better representation would be to show the actual icon as opposed to having text.

Hello

For the Windows install step, it says to do:

git clone https://github.com/microsoft/vscode
cd vscode
scripts\npm install

However when I tried that, I got a message that I should use npm.bat instead, so steps should be updated to reflect that.

Would be kinda cool to see, in a static coding console. All the components tied to timed opperations like the Angular2 ng* stuff, to animate like strobing colour text.

And have intellisense animate all the methods or bound opperations animate as well to remind you of the paradigm.

The repository's description points to the TypeScript wiki, instead of the one for VSCode:

A repository to make changes to the vscode Wiki on GitHub https://github.com/Microsoft/TypeScript/wiki

It should be changed to:

A repository to make changes to the vscode Wiki on GitHub: https://github.com/Microsoft/vscode/wiki

Hello

For building on Windows, it recommends using:

Visual Studio 2013 for Windows Desktop or Visual Studio 2015, make sure to select the option to install all C++ tools and the Windows SDK

I had VS2017 installed but it wasn't recognized. Rather then install 2015 or mess around with paths, I discovered an npm package that includes the tools.

npm install --global windows-build-tools

Works great, no further configuration needed. Might be useful to add to the readme.

I was looking to contribute to VSCODE with good first issues as a newbie/beginner. The source code organisation section does a pretty good job at explaining the folder structures to someone who has a lot of experience.

But for the rest of us it is not helpful at all. First of all the information should be very beginner friendly, if some one new is looking to get into open source development.

If anyone of you, who has a lot of experience in contributing to VSCODE, whether in Microsoft or outside kindly add some beginner friendly information. It will be a great help for the community.

For a start here are some of my question that are not available anywhere properly/not at all.

1. For example take the status bar - I as a beginner developer would like add a text say "Hello World" on to the status bar. Which part of the codebase is responsible for creating the status bar? How is it at the end rendering to the screen? How does everything stick together?

What are some of the key apis within VSCODE that can be leveraged?

2. How are different sections of the VSCODE - statusbar, sidebar, editor, header, etc being combined?
   For example in react - we have an App.ts file where ultimately everything goes together and the code style is very declarative.
   The VSCODE code base is based on what? How do I even connect the dots?

And then what is this Resgitry.registerViewContainer actually doing?

There are a bunch of classes, huge files with events, everything abstracted out. So if that is the case. We need a doc where beginners can understand why the architecture is the way it is, how things connect, how can they make changes by understanding the actual inner workings of VSCODE and not just randomly stumble upon the code trying to guess what exactly is happening.

cc: @jrieken

At the bottom of the multi root wiki page, there is a link to vscode-tslint.

An example for this can be found in [vscode-tslint](https://github.com/Microsoft/vscode-tslint/blob/master/tslint/extension.ts#L200)

The link points to a line number on the master branch. This is bad because master will change (or maybe it has already changed since this edit) and line 200 will then be pointing at the wrong thing.

Please use y to get and link to permalinks instead.

I am building the VS source code on Ubuntu 16.4.
While building the code i am getting Following Error
module.js:471
throw err;
^

Error: Cannot find module 'gulp-watch'
at Function.Module._resolveFilename (module.js:469:15)
at Function.Module._load (module.js:417:25)
at Module.require (module.js:497:17)
at require (internal/module.js:20:19)
at Object. (/home/monalisa/vscode/build/lib/watch/index.js:33:68)
at Module._compile (module.js:570:32)
at Object.Module._extensions..js (module.js:579:10)
at Module.load (module.js:487:32)
at tryModuleLoad (module.js:446:12)
at Function.Module._load (module.js:438:3)

Kindly let me know if i am missing any of the step.what needs to be done to resolve following error?

This section of the wiki contains a wrong url, should be replaced with the following one: https://visualstudio.microsoft.com/it/services/github-codespaces/

At the end of https://github.com/microsoft/vscode/wiki/Virtual-Workspaces#disable-functionality-when-a-virtual-workspace-is-opened it says:

A second way is to check in code whether the current workspace consists of non-file schemes:

const isVirtualWorkspace = workspace.workspaceFolders && workspace.workspaceFolders.every(f => f.uri.scheme === 'file');

I think === should be !==

I can't submit a PR because the page source doesn't yet appear in this repo.

Pinging @aeschli

• VS Code Version: Not applicable
• OS Version: Not applicable
• Browser Version: Google Chrome Version 70.0.3538.67 (Official Build) (64-bit)

Steps to Reproduce:

1. Go to https://github.com/microsoft/vscode/wiki/How-to-Contribute#translations in browser
2. Click on localization site

Summary:
https://github.com/Microsoft/Localization/wiki is not reachable

I am new to OSS contributing and would like to fix this issue!
Could you please assign this to me and If possible could you please give the correct Link here so that I can fix it and set a pull request ? :)

Hello

I'm not sure this question belongs here or in the main vscode repo.

If I launch vscode from source, then open an extension project, then try to debug that extension, I get the following error:

Configured debug type 'extensionHost' is not supported.: Error: Configured debug type 'extensionHost' is not supported.
    at Object.create (file:///D:/Downloads/vscode-fork/vscode/out/vs/base/common/errors.js:141:22)
    at file:///D:/Downloads/vscode-fork/vscode/out/vs/workbench/parts/debug/electron-browser/debugService.js:540:71
    at CompletePromise_ctor.CompletePromise_then [as then] (file:///D:/Downloads/vscode-fork/vscode/out/vs/base/common/winjs.base.raw.js:1566:49)
    at file:///D:/Downloads/vscode-fork/vscode/out/vs/workbench/parts/debug/electron-browser/debugService.js:532:80
    at _Base.Class.derive._creator.CompletePromise_then [as then] (file:///D:/Downloads/vscode-fork/vscode/out/vs/base/common/winjs.base.raw.js:1566:49)
    at DebugService.createProcess (file:///D:/Downloads/vscode-fork/vscode/out/vs/workbench/parts/debug/electron-browser/debugService.js:531:51)
    at file:///D:/Downloads/vscode-fork/vscode/out/vs/workbench/parts/debug/electron-browser/debugService.js:519:42
    at CompletePromise_ctor.CompletePromise_then [as then] (file:///D:/Downloads/vscode-fork/vscode/out/vs/base/common/winjs.base.raw.js:1566:49)
    at file:///D:/Downloads/vscode-fork/vscode/out/vs/workbench/parts/debug/electron-browser/debugService.js:500:93
    at Promise_ctor.CompletePromise_then [as then] (file:///D:/Downloads/vscode-fork/vscode/out/vs/base/common/winjs.base.raw.js:1566:49)

Is this expected?

Under the Build section there are seemingly VS Code commands in place of where command line commands would be. It appears as though this was introduced in 659f67e when yarn watch was removed and replaced by a VS Code command.

The previous iteration (https://github.com/microsoft/vscode-wiki/blob/2e2d6b0/How-to-Contribute.md#build) is much clearer and the VS Code build option is secondary to the command line option (it also might be a little unintuitive to use VS Code to make a development build of VS Code).

On the VSCode repository they say I must to open questions on the StackOverflow with vscode tag, instead of creating a issue:

If your issue is a question then please ask the question on Stack Overflow using the tag vscode.

1. https://github.com/Microsoft/vscode/issues/new
2. https://github.com/Microsoft/vscode/blob/master/CONTRIBUTING.md

These guides should I should explain where to ask StackOverflow offtopic questions. Because I cannot ask off-topic questions on the StackOverflow, as it is almost immediately voted down and closed down by its users.

Hi,

This is a request to include somewhere in the Contributing guide the etiquette of letting others know when you are working on an issue. Recently, I ran into a problem where I had spent hours preparing a fix for an issue and had informed others in the comment thread that I had a commit which was being prepared, only to be "beaten to the punch" by another user who opened a PR for the same issue.

This is frustrating because if I had known that this other user was working on the issue, I would have chosen another open issue instead of wasting time working in parallel of someone else on the same thing. I think it would be helpful to include this note in the "etiquette" section of the contributing guide, just so that contributors can have better communication among each other to avoid situations like this in the future. After all, time is in short supply so we should all be able to work together to make the most of the time we have.

Thanks for your consideration,
Jesse

The "working areas" link in the https://github.com/microsoft/vscode/wiki/Issue-Tracking document redirects to a 404.

This repository is currently missing a LICENSE file.

A license helps users understand how to use your project in a compliant manner. You can find the standard MIT license Microsoft uses at: https://github.com/microsoft/repo-templates/blob/main/shared/LICENSE.

If you would like to learn more about open source licenses, please visit the document at https://aka.ms/license (Microsoft-internal guidance).

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Can you put links to Travis and Appveyor on the How to Contribute page and explain that they contain information about the versions needed to build vscode? I spent a lot of time this week searching through build issues for this information until I realized that it's abundantly available in Travis and Appveyor.

Is there a roadmap for 2021 somewhere?

On the wiki page Differences between the repository and Visual Studio Code (File), the link to the FAQ at "Telemetry, Surveys, Crash Reporting" "...GDPR guidelines (FAQ)..." is outdated. The link leads now leads to a 404 page.

Hi maintainers, the Source-Code-Organization.md "Layers" covers several directories under src/vs/: base, platform, editor, workbench, but not code. Could you add it there, or explain why code is not a layer itself?

Is it mirrored to Microsoft/vscode.wiki whenever it is updated?

AFAIK, github doesn't have a native option to make the wiki its own github repository.

Can i suggest you to use git-wiki as alternative? it allows you to directly edit the wiki and supports pull requests for external contributors. Moreover has tons of features that a wiki should have while github wiki lacks:

https://github.com/Drassil/git-wiki

The list of all wikis made with git-wiki:
http://www.drassil.org/git-wiki/examples.html

You can identify the development version of Code by the Electron icon in the Dock or Taskbar.

https://github.com/Microsoft/vscode/wiki/How-to-Contribute#validate-your-changes

Current icon:

The link below does not point to any information about ENOSPC error:

Tip! Linux users may hit a ENOSPC error when running npm run watch, to get around this follow instructions in the Linux FAQ.

I propose changing this link to point to: [Common Questions](https://code.visualstudio.com/docs/setup/linux#_common-questions).

Currently the building and running from source in windows have the following command under prerequisites with Visual Studio:

open a command prompt and run `npm config set msvs_version 2019`

This does not work for Visual Studio 2022 users. There is no clarification on how to update this command for other versions of Visual Studio. Since Visual Studio 2022 is supported now by the following PRs - microsoft/vscode#142667 and microsoft/vscode#143479, the wiki can be updated.

The github page for Windows-build-tools states

Please note that the official Node.js for Windows installer can now automatically install the required tools. That's likely a much better option than the module listed here (windows-build-tools).

Its npm page states

This package has been deprecated
Node.js now includes build tools for Windows. You probably no longer need this tool. See https://github.com/felixrieseberg/windows-build-tools for details.

Hi

So, I was trying to make vscode work in Windows with Dev Containers because this was how it was instructed to do... But I was facing some issues, learn more here.

The solution what to not use Dev Containers and anything like that.

Should I open a PR and update the docs with something like "you may don't like to use Dev Containers"? Something like that...

The URL in this link:

https://github.com/Microsoft/vscode/wiki/Related-Projects#themes

which is this: https://github.com/microsoft/vscode-themes gives a 404 - Page not found.

When I forked this repo and tried to clone it from within VS Code Insiders it failed. Here is the relevant information from the log:

Looking for git in: C:\Program Files\Git\cmd\git.exe
Using git 2.29.2.windows.2 from C:\Program Files\Git\cmd\git.exe
> git clone https://github.com/gjsjohnmurray/vscode-wiki.git c:\Users\XXX\Documents\YYY\gjsjohnmurray\vscode-wiki --progress
Cloning into 'c:\Users\XXX\Documents\YYY\gjsjohnmurray\vscode-wiki'...
remote: Enumerating objects: 59, done.
...
error: invalid path 'Test:-Smoke-Test-Template.md'
fatal: unable to checkout working tree
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

Please rename that file so as not to use the colon character.

The contents of lines 51 and 55 should be swapped so that they can match the numbering of the image.

File link: https://github.com/microsoft/vscode-wiki/blob/main/%5BWIP%5D-Code-Editor-Design-Doc.md

https://github.com/microsoft/vscode/wiki/Automated-Issue-Triaging#training

In this page I see this statement: This is manually verified on a test issue stream, then deployed to vscode proper by copying some bata around in Azure Blob Storage. And I suspect that the word bata is wrong here. It may be data but I am not sure so I am opening an issue instead of a PR.

https://github.com/microsoft/vscode/wiki/How-to-Contribute#packaging

darwin isn't a valid option anymore. I am not sure all the options, but I needed to run vscode-darwin-x64-min to build.

In the Prerequisites (Windows) section of How to Contribute, the step for installing Visual Studio appears to be out of date:

• Visual Studio 2013 for Windows Desktop or Visual Studio 2015, make sure to select the option to install all C++ tools and the Windows SDK.

When I was following this guide yesterday, I installed Visual Studio 2017 and was able to build and run the source seemingly without any problems.

Should this guide be updated for 2017 and link to the Visual Studio download page?

If you could let me know how and if this step should be changed, I will happily submit a PR