earlredwolf/DocHubExamples

Примеры использования DocHub

Примеры использования DocHub

Репозиторий содержит примеры использования инструмента управления архитектурой DocHub. Репозиторий развивается силами сообщества.

Цели

• Накопление опыта использования инструмента;
• Развитие практик применения DocHub;
• Формирование базы знаний для создания прикладных метамоделей.

Каталог

1. Пример создания пользовательской метамодели C4 Model

Разворачивание

1. Установите IntelliJ IDEA. Рекомендуется Community Edition;
2. Установите плагин DocHub;
3. Клонируейте репоизиторий примеров:

   git clone https://github.com/rpiontik/DocHubExamples.git
   

4. Откройте в IDE каталог DocHubExamples;
5. Найдите справа в панели плагинов закладку DocHub и откройте ее;
6. Откройте файл ./dochub.yaml и раскомментируйте нужный пример;
7. Сохраните файл;
8. Следуйте рекомендациям примера;
9. Наблюдайте изменения в рендеринге плагина DocHub справа.

Порядок развития репозитория

Чтобы сделать вклад в репозиторий, необходимо:

1. Создать форк данного репозитория;
2. Внести изменения:
   • в папке ./src создать папку примера (Например, ./src/C4ModelContext);
   • в папке примера создать файл README.md, где описать суть примера;
   • корневым файлом примера должен быть dochub.yaml;
   • папку примера наполнить контентом примера;
   • в корневой файл ./dochub.yaml добавить закомментированную строку импорта примера. Например:

       imports:
           ...
           # Пример пользовательского контекста
           # - ./src/C4ModelContext/dochub.yaml 
   

   • внести изменения в файл ./README.md в раздел "Каталог".
3. Создать Pull Request в master ветку данного репозитория.

Требования к контенту

1. Пример должен быть структурирован, структура файлов продумана, читабельна;
2. Код архитектуры должен быть снабжен комментариями;
3. Названия файлов должны быть на латинице и не должны содержать пробелы;
4. Настоятельно рекомендуется избегать внешних ссылок кроме случаев, когда они являются сутью примера;
5. Данные для примера должны содержаться в самом примере;
6. Рекламные ссылки запрещены без предварительного согласования.

Рекомендации к контенту

1. Старайтесь в примере погружать читателя в смысл последовательно, предполагая, что он плохо знаком с инструментом;
2. Если для понимания примера нужна подготовка, укажите это явно, давайте ссылки на нужный материал;
3. Сопровождайте пример ссылками на документацию;
4. В README.md включайте наглядные изображения ожидаемого от примера результата.

Работа с issue репозитория

1. Оставляйте информацию о найденных ошибках, опечатках и прочих отклонениях помечая меткой "bug";
2. Размещайте запросы на примеры как "requests";
3. Идеи оставляйте с меткой "idea".

Лицензия

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

Pull request в данный репозиторий означает согласие автора на присоединение к данной лицензии.

The MIT License http://opensource.org/licenses/MIT