diff --git a/.drone.yml b/.drone.yml index 907dd40..71c032c 100644 --- a/.drone.yml +++ b/.drone.yml @@ -134,7 +134,7 @@ steps: - git clone ${DRONE_GIT_SSH_URL} . - git checkout $DRONE_COMMIT - cd documentation/ru - - mike deploy --prefix godfather-telegram/ru --branch docs-deploy --push --update-aliases develop + - mike deploy --prefix godfather-telegram/spring/ru --branch docs-deploy --push --update-aliases develop image_pull_secrets: - DOCKER_AUTH @@ -145,6 +145,6 @@ volumes: path: /drone/volume/mkdocs_cache/godfather_telegram/ru --- kind: signature -hmac: 5562bbc661205e22431151399cb3898fbf7dd96b69ca59aeaf161910b8d64f89 +hmac: 0a56908deb231df7e12f012c94abeea4545f8ad6b19d66f2321036af88afebc7 ... diff --git a/documentation/ru/docs/getting-started/configuration.md b/documentation/ru/docs/getting-started/configuration.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/ru/docs/getting-started/installing-dependencies.md b/documentation/ru/docs/getting-started/installing-dependencies.md deleted file mode 100644 index 535fdeb..0000000 --- a/documentation/ru/docs/getting-started/installing-dependencies.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -hide: -- toc ---- -# Варианты добавления в проект -Есть несколько вариантов добавить фреймворк в проект. Изучите их все и выберете подходящий под ваши задачи. - -## Spring Boot Starter -Самый простой способ, если у вас небольшой монолитный Spring Boot проект. - -=== ":simple-apachemaven: Maven" - - ```xml - - dev.struchkov.godfather.telegram - telegram-bot-spring-boot-starter - 0.0.50-SNAPSHOT - - ``` - -=== ":simple-gradle: Gradle" - - ``` c++ - #include - - int main(void) { - std::cout << "Hello world!" << std::endl; - return 0; - } - ``` - -## Quarkus Extension - -На данный момент раздел находится в разработке. - -=== ":simple-apachemaven: Maven" - - ``` - - ``` - -=== ":simple-gradle: Gradle" - - ``` - - ``` - -### Reactive - -На данный момент раздел находится в разработке. - -## Основные зависимости проекта -Вы можете добавить основные зависимости в свой проект и сконфигурировать его более тонко под ваши нужды. Однако для этого потребуется хорошее знание архитектуры проекта. - -Этот вариант подойдет вам, если у вас используется микросервисная архитектура. Так как логично разделить стадии получения, обработки и отправки сообщений на разные сервисы. - -Также этот вариант подойдет вам, если вы используете менее популярный фреймворк, так как основные зависимости написаны без привязки к какому-то конкретному фреймворку. - -Всего основных зависимостей три: - -=== ":simple-spring: Spring" - Эти зависимости подойдут вам, если вы используете SpringBoot 3.0.0+ - - === ":simple-apachemaven: Maven" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` - - === ":simple-gradle: Gradle" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` - -=== ":simple-quarkus: Quarkus" - - Эти зависимости подойдут вам, если вы используете Quarkus 2.16.0+ - - === ":simple-apachemaven: Maven" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` - - === ":simple-gradle: Gradle" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` \ No newline at end of file diff --git a/documentation/ru/docs/guides/index.md b/documentation/ru/docs/guides/index.md deleted file mode 100644 index f5adf54..0000000 --- a/documentation/ru/docs/guides/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Hello Mutiny! - -Once you made Mutiny available to your classpath, you can start writing code. -Let's start with this simple program: - -## Test - -### Test 2 - -## Test 3 \ No newline at end of file diff --git a/documentation/ru/docs/index.md b/documentation/ru/docs/index.md deleted file mode 100644 index ecd36ca..0000000 --- a/documentation/ru/docs/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -hide: - - navigation - - comments -title: Home - ---- - -# Godfather Telegram – Фреймворк для создания Telegram ботов \ No newline at end of file diff --git a/documentation/ru/docs/architecture/concept.md b/documentation/spring/ru/docs/architecture/concept.md similarity index 100% rename from documentation/ru/docs/architecture/concept.md rename to documentation/spring/ru/docs/architecture/concept.md diff --git a/documentation/ru/docs/assets/favicon.ico b/documentation/spring/ru/docs/assets/favicon.ico similarity index 100% rename from documentation/ru/docs/assets/favicon.ico rename to documentation/spring/ru/docs/assets/favicon.ico diff --git a/documentation/ru/docs/blog/index.md b/documentation/spring/ru/docs/blog/index.md similarity index 100% rename from documentation/ru/docs/blog/index.md rename to documentation/spring/ru/docs/blog/index.md diff --git a/documentation/spring/ru/docs/changelog/index.md b/documentation/spring/ru/docs/changelog/index.md new file mode 100644 index 0000000..89f16e4 --- /dev/null +++ b/documentation/spring/ru/docs/changelog/index.md @@ -0,0 +1,3 @@ +# Change.Log + +## 1.0.0 \ No newline at end of file diff --git a/documentation/spring/ru/docs/getting-started/hello-godfather.md b/documentation/spring/ru/docs/getting-started/hello-godfather.md new file mode 100644 index 0000000..e284e77 --- /dev/null +++ b/documentation/spring/ru/docs/getting-started/hello-godfather.md @@ -0,0 +1,4 @@ +# Hello GodFather + +Начнем разработку бота с простого примера. Поздороваемся с пользователем. + diff --git a/documentation/ru/docs/getting-started/index.md b/documentation/spring/ru/docs/guides/index.md similarity index 100% rename from documentation/ru/docs/getting-started/index.md rename to documentation/spring/ru/docs/guides/index.md diff --git a/documentation/spring/ru/docs/index.md b/documentation/spring/ru/docs/index.md new file mode 100644 index 0000000..adb0536 --- /dev/null +++ b/documentation/spring/ru/docs/index.md @@ -0,0 +1,84 @@ +--- +hide: + - comments + +--- + +# Фреймворк для создания Telegram ботов + +Данный фреймворк обладает мощным API для создания диалоговых Telegram ботов. + +## Добавляем зависимости + +Данный фреймворк имеет версии как для SpringBoot :simple-spring:, так и для Quarkus Reactive :simple-quarkus:. + +Чтобы начать, выберете соответствующую вкладку и добавьте зависимости в свой проект. + +=== ":simple-spring: SpringBoot" + + Используйте стартер, чтобы быстро начать разработку + + === ":simple-apachemaven: Maven" + + ``` xml + + + dev.struchkov.godfather.telegram + telegram-bot-spring-boot-starter + 0.0.51 + + + ``` + + === ":simple-gradle: Gradle" + + ``` groovy + // https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-bot-spring-boot-starter + implementation 'dev.struchkov.godfather.telegram:telegram-bot-spring-boot-starter:0.0.51' + ``` + +=== ":simple-quarkus: Quarkus Reactive" + + Реактивная версия + + !!! question "Почему нe extension?" + + Все будет, но не сразу :wink: + + === ":simple-apachemaven: Maven" + + ``` xml + + + dev.struchkov.godfather.telegram + telegram-consumer-quarkus + 0.0.51 + + + + + dev.struchkov.godfather.telegram + telegram-core-quarkus + 0.0.51 + + + + + dev.struchkov.godfather.telegram + telegram-sender-quarkus + 0.0.51 + + ``` + + === ":simple-gradle: Gradle" + + ``` groovy + // https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-consumer-quarkus + implementation 'dev.struchkov.godfather.telegram:telegram-consumer-quarkus:0.0.51' + + // https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-core-quarkus + implementation 'dev.struchkov.godfather.telegram:telegram-core-quarkus:0.0.51' + + // https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-sender-quarkus + implementation 'dev.struchkov.godfather.telegram:telegram-sender-quarkus:0.0.51' + ``` \ No newline at end of file diff --git a/documentation/ru/docs/stylesheets/extra.css b/documentation/spring/ru/docs/stylesheets/extra.css similarity index 100% rename from documentation/ru/docs/stylesheets/extra.css rename to documentation/spring/ru/docs/stylesheets/extra.css diff --git a/documentation/spring/ru/docs/support-development.md b/documentation/spring/ru/docs/support-development.md new file mode 100644 index 0000000..c8339a3 --- /dev/null +++ b/documentation/spring/ru/docs/support-development.md @@ -0,0 +1,24 @@ +--- +description: Спонсорская поддержка делает проект устойчивым, так как она окупает время сопровождающих этого проекта. +hide: + - comments +--- + +# :heart:{ .heart } Поддержать разработку + +Спонсорская поддержка делает проект устойчивым, так как она окупает время сопровождающих этого проекта - очень дефицитный ресурс, который тратится на разработку новых функций, исправление ошибок, повышение стабильности, решение проблем и общую поддержку. ==Самое большое узкое место в Open Source - это время.== + +*** + +Вы можете выбрать любой удобный способ поддержки разработки: + +- Банковская карта: [https://www.tinkoff.ru/cf/4iU6NB3uzqx](https://www.tinkoff.ru/cf/4iU6NB3uzqx) +- Крипта: + + * BTC (Taproot): `bc1pt49vnp43c4mktk6309zlq3020dzd0p89gc8d90zzn4sgjvck56xs0t86vy` + * ETH: `0x7668C802Bd71Be965671D4Bbb1AD90C7f7f32921` + * USDT (ERC-20): `0x7668C802Bd71Be965671D4Bbb1AD90C7f7f32921` + * DAI (ERC-20): `0x7668C802Bd71Be965671D4Bbb1AD90C7f7f32921` + * BNB: `0xDa41aC95f606850f2E01ba775e521Cd385AA7D03` + * USD: `0xDa41aC95f606850f2E01ba775e521Cd385AA7D03` + * DAI: `0xDa41aC95f606850f2E01ba775e521Cd385AA7D03` \ No newline at end of file diff --git a/documentation/ru/mkdocs.yml b/documentation/spring/ru/mkdocs.yml similarity index 88% rename from documentation/ru/mkdocs.yml rename to documentation/spring/ru/mkdocs.yml index ec2dcbf..f6328eb 100644 --- a/documentation/ru/mkdocs.yml +++ b/documentation/spring/ru/mkdocs.yml @@ -1,5 +1,5 @@ site_name: GodFather Telegram -site_url: https://docs.struchkov.dev/godfather-telegram/ru +site_url: https://docs.struchkov.dev/godfather-telegram/spring/ru repo_url: https://github.com/Godfather-Bots/telegram-bot repo_name: Godfather-Bots/telegram-bot @@ -8,14 +8,12 @@ copyright: Copyright © 2018 - 2023 Struchkov Mark #edit_uri: edit/master/documentation/docs nav: - - 'index.md' - - 'Быстрый старт': - - 'getting-started/installing-dependencies.md' - - 'getting-started/configuration.md' -# - 'Гайды': - - 'Архитектура': - - 'architecture/concept.md' -# - 'ChangeLog': + - О проекте: + - index.md + - Hello World!: getting-started/hello-godfather.md + - Поддержать разработку: support-development.md + - ChangeLog: + - changelog/index.md theme: name: material @@ -51,6 +49,8 @@ theme: - navigation.sections - navigation.tracking - navigation.footer + - navigation.tabs + - navigation.tabs.sticky - navigation.prune - search - search.suggest diff --git a/documentation/ru/overrides/partials/comments.html b/documentation/spring/ru/overrides/partials/comments.html similarity index 100% rename from documentation/ru/overrides/partials/comments.html rename to documentation/spring/ru/overrides/partials/comments.html diff --git a/documentation/ru/overrides/partials/integrations/analytics/custom.html b/documentation/spring/ru/overrides/partials/integrations/analytics/custom.html similarity index 100% rename from documentation/ru/overrides/partials/integrations/analytics/custom.html rename to documentation/spring/ru/overrides/partials/integrations/analytics/custom.html