Merge pull request #1 from ValentinKozlov/main

Простой пример валидации сущностей в DocHub с выводом информации в меню

Author: rpiontik

README.md

@@ -17,7 +17,7 @@
 
 1. Установите IntelliJ IDEA. Рекомендуется [Community Edition](https://www.jetbrains.com/idea/download/);
 2. Установите [плагин DocHub](https://plugins.jetbrains.com/plugin/18518-dochub-architecture-as-code);
-3. Клонируейте репоизиторий примеров:
+3. Клонируйте репозиторий примеров:
    ```
    git clone https://github.com/rpiontik/DocHubExamples.git
    ```
@@ -68,8 +68,7 @@
 
 # Лицензия
 
-Все материалы содержащиеся в данном репозитории являются публичными. Могут использовать без ограничения 
-с любой целью не противоречащей закону. 
+Все материалы содержащиеся в данном репозитории являются публичными. Могут использовать без ограничения с любой целью не противоречащей закону. 
 
 Pull request в данный репозиторий означает согласие автора на присоединение к данной лицензии.
 

src/C4Model/README.md

@@ -55,12 +55,12 @@ c4model:
   * L2.yaml - компоненты уровня L2 C4 Model
   * L3.yaml - компоненты уровня L3 C4 Model
   * root.yaml - корневой манифест данных архитектуры
-* entities - матемодель;
+* entities - метамодель;
   * templates - шаблоны, используемые для рендеринга диаграмм
     * context.mmd - Mermaid шаблон
   * c4model.yaml - манифест пользовательской сущности C4Model
   * root.yaml - корневой манифест метамодели
-* images - картинки для настоящей документаии
+* images - картинки для настоящей документации
 * dochub.yaml - корневой манифест примера
 
 ## Использование
@@ -81,4 +81,4 @@ c4model:
   и компоненты к ним в файле [components/L3.yaml](./components/L3.yaml);
 * Измените шаблон рендеринга с Mermaid на PlantUML;
 * Добавьте новое обязательное поле в метамодель [c4model](./entities/c4model.yaml) для уровня L1;
-* Реализйте поддержку L4 C4Model в метамодели.
+* Реализуйте поддержку L4 C4Model в метамодели.

src/validator_example/README.md

@@ -0,0 +1,30 @@
+# Простой пример валидации сущностей в DocHub с выводом информации в меню
+
+**Цель примера:** На простом примере показать возможности валидатора, с выводом информации в меню DocHub.
+
+
+# Суть примера
+В процессе работы стало понятно, что нам не хватает реквизитов для описания типовых систем/сервисов. Например, бизнес выразил желание делать оценку рисков. Поэтому типовая карточка систем была дополнена набором различных реквизитов описывающие риски системы/сервисов.
+
+Так как планируется, что данные реквизиты буду заполнять различные сотрудники, то мы решили сделать валидатор для проверки этих данных и вывести его в меню DocHub, для того чтобы было удобней смотреть.
+
+## Файловая структура примера
+* system_template.yaml - пример системы/сервиса с расширенным набором полей 
+* system_validator.yaml - валидатор, который проверяет нужный набор реквизитов и выводит информацию о результатах валидации в меню DocHub
+* images - картинки для настоящей документации
+* dochub.yaml - корневой манифест примера
+
+
+## Использование
+В меню плагина DocHub выберите пункт "Проблемы"
+
+![Меню](./images/menu.jpg)
+
+Разверните пункт "Валидатор систем/сервисов" и наслаждайтесь результатами ошибок (для этого я оставил парочку).
+![Результаты](./images/validator.jpg)
+
+
+## Задания для практики
+* Исправьте ошибки, которые были добавлены в тестовый пример
+* Добавьте новых реквизитов и добавьте их в валидатор
+* Введите ошибочные значения для предыдущего пункта и посмотрите результаты

src/validator_example/dochub.yaml

@@ -0,0 +1,3 @@
+imports:
+  - system_template.yaml
+  - system_validator.yaml

src/validator_example/images/menu.jpg

@@ -0,0 +1,87 @@
+components:
+  samolet.bu_name.system_name:
+    # Общая информация
+    title: Имя системы    # Название компонента
+    entity: system   # Сущность компонента из PlantUML (https://plantuml.com/ru/deployment-diagram)    
+    description: Полное описание системы/сервиса
+    short_description: Краткое описание системы/сервиса
+    owner: Фамилия имя владельца системы/сервиса
+    applink: Ссылка на систему/сервис. Это может быть либо ссылка на S.POT, либо ссылка на внутренний или внешний ресурс    
+    critical_level: low #low/middle/high/critical    
+    customer_type:
+      - b2b
+      # - b2c
+      # - internal
+    system_category:
+      - administrative
+      - canal
+      - accounting
+      - supporting   
+   
+    technologies: # Используемые технологии
+      - описание технологий находится здесь 4_tech_arch/technologies.yaml
+    aspects:                # Аспекты, которе реализует компонент
+      - описание аспектов находится здесь 3_application_arch/functions/functions.yaml
+    links:     
+      - id: samolet.bu_name.system_name
+        direction: <--
+
+    # Риски/проблемы
+    risk_functional_fit: # определяет насколько приложение/сервис удовлетворяет функциональным требованиям пользователей
+      value: 1 #1-10
+      date_value: 09.10.2022 # дд.мм.гггг или дд-мм-гггг
+      comments: Тестовый комментарий
+    
+    risk_arch_maturity: # определяет зрелость архитектуры приложений/сервисов
+      value: 3
+      date_value: 14.10.2022
+      comments: Тестовый комментарий
+    
+    app_rating: # определяет рейтинг приложения из S.POT
+      value: A # A/B/C/D
+      spot_link: https://spot.samoletgroup.ru/product/6757a357-e3e4-432c-965c-86cc2a22aa48
+
+    risk_code_control: # определяет на сколько хорошо мы управляем кодовой базой внутри Самолета
+      value: 10
+      date_value: 12.10.2022
+      comments: Тестовый комментарий
+
+    risk_sustainability: # определяет устойчивость/надежность приложения 
+      value: 0
+      date_value: 14-10-2022
+      comments: Тестовый комментарий
+
+    risk_security: # определяет уровень  кибербезопасности приложения
+      value: 9
+      date_value: 2022.12.10
+      comments: Тестовый комментарий
+
+    risk_capacity: # определяет утилизацию серверных, сетевых мощностей для приложений
+      value: 3
+      date_value: 14-10-2022
+      comments: Тестовый комментарий
+
+    risk_vendor: # определяет каковы риски вендора приложения (vendor lock, санкционность, мощность вендора)
+      value: 1
+      date_value: 14-10-2022
+      comments: Тестовый комментарий
+
+    risk_financial: # определяет на сколько обоснована стоимость владения системой/сервисом
+      value: 6
+      date_value: 14-10-2022
+      comments: Тестовый комментарий
+
+    risk_team_skills: # определяет зрелость и квалификацию команды, сопровождающей приложение/сервис
+      value: 6
+      date_value: 14-10-2022
+      comments: Тестовый комментарий
+
+    risk_team_capacity: # определяет хватает ли в команде ресурсов для развития/сопровождения приложения
+      value: 8
+      date_value: 14-10-2022
+      comments: Тестовый комментарий
+
+    risk_process: # определяет зрелость процессов разработки, внедрения, техподдержки приложения/сервиса
+      value: 5
+      date_value: 14-10-2022
+      comments: Тестовый комментарий