Skip to content

Commit

Permalink
Merge pull request #574 from RabotaRu/v3.13.1
Browse files Browse the repository at this point in the history
v3.13.1
  • Loading branch information
rpiontik authored Oct 21, 2024
2 parents c788617 + 5723a1a commit 0f8c95a
Show file tree
Hide file tree
Showing 171 changed files with 8,985 additions and 3,965 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.
26 changes: 26 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
=========================================================================
== NOTICE file for use with the Apache License, Version 2.0 ==
=========================================================================

DocHub

Copyright (C) 2021 owner Roman Piontik R.Piontik@mail.ru

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this product except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

In any derivative products, you must retain the information of
owner of the original code and provide clear attribution to the project

https://dochub.info

The use of this product or its derivatives for any purpose cannot be a secret.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
77 changes: 70 additions & 7 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 @@ -59,12 +62,17 @@ gantt
POC mutators :done, 2023-07-01, 150d
section Q4 2023
Framework SEAF :done, 2023-10-01, 92d
Time Machine :active, 2023-11-01, 250d
Public metamodel repository :active, 2023-10-01, 200d
Public metamodel repository :done, 2023-10-01, 200d
section Q2 2024
MVP mutators :active, 2024-01-01, 200d
Process Disigner tool :2024-06-01, 90d
Architectire Commutiny tool :2024-06-01, 90d
MVP mutators :done, 2024-01-01, 200d
Process Disigner tool :done, 2024-06-01, 120d
Architectire Commutiny tool :2024-06-01, 200d
section Q3 2024
AaaC Community Architect Framework (CEAF) :active, 2024-06-17, 200d
WEB DocHub IDE :active, 2024-09-14, 120d
Digital Modeler :active, 2024-09-14, 120d
section Q4 2024
Time Machine :active, 2024-11-01, 90d
click plugins href "https://dochub.info/docs/dochub.plugins.intro"
click smartants href "https://dochub.info/docs/dochub.smartants"
Expand Down Expand Up @@ -290,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 может существенно помочь его развитию, опубликовав информацию о том, в какой компании и для каких задач он используется.
Эта информация объединит наше сообщество, привлечет новых участников и расширит базу контрибьюторов.***
Направляйте информацию на ящик [r.piontik@mail.ru](mailto:r.piontik@mail.ru). Этим вы, безусловно, сделаете очень ценный вклад в развитие подхода "Архитектура как код".

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

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


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

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

По запросу организации на ящик [r.piontik@mail.ru](mailto:r.piontik@mail.ru) информация об использовании ей DocHub будет удалена.
Одновременно с этим, компания берет на себя обязательства прекратить использовать DocHub в любых целях.
Binary file not shown.
Binary file removed distrib/vscode/dochub-0.1.0.vsix
Binary file not shown.
Binary file removed distrib/vscode/dochub-0.1.1.vsix
Binary file not shown.
Binary file removed distrib/vscode/dochub-0.1.2.vsix
Binary file not shown.
Binary file removed distrib/vscode/dochub-0.1.3.vsix
Binary file not shown.
Loading

0 comments on commit 0f8c95a

Please sign in to comment.