Skip to content

Commit 98314f9

Browse files
committed
Update docs
1 parent 4aba981 commit 98314f9

3 files changed

Lines changed: 34 additions & 10 deletions

File tree

docs/Extension-settings_ru.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,18 @@
55
![VSCode dotnet FastIoT](vscode-dotnet-fastiot-settings-1.png)
66

77
Настройки:
8-
9-
- **Fastiot › Device › Account: Groups** - группа пользователей в Linux на удаленном устройстве (например, Raspberry Pi), в которую будет добавлена учетная запись (`debugvscode`) для управления устройством. Данная группа должна обладать правами Администратора. Значение по умолчанию: `sudo`.
8+
- **Fastiot: Debug** - отладка сущностей, таких как шаблоны. При включенном значении сохраняет дополнительную отладочную информацию.
9+
- **Fastiot › Device › Account: Group** - группа пользователей в Linux на удаленном устройстве (например, Raspberry Pi), в которую будет добавлена учетная запись (`debugvscode`) для управления устройством. Данная группа должна обладать правами Администратора. Значение по умолчанию: `sudo`.
1010
- **Fastiot › Device › Account: Username** - название учетной записи, создается на удаленном устройстве. Используется для управления устройством и выполнения удаленной отладки. Значение по умолчанию: `debugvscode`.
1111
- **Fastiot › Device › All: JSON** - настройки устройств в JSON формате, не рекомендуется изменять вручную. Из-за неверных изменений, список устройств может не загрузиться.
1212
- **Fastiot › Device: Applicationdatafolder** - общая папка для хранения ключей доступа к устройствам (например, Raspberry Pi), шаблонов, настроек расширения. Значение по умолчанию: `%userprofile%\fastiot`. Пример: `C:\Users\Anton\fastiot`.
13-
- **Fastiot › Device > ssh > Key: Bits** - длина ключа в битах. Значение по умолчанию: `256`.
14-
- **Fastiot › Device > ssh > Key: Type** - Название используемого алгоритма для генерации ключа. Более подробно об алгоритмах для ключей в публикации [How To Set Up SSH Keys](https://goteleport.com/blog/how-to-set-up-ssh-keys/). Значение по умолчанию: `ed25519`. Если выберете алгоритм `rsa`, то вам потребуется в файл `/etc/ssh/sshd_config` внести строку `PubkeyAcceptedAlgorithms=+ssh-rsa`.
13+
- **Fastiot › Device › Ssh › Key: Custombits** - пользовательское значение длины ключа в битах. Переопределяет параметр: `Fastiot › Device › Ssh: Keytype`. Пример: `256`.
14+
- **Fastiot › Device › Ssh › Key: Customtype** - название пользовательского используемого алгоритма для генерации ключа. Переопределяет параметр: `Fastiot › Device › Ssh: Keytype`. Пример: `ed25519`.
15+
- **Fastiot › Device › Ssh: Keytype** - название алгоритма, длина ключа, для генерации ключа, используется на входа на удаленное устройство. Если выберете алгоритм `rsa`, то вам потребуется в файл `/etc/ssh/sshd_config` внести строку `PubkeyAcceptedAlgorithms=+ssh-rsa`. Более подробно об алгоритмах для ключей в публикации [How To Set Up SSH Keys](https://goteleport.com/blog/how-to-set-up-ssh-keys/). Значение по умолчанию: `ed25519-256`.
16+
- **Fastiot: Isupdate** - вкл/выкл обновление сущностей, таких как шаблонов, с ресурсов сети Интернет. Значение по умолчанию: `true`.
1517
- **Fastiot › Launch: Templatetitle** - шаблон для формирования названия Launch. Значения переменных можно посмотреть по [ссылке](Launch-title-template_ru.md "Template for forming the name Launch"). Значение по умолчанию: `Launch on %{device.label} (%{project.name}, %{device.board.name}, %{device.user.debug})`.
16-
- **Fastiot › Template: Isupdate** - вкл/выкл обновление шаблонов с ресурсов сети Интернет.
17-
- **Fastiot › Template: Lastupdate** - время последнего обновления. Технически параметр.
18-
- **Fastiot › Template: Loadonstart** - загрузка шаблонов при старте расширения. При отключенном параметре шаблоны загрузятся только при первом обращение к ним.
19-
- **Fastiot › Template: Updateinterval** - интервал обновления шаблонов в часах.
18+
- **Fastiot: Loglevel** - уровень журналирования событий. Значение `Information` выводит только основные события, значение `Debug` выводит подробную информацию о событиях. Значение по умолчанию: `Information`.
19+
- **Fastiot › Template › Community: Updatesource** - источник обновления для community шаблонов. Добавляет возможность загружать шаблоны со сторонних ресурсов. Пример: `htts://url1/list.yaml;htts://url2/list.yaml`. Структура файла `list.yaml` в формате YAML должна соответствовать структуре файла [templatelist.fastiot.yaml](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/blob/master/templates/system/templatelist.fastiot.yaml). Файлы шаблонов в формате zip архива необходимо размещать в каталоге вместе с файлом `list.yaml`.
20+
- **Fastiot › Template: Defaultprojectfolder** - папка `Projects` для выбора местоположения размещения проектов по умолчанию. Пример: `C:\Users\Anton\Documents\Projects`.
21+
- **Fastiot › Template: Loadonstart** - загрузка шаблонов при старте расширения. При отключенном параметре шаблоны загрузятся только при первом обращение к ним. Значение по умолчанию: `true`.
22+
- **Fastiot: Updateinterval** - интервал обновления шаблонов в часах. Значение по умолчанию: `1 day`.

docs/Getting-started_ru.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,10 @@ sudo systemctl status ssh
125125
*Вызов команды Rebuild*
126126

127127
![.NET FastIoT Launch Rebuild"](vscode-dotnet-fastiot-rebuild.png "Launch Rebuild")
128+
129+
## Опции Launch
130+
131+
Некоторые опции Launch можно изменить из окна LAUCHS. Изменяются следующие опции:
132+
133+
- **Console (terminal)** - параметр определяет, в каком окне консоли (терминала) запускается конечное приложение. Значение по умолчанию: `internalConsole`. Более подробно [Console (terminal) window](https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md#console-terminal-window);
134+
- **Just My Code** - отладка только моего кода. Значение по умолчанию: `true`. Более подробно [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);

docs/Project-templates_ru.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@
1212

1313
## Понятие шаблона
1414

15-
Шаблоны используются для создания проектов и добавления фалов `launch.json` и `tasks.json` к существующему проекту. Располагаются по пути `%userprofile%\fastiot\templates`, например `C:\Users\Anton\fastiot\templates\`. Шаблоны разделяются на два типа, это системные - `system` и пользовательские - `user`. Если системный шаблон не пройдет проверку, то он автоматически будет удален и заменен на валидный. Если системный шаблон удалить, то он тоже будет автоматически восстановлен. Системные шаблоны автоматически обновляются при запуске расширения с ресурса [Github devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system). Далее, все будет рассмотрено на примере шаблона [dotnet-console-runtime-info](/templates/system/dotnet-console-runtime-info).
15+
Шаблоны используются для создания проектов и добавления фалов `launch.json` и `tasks.json` к существующему проекту. Располагаются по пути `%userprofile%\fastiot\templates`, например `C:\Users\Anton\fastiot\templates\`. Шаблоны разделяются на следующие типы:
16+
17+
- `system` - системные;
18+
- `community` - сообщества. Загружаются со сторонних ресурсов;
19+
- `user` - пользовательские. Пользователь может самостоятельно сформировать свой произвольный шаблон.
20+
21+
Шаблоны перечислены в порядке загрузки в расширении. Например, если у шаблона типа `user` будет совпадать идентификатор `id` шаблона с типом `system`, то шаблон типа `user` будет игнорирован по причине уже загруженного шаблона типа `system`.
22+
23+
Если системный шаблон не пройдет проверку, то он автоматически будет удален и заменен на валидный. Если системный шаблон удалить, то он тоже будет автоматически восстановлен. Системные шаблоны автоматически обновляются при запуске расширения с ресурса [Github devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system](https://github.com/devdotnetorg/vscode-extension-dotnet-fastiot/tree/master/templates/system). Далее, все будет рассмотрено на примере шаблона [dotnet-console-runtime-info](/templates/system/dotnet-console-runtime-info).
1624

1725
## Структура шаблона
1826

@@ -85,6 +93,8 @@
8593

8694
В Launch были добавлены дополнительные ключи, с приставкой `fastiotId*`, ключи: `fastiotIdLaunch`, `fastiotIdDevice`, `fastiotProject`, `fastiotIdTemplate`. Не рекомендуется их изменять т.к. некоторые функции расширения из-за этого могут быть недоступны.
8795

96+
Начиная с версии v0.3.3 указанные выше ключи добавляются автоматически, если они отсутствуют в шаблоне. Т.е. теперь эти ключи для шаблона проекта являются необязательными.
97+
8898
Ключи:
8999
- `fastiotIdLaunch` - уникальный идентификатор Launch;
90100
- `fastiotIdDevice` - уникальный идентификатор устроства;
@@ -199,7 +209,7 @@
199209
21. "%{project.dotnet.namespace}" => "DotnetConsoleAppRuntimeInfo".
200210
22. "%{device.dotnet.rid}" => "linux-arm".
201211
23. "%{launch.label}" => "Launch on cubieboard (DotnetConsoleAppRuntimeInfo, Cubieboard, debugvscode)".
202-
24. "%{extension.apps.builtin.aswindows}" => "d:\\\\Anton\\\\GitHub\\\\vscode-extension-dotnet-fastiot\\\\windows\\\\apps\\\\cwrsync\\\\ssh.exe".
212+
24. "%{extension.apps.builtin.aswindows}" => "d:\\\\Anton\\\\GitHub\\\\vscode-extension-dotnet-fastiot\\\\windows\\\\apps".
203213
25. "%{os.userinfo.username}" => "Anton".
204214

205215
**Значения при наличии каталогов в пути**
@@ -223,3 +233,7 @@
223233
Все ошибки связанные с проверкой шаблона будут отображены в окне OUTPUT.
224234

225235
Если возникнет ошибка валидации структуры JSON, то в окне OUTPUT отобразится позиция в файле, которая вызвала ошибку. В этом случае исходный файл останется неизменным, и будет создан новый с именем `debug_launch_json.txt` или `debug_tasks_json.txt` в каталоге проекта.
236+
237+
Параметр **Fastiot: Debug** в настройках расширения включает режим отладки шаблона. В этом режим выводится и сохраняется дополнительная информация при создании проекта из шаблона или добавление Launch к существующему проекту. Так сохраняется следующая информация:
238+
239+
- в папке проекта сохраняются текстовые файлы с полным содержанием всех значений переменных для слияния. Слияние с шаблоном выполняется в несколько шагов. Например, на первом шаге сохраняется файл с названием `Step1CopyValues`. В файле содержатся все значения переменных полученных при интерактивном взаимодействии с пользователем в режим вопрос-ответ. Всего 5 шагов: `Step1CopyValues`, `Step2AddDeviceInfo`, `Step3DependencyProjectType`, `Step4Additional`, `Step5DefinePathToProject`.

0 commit comments

Comments
 (0)