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

This commit is contained in:
Struchkov Mark 2023-03-13 22:45:23 +03:00
parent ba7f6df62e
commit 08e9f8a8ab
Signed by: upagge
GPG Key ID: D3018BE7BA428CA6
17 changed files with 126 additions and 152 deletions

View File

@ -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
...

View File

@ -1,122 +0,0 @@
---
hide:
- toc
---
# Варианты добавления в проект
Есть несколько вариантов добавить фреймворк в проект. Изучите их все и выберете подходящий под ваши задачи.
## Spring Boot Starter
Самый простой способ, если у вас небольшой монолитный Spring Boot проект.
=== ":simple-apachemaven: Maven"
```xml
<dependency>
<groupId>dev.struchkov.godfather.telegram</groupId>
<artifactId>telegram-bot-spring-boot-starter</artifactId>
<version>0.0.50-SNAPSHOT</version>
</dependency>
```
=== ":simple-gradle: Gradle"
``` c++
#include <iostream>
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="Позволяет отправлять сообщения"
```

View File

@ -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

View File

@ -1,9 +0,0 @@
---
hide:
- navigation
- comments
title: Home
---
# Godfather Telegram Фреймворк для создания Telegram ботов

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -0,0 +1,3 @@
# Change.Log
## 1.0.0

View File

@ -0,0 +1,4 @@
# Hello GodFather
Начнем разработку бота с простого примера. Поздороваемся с пользователем.

View File

@ -0,0 +1,84 @@
---
hide:
- comments
---
# Фреймворк для создания Telegram ботов
Данный фреймворк обладает мощным API для создания диалоговых Telegram ботов.
## Добавляем зависимости
Данный фреймворк имеет версии как для SpringBoot :simple-spring:, так и для Quarkus Reactive :simple-quarkus:.
Чтобы начать, выберете соответствующую вкладку и добавьте зависимости в свой проект.
=== ":simple-spring: SpringBoot"
Используйте стартер, чтобы быстро начать разработку
=== ":simple-apachemaven: Maven"
``` xml
<!-- https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-bot-spring-boot-starter -->
<dependency>
<groupId>dev.struchkov.godfather.telegram</groupId>
<artifactId>telegram-bot-spring-boot-starter</artifactId>
<version>0.0.51</version>
</dependency>
```
=== ":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
<!-- https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-consumer-quarkus -->
<dependency>
<groupId>dev.struchkov.godfather.telegram</groupId>
<artifactId>telegram-consumer-quarkus</artifactId>
<version>0.0.51</version>
</dependency>
<!-- https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-core-quarkus -->
<dependency>
<groupId>dev.struchkov.godfather.telegram</groupId>
<artifactId>telegram-core-quarkus</artifactId>
<version>0.0.51</version>
</dependency>
<!-- https://mvnrepository.com/artifact/dev.struchkov.godfather.telegram/telegram-sender-quarkus -->
<dependency>
<groupId>dev.struchkov.godfather.telegram</groupId>
<artifactId>telegram-sender-quarkus</artifactId>
<version>0.0.51</version>
</dependency>
```
=== ":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'
```

View File

@ -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`

View File

@ -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 &copy; 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