diff --git a/documentation/ru/docs/changelog/index.md b/documentation/ru/docs/changelog/index.md index 927cdaf..0e1f7b4 100644 --- a/documentation/ru/docs/changelog/index.md +++ b/documentation/ru/docs/changelog/index.md @@ -7,6 +7,5 @@ hide: # ChangeLog -## v.2.0.0 - -## v.1.0.0 \ No newline at end of file +## v.0.1.0 +Это первая стабильная публичная версия бота, которую я тестировал пару месяцев на своей работе. \ No newline at end of file diff --git a/documentation/ru/docs/features/interaction-gitlab.md b/documentation/ru/docs/features/interaction-gitlab.md new file mode 100644 index 0000000..d2f3b6f --- /dev/null +++ b/documentation/ru/docs/features/interaction-gitlab.md @@ -0,0 +1,3 @@ +# Взаимодействие с GitLab + +## Ответ в треде \ No newline at end of file diff --git a/documentation/ru/docs/features/notify.md b/documentation/ru/docs/features/notify.md new file mode 100644 index 0000000..5bc683d --- /dev/null +++ b/documentation/ru/docs/features/notify.md @@ -0,0 +1,18 @@ +# :bell: Уведомления +Основное предназначение бота - это уведомления от GitLab. Вы будете получать только те уведомления, которые касаются вас непосредственно. + +## Новый репозитолрий + +## Новый MR + +## Конфликт в MR + +## Обновление MR + +## Изменение статуса MR + +## Новый тред в MR + +## Упоминание в треде + +## Ответ в дискусии \ No newline at end of file diff --git a/documentation/ru/docs/features/privacy.md b/documentation/ru/docs/features/privacy.md new file mode 100644 index 0000000..bdb7cf6 --- /dev/null +++ b/documentation/ru/docs/features/privacy.md @@ -0,0 +1,9 @@ +# :ninja: Приватность + +Мое решение сфокусировано на приватности и прозрачности. Код и используемые зависимости полностью открыты и доступны для изучения и самостоятельной сборки. + +Для работы бота токен доступа устанавливается в переменные среды и никуда не передается, кроме запросов в GitLab. + +Некоторые уведомления могут содержать чуствительную информацию. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о ваших репозиториях Телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений. + +Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом коментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске. \ No newline at end of file diff --git a/documentation/ru/docs/getting-started/features.md b/documentation/ru/docs/getting-started/features.md deleted file mode 100644 index e7237dc..0000000 --- a/documentation/ru/docs/getting-started/features.md +++ /dev/null @@ -1,19 +0,0 @@ -## Уведомления - -### Новый MR - -### Конфликт в MR - -### Обновление MR - -### Изменение статуса MR - -### Новый тред в MR - -### Упоминание в треде - -### Ответ в дискусии - -## Взаимодействие с GitLab - -### Ответ в треде \ No newline at end of file diff --git a/documentation/ru/docs/index.md b/documentation/ru/docs/index.md index ceed00f..2ff91c2 100644 --- a/documentation/ru/docs/index.md +++ b/documentation/ru/docs/index.md @@ -7,14 +7,6 @@ hide: --- # GitLab Notification – Персональный Telegram для GitLab -Персональный помощник для взаимодействия с GitLab. Получайте уведомления о событиях в GitLab: новые MR, где вы ревьювер, конфликты в ваших MR, уведомления о новых сообщениях в тредах, где вы являетесь участником, и многое другое. +Персональный ассистент для взаимодействия с GitLab. Получайте уведомления о событиях в GitLab: новые MR, где вы ревьювер, конфликты в ваших MR, уведомления о новых сообщениях в тредах, где вы являетесь участником, и многое другое. -## :ninja: Privacy - -Мое решение сфокусировано на приватности и прозрачности. Код и используемые зависимости полностью открыты и доступны для изучения и самостоятельной сборки. - -Для работы бота токен доступа устанавливается в переменные среды и никуда не передается, кроме запросов в GitLab. - -Некоторые уведомления могут содержать чуствительную информацию. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о ваших репозиториях Телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений. - -Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом коментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске. \ No newline at end of file +## :ninja: Privacy \ No newline at end of file diff --git a/documentation/ru/includes/abbreviations.md b/documentation/ru/includes/abbreviations.md new file mode 100644 index 0000000..2ab3e2c --- /dev/null +++ b/documentation/ru/includes/abbreviations.md @@ -0,0 +1 @@ +*[MR]: Merge Request \ No newline at end of file diff --git a/documentation/ru/mkdocs.yml b/documentation/ru/mkdocs.yml index dc4c793..353f821 100644 --- a/documentation/ru/mkdocs.yml +++ b/documentation/ru/mkdocs.yml @@ -7,7 +7,10 @@ edit_uri: edit/develop/documentation/ru/docs nav: - О проекте: index.md - - Возможности: getting-started/features.md + - Возможности: + - Приватность: features/privacy.md + - Уведомления: features/notify.md + - Быстрые действия: features/interaction-gitlab.md - Быстрый старт: - Запуск: getting-started/configuration.md # - Архитектура: @@ -60,6 +63,7 @@ theme: - content.action.edit - content.code.copy - content.code.annotate + - content.tooltips - toc.follow - toc.integrate plugins: @@ -83,7 +87,9 @@ markdown_extensions: - pymdownx.details - pymdownx.superfences - pymdownx.inlinehilite - - pymdownx.snippets + - pymdownx.snippets: + auto_append: + - includes/abbreviations.md - pymdownx.critic - pymdownx.caret - pymdownx.keys @@ -103,6 +109,7 @@ markdown_extensions: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg - admonition + - abbr - md_in_html - footnotes - toc: