[FR] Documentation for the fact that "Clone Git Project" requires manual installation of Git

platformio / platformio-docs

PlatformIO Documentation

https://docs.platformio.org

Apache License 2.0

240 stars 326 forks source link

[FR] Documentation for the fact that "Clone Git Project" requires manual installation of Git #182

Closed DerAndere1 closed 3 years ago

DerAndere1 commented 3 years ago

I could not find information that a manual installation of Git (https://git-scm.com/) is required if the user wants to use "Clone Git Project"

My steps: -No installation of Git

while Git is not installed, click on "PlatformIO" in left tool bar. In panel "PLATFORMIO", click "QUICK ACCESS" -> "Miscellaneous" -> Clone Git Project".

Current result: Nothing happens

Expected result:

Pop-up notification that Git has to be installed and added to the PATH System environment variable in order to use "Clone Git Project"
In section "installation" of the Getting Started document at https://docs.platformio.org/en/latest/integration/ide/vscode.html#id1 it should be mentioned that installation of Git and addition to the PATH Sytem environment variable is required to have access to all features of the Platform IDE

ivankravets commented 3 years ago

Is this is a part of VSCode?

DerAndere1 commented 3 years ago

The menu entry "Clone Git Project" is only available after installation of the extension "PlatformIO IDE" in VSCode. VSCode: Version: 1.53.2 (user setup) Commit: 622cb03f7e070a9670c94bae1a45d78d7181fbd4 Date: 2021-02-11T11:48:04.245Z Electron: 11.2.1 Chrome: 87.0.4280.141 Node.js: 12.18.3 V8: 8.7.220.31-electron.0 OS: Windows_NT x64 10.0.19042

PlatformIO IDE: Core 5.1.0·Home 3.3.3

DerAndere1 commented 3 years ago

I found the GUI element "Clone Git Project" in source code here: https://github.com/platformio/platformio-vscode-ide/blob/66a5834be36ab7ed84ccf85c48ae7ea0efa87837/src/views/quick-access-tree.js#L81 . Documentation should go into the installation section of the platformio-docs repo: https://github.com/platformio/platformio-docs/blob/develop/integration/ide/vscode.rst#installation

"Clone Git Project" should also be mentioned below the following section: https://github.com/platformio/platformio-docs/blob/develop/integration/ide/vscode.rst#platformio-core-cli

ivankravets commented 3 years ago

@valeros please add :note that Git is required for Clone Git Project command. Add also a link where to download it.