Skip to content

Commit

Permalink
Merge pull request #573 from RabotaRu/context-uml
Browse files Browse the repository at this point in the history
v3.13.1
  • Loading branch information
rpiontik authored Oct 21, 2024
2 parents 7cac8b9 + b821309 commit 5723a1a
Show file tree
Hide file tree
Showing 9 changed files with 4,391 additions and 3,890 deletions.
62 changes: 60 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

![Инкрементальное развитие архитектуры](pics/interface.png)

![GitHub License](https://img.shields.io/github/license/rabotaru/dochub)

DocHub - инструмент описания архитектуры через код (Architecture as a code). Код архитектуры - ансамбль файлов на языках,
решающих задачу описания. Поддерживаются:

* [Markdown](https://ru.wikipedia.org/wiki/Markdown) - язык разметки, созданный с целью обозначения форматирования в тексте;
* [PlantUML](https://plantuml.com/) - позволяет создавать диаграммы, используя простой и интуитивно понятный язык;
* [BPMN](https://dochub.info/entities/docs/blank?dh-doc-id=dochub.bpmn) - Поддерживается BPMN нотация описания бизнес-процессов с использованием [bpmnjs](https://bpmn.io/);
* [Mermaid](https://mermaid-js.github.io/mermaid/#/) - позволяет создавать диаграммы с использованием кода;
* [Markdown](https://ru.wikipedia.org/wiki/Markdown) - язык разметки, созданный с целью обозначения форматирования в тексте;
* [Swagger](https://swagger.io/) - язык описания HTTP API контрактов;
* [AsyncAPI](https://www.asyncapi.com/) - язык описания событийных контрактов;
* [SmartAnts](https://dochub.info/docs/dochub.smartants) - продвинутый инструмент презентации архитектуры.
Expand Down Expand Up @@ -295,9 +298,64 @@ npm run build
* [Круглый стол 2021](https://youtu.be/tGulYbKW_Lg).

# Сообщество

* [Группа DocHubTeam](https://t.me/archascode)
* [Канал "Архитектура как код"](https://t.me/dochubchannel)

# Динамика роста звезд на GitHub

Каждая [звезда DocHub](#), это камень в фундамент подхода "Архитектура как код"!

[![Звезды на GitHub](https://starchart.cc/RabotaRu/DocHub.svg?variant=adaptive)](https://starchart.cc/RabotaRu/DocHub)

# Лицензия
DocHub распространяется под лицензией Apache License 2.0 Open source license.

# Комьюнити-взнос за пользование продуктом

## Проблема

Цель создания DocHub — инструментализировать подход управления архитектурой кодом для его развития. DocHub разработан
как [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) продукт, который должен развиваться сообществом.

К сожалению, не все участники сообщества могут внести значимый вклад в кодовую базу DocHub. Однако сообщество уже велико
и требует поддержки и развития. ***Примерно 97% пользователей зависят от результатов работы лишь 3% участников.***

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

## Решения проблемы - Прозрачность использования FOSS DocHub

Одной из ключевых проблем любого продукта является доверие к нему. В ИТ это доверие заслужить сложно.
Обычно метрикой надежности и перспективности продукта являются статусность его клиентов. DocHub не гнался за "лейблами" на первом этапе.
Он ставил задачу создать реальную ценность для экспертов-инноваторов без "маркетингового давления" на них.

Сегодня наше сообщество достаточно велико, и мы можем с уверенностью говорить о подтверждении ценности инструмента и подхода. Скромность более неуместна.
Более того, она мешает его новым членам оценить масштаб и достижения нашего комьюнити.

***Каждый пользователь DocHub может существенно помочь его развитию, опубликовав информацию о том, в какой компании и для каких задач он используется.
Эта информация объединит наше сообщество, привлечет новых участников и расширит базу контрибьюторов.***
Направляйте информацию на ящик [[email protected]](mailto:[email protected]). Этим вы, безусловно, сделаете очень ценный вклад в развитие подхода "Архитектура как код".

Начиная с релиза v3.13.1, в дополнение к лицензии Apache 2.0 вводится комьюнити-взнос в развитие DocHub. Он заключается в обязательстве пользователя
***не скрывать использование DocHub***. Это обязательство также касается производных продуктов на основе кодовой базы DocHub.

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


```
Например, если архитектор компании ООО "Креативные Технологии" опубликовал
статью на Хабре "Развертывание сервисов с использованием DocHub", в
репозитории DocHub может появиться информация об новом клиенте DocHub -
ООО "Креативные Технологии".
Никакой детальной информации об опыте использования без выраженного
желания компании не появится.
```

***Если по какой-либо причине считаете, что использование вами DocHub не может быть публичной информацией — прекратите его использование.***
Это противоречит цели создания DocHub как FOSS инструмента для развития инноваций в ИТ индустрии.

По запросу организации на ящик [[email protected]](mailto:[email protected]) информация об использовании ей DocHub будет удалена.
Одновременно с этим, компания берет на себя обязательства прекратить использовать DocHub в любых целях.
Binary file not shown.
Loading

0 comments on commit 5723a1a

Please sign in to comment.