Update docs

devdotnetorg · devdotnetorg · commit db0d2436e3f2 · 2023-04-24T22:39:26.000+05:00
diff --git a/docs/Extension-settings.md b/docs/Extension-settings.md
@@ -6,14 +6,18 @@ To change the extension settings, open the menu item `File > Preferences > Setti
 
 Settings:
 
-- **Fastiot › Device › Account: Groups** - Linux user group on a remote device (eg Raspberry Pi) to which an account (`debugvscode`) will be added to manage the device. This group must have Administrator rights. Default value: `sudo`.
+- **Fastiot: Debug** - debug entities such as templates. When enabled, saves additional debugging information.
+- **Fastiot › Device › Account: Group** - group of users in Linux on a remote device (for example, Raspberry Pi), to which an account (`debugvscode`) will be added to manage the device. This group must have Administrator rights. Default value: `sudo`.
 - **Fastiot › Device › Account: Username** - account name, created on the remote device. Used to control the device and perform remote debugging. Default value: `debugvscode`.
 - **Fastiot › Device › All: JSON** - device settings in JSON format, it is not recommended to change them manually. Due to incorrect changes, the device list may not load.
 - **Fastiot › Device: Applicationdatafolder** - a shared folder for storing access keys to devices (for example, Raspberry Pi), templates, extension settings. Default value: `%userprofile%\fastiot`. Example: `C:\Users\Anton\fastiot`.
-- **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.
+- **Fastiot › Device › Ssh › Key: Custombits** - custom key length value in bits. Overrides the setting: `Fastiot › Device › Ssh: Keytype`. Example: `256`.
+- **Fastiot › Device › Ssh › Key: Customtype** - the name of the custom algorithm used to generate the key. Overrides the setting: `Fastiot › Device › Ssh: Keytype`. Example: `ed25519`.
+- **Fastiot › Device › Ssh: Keytype** - the name of the algorithm, the length of the key, to generate the key, used to enter the remote device. If you choose the `rsa` algorithm, then you will need to add the line `PubkeyAcceptedAlgorithms=+ssh-rsa` to the `/etc/ssh/sshd_config` file. 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-256`.
+- **Fastiot: Isupdate** - enable/disable updating of entities, such as templates, from Internet resources. Default value: `true`.
+- **Fastiot › Launch: Templatetitle** - template for forming the name of Launch. Variable values can be viewed at [link](Launch-title-template_ru.md "Template for forming the name Launch"). Default value: `Launch on %{device.label} (%{project.name}, %{device.board.name}, %{device.user.debug})`.
+- **Fastiot: Loglevel** - event logging level. The `Information` value displays only the main events, the `Debug` value displays detailed information about the events. Default value: `Information`.
+- **Fastiot › Template › Community: Updatesource** - update source for community templates. Adds the ability to download templates from third-party resources. Example: `htts://url1/list.yaml;htts://url2/list.yaml`. The structure of the `list.yaml` file in YAML format must match the structure of the file [templatelist.fastiot.yaml](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/blob/master/templates/system/templatelist. fastiot.yaml). Template files in zip archive format must be placed in the directory along with the `list.yaml` file.
+  - **Fastiot › Template: Defaultprojectfolder** - `Projects` folder to select the default project location. Example: `C:\Users\Anton\Documents\Projects`.
+- **Fastiot › Template: Loadonstart** - loading templates at extension start. If this option is disabled, templates will only be loaded the first time they are accessed. Default value: `true`.
+- **Fastiot: Updateinterval** - template update interval in hours. Default value: `1 day`.
diff --git a/docs/Extension-settings_ru.md b/docs/Extension-settings_ru.md
@@ -5,6 +5,7 @@
 ![VSCode dotnet FastIoT](vscode-dotnet-fastiot-settings-1.png)
 
 Настройки:
+
 - **Fastiot: Debug** - отладка сущностей, таких как шаблоны. При включенном значении сохраняет дополнительную отладочную информацию.
 - **Fastiot › Device › Account: Group** - группа пользователей в Linux на удаленном устройстве (например, Raspberry Pi), в которую будет добавлена учетная запись (`debugvscode`) для управления устройством. Данная группа должна обладать правами Администратора. Значение по умолчанию: `sudo`.
 - **Fastiot › Device › Account: Username** - название учетной записи, создается на удаленном устройстве. Используется для управления устройством и выполнения удаленной отладки. Значение по умолчанию: `debugvscode`.
