Skip to content

Commit d039532

Browse files
committed
Добавлен прототип примера Widgets
1 parent 385788e commit d039532

8 files changed

Lines changed: 73 additions & 2 deletions

File tree

dochub.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
imports:
2-
# Пример создания метамодели для описания в нотации C4 Model
3-
- src/C4Model/dochub.yaml
2+
# Пример создания метамодели для описания в нотации C4 Model
3+
# - src/C4Model/dochub.yaml
4+
# Пример создания метамодели для описания в нотации C4 Model
45
# - src/validator_example/dochub.yaml
56
# - src/business_entity_management/dochub.yaml
67
# - src/sequences_entity_example/dochub.yaml

src/widgets/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Пример встраивания виджетов в предстваления стандартных сущностей
2+
3+
**Цель примера:** Познакомить с возможностями расширения представлений
4+
стандартных сущностей.
5+
6+
# Суть примера
7+
В примере демонстрируется возможность по расширению стандартных сущностей.
8+
Создаются виджеты, которые встраиваются в представления Aspects и Component.
9+
10+
Результат рендеринга описанной архитектуры уровня L2:
11+
12+
![L2](./images/l2.png)
13+
14+
Сгенерированное представление уровня L1:
15+
16+
![L2](./images/l1.png)
17+
18+
## Файловая структура примера
19+
* components - данные архитектуры для рендеринга
20+
* components.yaml - компоненты уровня L2
21+
* root.yaml - корневой манифест данных архитектуры
22+
* contexts - архитектурные контакты;
23+
* l1.yaml - манифест контекста уровня L1
24+
* l2.yaml - манифест контекста уровня L2
25+
* root.yaml - корневой манифест контекстов
26+
* images - картинки для настоящей документации
27+
* dochub.yaml - корневой манифест примера
28+
29+
## Использование
30+
В меню плагина DocHub выберите пункты "L1" или "L2"
31+
32+
![Меню](./images/menu.png)
33+
34+
Вносите изменения в данные архитектуры в файлах каталога [components/](./components).
35+
Наблюдайте изменения в рендеринге плагина DocHub.
36+
37+
## Задания для практики
38+
* Добавьте определения направления связей между компонентами L1 уровня;
39+
* Реализуйте дрилдаун компонентов L1 в L2.

src/widgets/aspects.yaml

Whitespace-only changes.

src/widgets/components.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Описываем акрхитектурные компоненты
2+
components:
3+
user:
4+
entity: actor
5+
title: Пользователь
6+
links:
7+
- id: frontend
8+
frontend:
9+
entity: component
10+
title: Приложение
11+
links:
12+
- id: backend
13+
backend:
14+
entity: Бэкенд
15+
title: Сервер приложения
16+
links:
17+
- id: database
18+
database:
19+
entity: database
20+
title: База данных

src/widgets/dochub.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
imports:
2+
# Подключаем расширения сущностей
3+
- entities/root.yaml
4+
# Подключаем компоненты
5+
- components.yaml
6+
# Подключаем аспекты
7+
- aspects.yaml

src/widgets/entities/aspects.yaml

Whitespace-only changes.

src/widgets/entities/components.yaml

Whitespace-only changes.

src/widgets/entities/root.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Подключаем расширения сущностей
2+
imports:
3+
- aspects.yaml
4+
- components.yaml

0 commit comments

Comments
 (0)