Update docs

Author: devdotnetorg

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.3.2 (24-03-2023)
+
+- Added output of diagnostic information when connecting via ssh protocol.
+- Added stdErr and codeErr output at the end of ssh script execution.
+- Fixed the problem of long execution of scripts when adding a device.
+- Added parameter `fastiot.template.loadonstart`, you can disable the loading of templates at the start of the extension.
+- Added parameter `fastiot.template.updateinterval`, time interval between template updates.
+- Added parameter `fastiot.template.isupdate`, disables template updates.
+- Added `Restore/upgrade system templates` command to restore system templates.
+- Variables added for project templates: `%{extension.apps.builtin.aswindows}`, `%{os.userinfo.username}`.
+- Compliance with UX Guidelines is done.
+- Improved UI.
+- Changed the description of the settings.
+- Added Crlf normalization for bash scripts.
+- Fixed bugs.
+
 ## v0.3.1 (27-02-2023)
 
 - Bugs fixed.

ISSUES.md

@@ -1,9 +1,7 @@
 # Known Issues
 
-1. The user interface of the extension does not follow the [UX Guidelines](https://code.visualstudio.com/api/ux-guidelines/overview).
+1. The user interface of the extension does not partially comply with the [UX Guidelines](https://code.visualstudio.com/api/ux-guidelines/overview).
 
-2. It takes a long time to create a device profile.
+2. Commands are executed slowly.
 
-3. Commands are executed slowly.
-
-4. Low speed of execution of bash scripts.
+3. Low speed of execution of bash scripts.

ISSUES_ru.md

@@ -4,4 +4,4 @@
 
 2. Медленно выполняются команды.
 
-4. Низкая скорость выполнения bash-скриптов.
+3. Низкая скорость выполнения bash-скриптов.

README.md

@@ -36,7 +36,7 @@ Additional extensions required for developing .NET applications:
 
 Recommended additional extensions that improve the development process and interaction with the remote device:
 
-- [NuGet Package Manager](https://marketplace.visualstudio.com/items?itemName=jmrog.vscode-nuget-package-manager "NuGet Package Manager") - adding Nuget packages (later the Nuget package manager will be built into extension);
+- [NuGet Package Manager GUI](https://marketplace.visualstudio.com/items?itemName=aliasadidev.nugetpackagemanagergui "NuGet Package Manager GUI") - adding Nuget packages (later the Nuget package manager will be built into the extension);
 - [DeviceTree](https://marketplace.visualstudio.com/items?itemName=plorefice.devicetree "DeviceTree") - Syntax support for Device Tree (DT) files. Used to edit `*.dts` files. For example, it will be necessary if it becomes necessary to adapt the [SPI LCD ILI9341 display](https://devdotnet.org/post/rabota-s-gpio-v-linux-na-primere-banana-pi-bpi-m64-chast-4-device-tree-overlays-podkluchenie-displey-spi-lcd-ili9341/ "SPI LCD ILI9341 display") for your SBC;
 - [Output Colorizer](https://marketplace.visualstudio.com/items?itemName=IBM.output-colorizer "Output Colorizer") - adds color to the test messages in the OUTPUT window, makes it easier to perceive the information provided by the extension.
 
@@ -93,6 +93,6 @@ See [ISSUES](ISSUES.md "ISSUES") and [Issues on GitHub](https://github.com/devdo
 
 Testing was performed on single-board computers:
 
-- [Cubieboard](https://github.com/devdotnetorg/Cubieboard "Cubieboard")
-- [Cubietruck](https://devdotnet.org/post/otladochnaya-plata-cubietruck/ "Cubietruck")
-- [Banana Pi BPI-M64](https://devdotnet.org/post/otladochnaya-plata-banana-pi-bpi-m64/ "Banana Pi BPI-M64")
+- [Cubieboard](https://github.com/devdotnetorg/Cubieboard "Cubieboard"). Armbian distribution.
+- [Cubietruck](https://devdotnet.org/post/otladochnaya-plata-cubietruck/ "Cubietruck"). Armbian distribution.
+- [Banana Pi BPI-M64](https://devdotnet.org/post/otladochnaya-plata-banana-pi-bpi-m64/ "Banana Pi BPI-M64"). Armbian distribution.

SCHEDULE.md

@@ -3,7 +3,7 @@
 - Compliance with UX Guidelines.
 - Adding a WebView to select a project template.
 - Custom installation packages.
-- Custom BASH scripts to run on device and PC.
+- Custom bash-scripts to run on device and PC.
 - GPIO: read chips, view gpio line, control I/O.
 - Support for Python projects.
 - Ensuring work in Linux.

docs/Extension-settings.md

@@ -13,3 +13,7 @@ Settings:
 - **Fastiot › Device > ssh > Key: Bits** - key length in bits. Default value: `256`.
 - **Fastiot › Device > ssh > Key: Type** - The name of the algorithm used to generate the key. For more information about key algorithms, see [How To Set Up SSH Keys](https://goteleport.com/blog/how-to-set-up-ssh-keys/). Default value: `ed25519`. If you choose the `rsa` algorithm, then you will need to add the line `PubkeyAcceptedAlgorithms=+ssh-rsa` to the `/etc/ssh/sshd_config` file.
 - **Fastiot › Launch: Templatetitle** - template for forming the name of Launch. Variable values can be viewed at [link](Launch-title-template.md "Template for forming the name Launch"). Default value: `Launch on %{device.label} (%{project.name}, %{device.board.name}, %{device.user.debug})`.
+- **Fastiot › Template: Isupdate** - enable/disable updating templates from Internet resources.
+- **Fastiot › Template: Lastupdate** - last update time. Technical parameter.
+- **Fastiot › Template: Loadonstart** - loading templates at extension start. If this option is disabled, templates will only be loaded the first time they are accessed.
+- **Fastiot › Template: Updateinterval** - template update interval in hours.

docs/Getting-started.md

@@ -16,8 +16,6 @@ apt-get install -y sudo
 ```bash
 sudo apt-get update
 sudo apt-get install -y openssh-server mc
-sudo systemctl reload ssh
-sudo systemctl status ssh
 sudo mcedit /etc/ssh/sshd_config
 ```
 
@@ -118,6 +116,8 @@ To run a .NET IoT application and perform remote debugging, you need to install:
 
 Sample projects with added configuration Launch (`/.vscode/launch.json`) and Tasks (`/.vscode/tasks.json`) are located in the [samples](/samples/) folder.
 
+The `template.fastiot.yaml` file will be placed in the project folder. This file is required to determine the template ID when adding Launch. If it is removed, then there will be no exact definition of the template from which the project was formed. From the `template.fastiot.yaml` file, only the template identifier string `id: dotnet-console` is taken.
+
 ## Rebuild Launch
 
 Launch (`/.vscode/launch.json`) and Tasks (`/.vscode/tasks.json`) configurations contain absolute paths to binary files that are loaded on the device, for example `/cygdrive/d/Anton/Projects/Tests /DotnetConsoleAppRuntimeInfo/bin/Debug/net5.0/linux-arm/`. In this regard, if you change the path to the `Applicationdatafolder` folder in the settings or rename / move the project folder, then the paths become non-existent. In this case, you need to rebuild (Rebuild) Launch. Select the required Launch and then call the context menu, click on the `Rebuild` menu item.

docs/Launch-title-template.md

@@ -4,6 +4,6 @@ Default value: `Launch on %{device.label} (%{project.name}, %{device.board.name}
 
 Merging example: `Launch on cubieboard (DotnetConsoleBlinkLEDApplication, Cubieboard, debugvscode)`.
 
-Variables for creating the name of the Launch configuration and their values can be viewed on the [Project Templates](Project-templates.md "Project Templates") page.
+See the [Project Templates](Project-templates.md "Project Templates") page for the variables to create the Launch configuration name and their values.
 
 If you need additional variables, please create an [ISSUE](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/issues "ISSUE").

docs/Project-templates.md

@@ -25,7 +25,9 @@ The template is a regular zip archive with the following structure:
 
 ### Folder - storage
 
-Any files can be placed. In particular, each template folder contains the **cwRsync** and **ssh** utilities used to remotely log into the device and copy executable binaries. Optionally, you can replace the package by downloading from the official site at [link](https://itefix.net/cwrsync "link").
+Any files can be placed. For example, the **cwRsync** and **ssh** utilities used to remotely login to a device and copy executable binaries. Optionally, you can replace the package by downloading from the official site at [link](https://itefix.net/cwrsync "link").
+
+The **cwRsync** and **ssh** utilities have been moved to the [system application directory](/windows/apps/) to avoid unnecessary increase in the size of the template. Now there is no need to duplicate the specified utilities for each template. It is enough to specify the path to system utilities in the template, for example: "%{extension.apps.builtin.aswindows}\\\\cwrsync\\\\ssh.exe".
 
 ### Folder - template
 
@@ -82,6 +84,13 @@ If the value of the `name` key, e.g. `Launch on cubieboard (DotnetApp, Cubieboar
 
 Additional keys have been added to Launch, prefixed with `fastiotId*`, keys: `fastiotIdLaunch`, `fastiotIdDevice`, `fastiotProject`, `fastiotIdTemplate`. It is not recommended to change them. some extension functions may not be available because of this.
 
+Keys:
+- `fastiotIdLaunch` - unique Launch identifier;
+- `fastiotIdDevice` - unique device identifier;
+- `fastiotProject` - unique ID of the template from which Launch was created;
+- `fastiotIdTemplate` - the path to the project with which this Launch is associated;
+- `fastiotDescription` - (optional) Text description of Launch. Use ` \n` (two spaces and \n) to break a line.
+
 Example:
 
 ```json
@@ -90,6 +99,7 @@ Example:
   "fastiotIdDevice": "cubieboard-5e835aae",
   "fastiotProject": "/DotnetConsoleAppRuntimeInfo.csproj",
   "fastiotIdTemplate": "dotnet-console-runtime-info",
+  "fastiotDescription": "Launch with logging.  \nRsync copying executable files - project_folder/rsync.log.  \nDebugger - /var/log/vsdbg.log",
   "name": "Launch on cubieboard (DotnetConsoleAppRuntimeInfo, Cubieboard, debugvscode)",
   "type": "coreclr",
   "request": "launch",
@@ -188,6 +198,8 @@ Variables:
 21. "%{project.dotnet.namespace}" => "DotnetConsoleAppRuntimeInfo".
 22. "%{device.dotnet.rid}" => "linux-arm".
 23. "%{launch.label}" => "Launch on cubieboard (DotnetConsoleAppRuntimeInfo, Cubieboard, debugvscode)".
+24. "%{extension.apps.builtin.aswindows}" => "d:\\\\Anton\\\\GitHub\\\\vscode-extension-dotnet-fastiot\\\\windows\\\\apps\\\\cwrsync\\\\ssh.exe".
+25. "%{os.userinfo.username}" => "Anton".
 
 **Values when there are directories in the path**
 
@@ -203,6 +215,8 @@ Variables:
 6. "%{project.path.relative.aswindows}" => "\\\\nested".
 7. "%{project.path.full.ascygdrive}" => "/cygdrive/d/Anton/Projects/Tests/DotnetConsoleAppTestNested/nested".
 
+If you need additional variables, please create an [ISSUE](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/issues "ISSUE").
+
 ## Debugging the template
 
 All errors related to template validation will be displayed in the OUTPUT window.