DocHub IDE Beta

Этот репозиторий предназначен для взаимодействия Beta-тестировщиков с DocHubIDE.

DocHub — это интеллектуальная архитектурная платформа, обеспечивающая управление архитектурой и документацией с использованием современных технологий и подходов. Миссией платформы является создание цифровой модели предприятия с глубокой интеграцией искусственного интеллекта в ее процессы.

DocHub IDE - Интегрированная среда разработки цифровой модели предприятия.

Цель репозитория

• Выявление проблем и их регистрация в виде issue.
• Генерация пользовательских запросов на новый функционал.

Старт использования

1. Перейдите на портал https://beta.dochub.info;
2. Ознакомьтесь с документацией и следуйте предложенным сценариям;
3. Сценарии будут расширяться по мере прохождения beta-тестирования платформы.

Сценарии использования

Welcome

1. Откройте сайт https://beta.dochub.info;
2. Произведите авторизацию в GitHub используя раздел "Настройки" доступный по "трем точкам" в правом верхнем углу или кликнув по иконке аватара. При первой авторизации следите, чтобы были предоставлены нужные доступы к репозиториям;
3. Исследуйте документацию используя пункты меню;
4. Задавайте вопросы Dochuber по документации.

Hello World

Видео урока "Hello World!"

1. Откройте сайт https://beta.dochub.info;
2. Произведите авторизацию в GitHub используя раздел "Настройки" доступный по "трем точкам" в правом верхнем углу или кликнув по иконке аватара. При первой авторизации следите, чтобы были предоставлены нужные доступы к репозиториям;
3. Создайте пустой репозиторий средствами GitHub;
4. Зайдите в раздел "Настройки". В секции "Корневой манифест", нажмите кнопку "Выбрать или создать" выберите созданный ранее репозиторий следуя подсказкам мастера.
5. После успешной инициализации репозитория и подключения корневого манифеста перейдите в режим "IDE". Для этого нажмите кнопку "Открыть портал на редактирование" в правом верхнем углу.
6. Используя кнопку "Создать" в левом нижнем углу или контекстное меню на пункте главного меню вызовите конструктор документа;
7. Выберите тип документа "Markdwon";
8. В открывшемся окне введите индентификатор документа dochub.welcome и нажмите кнопку "Создать".
9. В открывшемся редакторе введите текст Hello World!;
10. Сохраните документ используя Ctrl+S или кнопку "Сохранить" в правом верхнем углу экрана;
11. Кликните на надвиси "DocHub IDE". Должен открыться созданный вами документ;
12. Нажмите кнопку "Выбрать объект для редактирования" в правом верхнем углу экрана;
13. Области доступного редактирования будут подсвечены желтой рамкой. Кликните на тексте Hello World!;
14. В меню выберите для редактирования md файл;
15. В открывшемся редакторе измените текст по своему усмотрению;
16. Произведите сохранение документа;
17. Отправьте изменения на сервер используя кнопку "Отправить изменения на сервер". Следуйте подсказкам интерфейса.
18. Перейдите в режим просмотра используя кнопку "Завершить редактирование" в правом верхнем углу экрана.

Simple Repo

Видео урока "Simple Repo"

1. Используйте созданный в результате прохождения сценария Hello World репозиторий;
2. Используя навигатор по репозиторию создайте файл arch.yaml;
3. Подключите созданный файл в файле dochub.yaml в секции imports;
4. В файле arch.yaml создайте простой архитектурное описание. Например:

components: 
  webproject.frontend:
    title: Фронтэнд
    entity: system
    links: 
      - id: webproject.backend
        title: API авторизации
  webproject.backend:
    title: Бэкенд
    entity: system
    links: 
      - id: webproject.log
        title: Логирование
  webproject.log:
    title: LOG
    entity: system

6. Исследуйте полученный результат в меню "Архитектура" представленный в виде дерева;
7. Добавьте в файл arch.yaml контекст для представления диаграммы архитектурных компонентов. Например:

contexts: 
  webproject:
    location: L1
    title: L1
    components: 
      - webproject.*

9. Исследуйте полученный результат в меню "Архитектура/Контексты/L1";
10. Используя конструктор документов, создайте Swagger контракт. Опишите контракт, например:

openapi: 3.0.0
info:
  title: Sample API
  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
  version: 0.1.9
servers:
  - url: http://api.example.com/v1
    description: Optional server description, e.g. Main (production) server
  - url: http://staging-api.example.com
    description: Optional server description, e.g. Internal staging server for testing
paths:
  /users:
    get:
      summary: Returns a list of users.
      description: Optional extended description in CommonMark or HTML.
      responses:
        '200':    # status code
          description: A JSON array of user names
          content:
            application/json:
              schema: 
                type: array
                items: 
                  type: string

12. Укажите идентификатор созданного документа контракта в связи между webproject.frontend и webproject.backend. Например:

components: 
  webproject.frontend:
    title: Фронтэнд
    entity: system
    links: 
      - id: webproject.backend
        title: API авторизации
        contract: apicontract # <<<<< Здесь идентификатор документа контракта 
  webproject.backend:
    title: Бэкенд
    entity: system
    links: 
      - id: webproject.log
        title: Логирование
  webproject.log:
    title: LOG
    entity: system

14. С использованием конструктора создайте BPMN диаграмму процесса авторизации;
15. С использованием графического дизайнера опишите процесс авторизации;
16. Изучите результат работы по сценарию. Убедитесь, что все артефакты доступный из пользовательского меню;
17. Откройте главную страницу портала на редактирование и внедрите в нее созданный ранее контекст:

# Привет Мир!

![L1](@context/webproject)

19. Убедитесь, что при выводе главной страницы портала выводится созданный в ходе сценария контекст webproject.
20. Отправьте изменения на сервер используя кнопку "Отправить изменения на сервер". Следуйте подсказкам интерфейса.
21. Перейдите в режим просмотра используя кнопку "Завершить редактирование" в правом верхнем углу экрана.

Отказ от ответственности

Использование данного программного обеспечения осуществляется на ваш собственный риск. Авторы и правообладатели не несут ответственности за любые прямые, косвенные, случайные, специальные, штрафные или последующие убытки, возникшие в результате использования или невозможности использования данного программного обеспечения.

Программное обеспечение предоставляется "как есть", без каких-либо гарантий, явных или подразумеваемых, включая, но не ограничиваясь, гарантиями товарной пригодности, пригодности для конкретной цели и отсутствия нарушений прав.

Ни при каких обстоятельствах авторы не несут ответственности за любые претензии, убытки или другие обязательства, будь то в результате договора, деликта или иным образом, возникающие из использования данного программного обеспечения или иных действий с ним.

Если вы не согласны с условиями данного отказа от ответственности, пожалуйста, не используйте это программное обеспечение.