diff --git a/docs/Getting-started.md b/docs/Getting-started.md
@@ -125,3 +125,10 @@ Launch (`/.vscode/launch.json`) and Tasks (`/.vscode/tasks.json`) configurations
 *Invoking the Rebuild command*
 
 ![.NET FastIoT Launch Rebuild"](vscode-dotnet-fastiot-rebuild.png "Launch Rebuild")
+
+## Launch Options
+
+Some Launch options can be changed from the LAUCHS window. The following options are changed:
+
+- **Console (terminal)** - controls what console (terminal) window the target app is launched into. Default value: `internalConsole`. More details [Console (terminal) window](https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md#console-terminal-window);
+- **Just My Code** - debug just my code. Default value: `true`. Learn more [How to disable the “Just My Code” setting on the VS Code debugger](https://medium.com/@thiagoalves/how-to-disable-the-just-my-code-setting-on-the -vs-code-debugger-f5fd774e0af8);
diff --git a/docs/Project-templates.md b/docs/Project-templates.md
@@ -12,7 +12,15 @@
 
 ## Template concept
 
-Templates are used to create projects and add `launch.json` and `tasks.json` files to an existing project. They are located along the path `%userprofile%\fastiot\templates`, for example `C:\Users\Anton\fastiot\templates\`. Templates are divided into two types, these are system - `system` and user - `user`. If the system template does not pass the check, it will be automatically deleted and replaced with a valid one. If the system template is deleted, it will also be automatically restored. System templates are automatically updated when you run an extension from [Github devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system). Further, everything will be discussed using the example of the template [dotnet-console-runtime-info](/templates/system/dotnet-console-runtime-info).
+Templates are used to create projects and add `launch.json` and `tasks.json` files to an existing project. They are located along the path `%userprofile%\fastiot\templates`, for example `C:\Users\Anton\fastiot\templates\`. Templates are divided into the following types:
+
+- `system` - system;
+- `community` - communities. Downloaded from third party resources;
+- `user` - user. The user can independently create his own custom template.
+
+Templates are listed in load order in the extension. For example, if a template of type `user` has the same identifier `id` of the template with type `system`, then the template of type `user` will be ignored because the template of type `system` is already loaded.
+
+If the system template does not pass the check, it will be automatically deleted and replaced with a valid one. If the system template is deleted, it will also be automatically restored. System templates are automatically updated when you run an extension from [Github devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/tree/ master/templates/system). Further, everything will be discussed using the example of the template [dotnet-console-runtime-info](/templates/system/dotnet-console-runtime-info).
 
 ## Template structure
 
@@ -84,6 +92,8 @@ 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.
 
+Starting from version v0.3.3, the above keys are added automatically if they are not present in the template. Those. these keys for the project template are now optional.
+
 Keys:
 - `fastiotIdLaunch` - unique Launch identifier;
 - `fastiotIdDevice` - unique device identifier;
@@ -198,7 +208,7 @@ 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".
+24. "%{extension.apps.builtin.aswindows}" => "d:\\\\Anton\\\\GitHub\\\\vscode-extension-dotnet-fastiot\\\\windows\\\\apps".
 25. "%{os.userinfo.username}" => "Anton".
 
 **Values when there are directories in the path**
@@ -222,3 +232,7 @@ If you need additional variables, please create an [ISSUE](https://github.com/de
 All errors related to template validation will be displayed in the OUTPUT window.
 
 If a JSON structure validation error occurs, the OUTPUT window will display the position in the file that caused the error. In this case, the original file will remain unchanged and a new one named `debug_launch_json.txt` or `debug_tasks_json.txt` will be created in the project directory.
+
+The **Fastiot: Debug** parameter in the extension settings enables template debugging mode. This mode displays and saves additional information when creating a project from a template or adding Launch to an existing project. This saves the following information:
+
+- Text files containing the values of the variables to be merged are saved in the project folder. Merging with a template is done in several steps. For example, the first step of a merge saves a file called `Step1CopyValues`. This file contains the values of variables obtained during interactive interaction with the user, in the question-answer mode. Only 5 steps: `Step1CopyValues`, `Step2AddDeviceInfo`, `Step3DependencyProjectType`, `Step4Additional`, `Step5DefinePathToProject`.
diff --git a/docs/Project-templates_ru.md b/docs/Project-templates_ru.md
@@ -234,6 +234,6 @@
 
 Если возникнет ошибка валидации структуры JSON, то в окне OUTPUT отобразится позиция в файле, которая вызвала ошибку. В этом случае исходный файл останется неизменным, и будет создан новый с именем `debug_launch_json.txt` или `debug_tasks_json.txt` в каталоге проекта.
 
-Параметр **Fastiot: Debug** в настройках расширения включает режим отладки шаблона. В этом режим выводится и сохраняется дополнительная информация при создании проекта из шаблона или добавление Launch к существующему проекту. Так сохраняется следующая информация:
+Параметр **Fastiot: Debug** в настройках расширения включает режим отладки шаблона. В этом режим выводится и сохраняется дополнительная информация при создание проекта из шаблона или добавление Launch к существующему проекту. Так сохраняется следующая информация:
 
-- в папке проекта сохраняются текстовые файлы с полным содержанием всех значений переменных для слияния. Слияние с шаблоном выполняется в несколько шагов. Например, на первом шаге сохраняется файл с названием `Step1CopyValues`. В файле содержатся все значения переменных полученных при интерактивном взаимодействии с пользователем в режим вопрос-ответ. Всего 5 шагов: `Step1CopyValues`, `Step2AddDeviceInfo`, `Step3DependencyProjectType`, `Step4Additional`, `Step5DefinePathToProject`.
+- В папке проекта сохраняются текстовые файлы с содержанием значений переменных для слияния. Слияние с шаблоном выполняется в несколько шагов. Например на первом шаге выполнения слияния сохраняется файл с названием `Step1CopyValues`. Данный файл содержит значения переменных полученые при интерактивном взаимодействии с пользователем, в режиме вопрос-ответ. Всего 5 шагов: `Step1CopyValues`, `Step2AddDeviceInfo`, `Step3DependencyProjectType`, `Step4Additional`, `Step5DefinePathToProject`.
