From ce1ae13c012211ccc246a1206b4c717ed81c8e13 Mon Sep 17 00:00:00 2001 From: Struchkov Mark Date: Sat, 25 Feb 2023 12:43:37 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB=20?= =?UTF-8?q?=D0=BF=D0=BE=D0=B4=D0=B4=D0=B5=D1=80=D0=B6=D0=BA=D1=83=20=D0=B4?= =?UTF-8?q?=D0=B2=D1=83=D1=85=20=D1=8F=D0=B7=D1=8B=D0=BA=D0=BE=D0=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentation/docs/{ => en}/index.md | 0 .../docs/{ => ru}/architecture/concept.md | 0 .../docs/{ => ru}/changelog/index.md | 0 .../{ => ru}/getting-started/configuration.md | 0 .../docs/{ => ru}/getting-started/features.md | 0 documentation/docs/{ => ru}/guides/index.md | 0 documentation/docs/ru/index.md | 20 ++++++++++++++++ .../docs/ru/support-development/index.md | 9 +++++++ documentation/mkdocs.yml | 24 ++++++++++++------- 9 files changed, 44 insertions(+), 9 deletions(-) rename documentation/docs/{ => en}/index.md (100%) rename documentation/docs/{ => ru}/architecture/concept.md (100%) rename documentation/docs/{ => ru}/changelog/index.md (100%) rename documentation/docs/{ => ru}/getting-started/configuration.md (100%) rename documentation/docs/{ => ru}/getting-started/features.md (100%) rename documentation/docs/{ => ru}/guides/index.md (100%) create mode 100644 documentation/docs/ru/index.md create mode 100644 documentation/docs/ru/support-development/index.md diff --git a/documentation/docs/index.md b/documentation/docs/en/index.md similarity index 100% rename from documentation/docs/index.md rename to documentation/docs/en/index.md diff --git a/documentation/docs/architecture/concept.md b/documentation/docs/ru/architecture/concept.md similarity index 100% rename from documentation/docs/architecture/concept.md rename to documentation/docs/ru/architecture/concept.md diff --git a/documentation/docs/changelog/index.md b/documentation/docs/ru/changelog/index.md similarity index 100% rename from documentation/docs/changelog/index.md rename to documentation/docs/ru/changelog/index.md diff --git a/documentation/docs/getting-started/configuration.md b/documentation/docs/ru/getting-started/configuration.md similarity index 100% rename from documentation/docs/getting-started/configuration.md rename to documentation/docs/ru/getting-started/configuration.md diff --git a/documentation/docs/getting-started/features.md b/documentation/docs/ru/getting-started/features.md similarity index 100% rename from documentation/docs/getting-started/features.md rename to documentation/docs/ru/getting-started/features.md diff --git a/documentation/docs/guides/index.md b/documentation/docs/ru/guides/index.md similarity index 100% rename from documentation/docs/guides/index.md rename to documentation/docs/ru/guides/index.md diff --git a/documentation/docs/ru/index.md b/documentation/docs/ru/index.md new file mode 100644 index 0000000..ceed00f --- /dev/null +++ b/documentation/docs/ru/index.md @@ -0,0 +1,20 @@ +--- +title: Быстрый старт +hide: + - toc + - comments + +--- + +# GitLab Notification – Персональный Telegram для GitLab +Персональный помощник для взаимодействия с GitLab. Получайте уведомления о событиях в GitLab: новые MR, где вы ревьювер, конфликты в ваших MR, уведомления о новых сообщениях в тредах, где вы являетесь участником, и многое другое. + +## :ninja: Privacy + +Мое решение сфокусировано на приватности и прозрачности. Код и используемые зависимости полностью открыты и доступны для изучения и самостоятельной сборки. + +Для работы бота токен доступа устанавливается в переменные среды и никуда не передается, кроме запросов в GitLab. + +Некоторые уведомления могут содержать чуствительную информацию. Например, уведомления о новых сообщениях в тредах. Возможно вы не захотите раскрывать столько информации о ваших репозиториях Телеграму, ведь через него идет получение уведомлений. Специально для таких случаев предусмотрены уровни конфиденциальности разных типов уведомлений. + +Возьмем для примера уведомление о новом сообщении в треде. При минимальном уровне конфиденциальности вы получите уведомление с текстом коментария и сможете сразу ответить на него в телеграм, а при максимальном уровне конфиденциальности будет сообщаться только о факте нового комментария, без содержания. Все это настраивается при первом запуске. \ No newline at end of file diff --git a/documentation/docs/ru/support-development/index.md b/documentation/docs/ru/support-development/index.md new file mode 100644 index 0000000..cc76ece --- /dev/null +++ b/documentation/docs/ru/support-development/index.md @@ -0,0 +1,9 @@ +--- +title: Поддержать разработку +hide: + - comments + +--- + + +wefwef \ No newline at end of file diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 543b191..b7c66e6 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -5,15 +5,18 @@ repo_url: https://github.com/uPagge/gitlab-notification repo_name: uPagge/gitlab-notification #edit_uri: edit/master/documentation/docs + nav: - - О проекте: index.md - - Возможности: getting-started/features.md + - О проекте: ru/index.md + - Возможности: ru/getting-started/features.md - Быстрый старт: - - Запуск: getting-started/configuration.md + - Запуск: ru/getting-started/configuration.md - Архитектура: - - Концепт: architecture/concept.md + - Концепт: ru/architecture/concept.md + - "Поддержать разработку": + - ru/support-development/index.md - ChangeLog: - - changelog/index.md + - ru/changelog/index.md theme: name: material @@ -88,7 +91,10 @@ extra: property: foobar version: provider: mike -# alternate: -# - name: Русский -# link: /ru/ -# lang: ru \ No newline at end of file + alternate: + - name: Русский + link: /ru/ + lang: ru + - name: English + link: /en/ + lang: en \ No newline at end of file