Доработка документации

This commit is contained in:
Struchkov Mark 2023-02-26 10:04:04 +03:00
parent 2aa05d0c56
commit 9167030a45
Signed by: upagge
GPG Key ID: D3018BE7BA428CA6
9 changed files with 45 additions and 11 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

View File

@ -1,3 +1,6 @@
# Взаимодействие с GitLab
## Ответ в треде
## Добавить новый репозиторий
## Ответ в треде
Допустим вас упомянули в обсуждении, сразу знаете что ответить? Не тратьте время, отвечайте прямо из телеграм. Для этого просто ответьте на сообщение и напишите ваш комментарий.

View File

@ -1,18 +1,38 @@
# :bell: Уведомления
Основное предназначение бота - это уведомления от GitLab. Вы будете получать только те уведомления, которые касаются вас непосредственно.
## Новый репозитолрий
## Новый репозиторий
## Новый MR
Когда кто-то создает MR и назначает вас ответственным и/или ревьювером, то вам приходит уведомление. Из этого уведомления можно узнать название, короткое описание, теги, из какой ветки в какую открыт MR, кто его автор и кто ответственный.
<figure markdown>
![notify about new merge request](img/notify-new-mr.png){ loading=lazy width="500" }
</figure>
## Конфликт в MR
Если в вашем MR возник конфликт, то вы будете своевременно оповещены. В этом уведомлении указывается название MR, проект и ветка.
<figure markdown>
![notify about conflict in merge request](img/notify-conflict-mr.png){ loading=lazy width="500" }
</figure>
## Обновление MR
Когда кто-то делает коммиты в MR, в котором вы ответственный или ревьювер, вам сразу же приходит уведомление. Вы также сразу можете увидеть сколько задач еще не решено, и сколько созданных вами задач не было решено.
<figure markdown>
![notify about update in merge request](img/notify-update-mr.png){ loading=lazy width="500" }
</figure>
## Изменение статуса MR
Когда статус вашего MR меняется, вы получаете уведомление.
## Новый тред в MR
В GitLab можно создавать не просто комментарии, а обсуждения (Discussions). Если кто-то создаст такое обсуждение в вашем MR, то вы сразу об этом узнаете.
## Упоминание в треде
Допустим, кто-то упомянул вас в MR, нужен ваш совет. Автор этого MR не вы, ответственным назначали тоже не вас. Даже в этом случае вам придет уведомление, так вы не пропустите сообщения с вашим упоминанием.
## Ответ в дискусии
## Ответ в дискусии
Важно оставаться в теме обсуждения, поэтому при появлении новых ответов в дискуссия, в которых вы участвовали, вы получите уведомление.
Оно будет содержать начальное сообщение обсуждения, ваше последнее сообщение в нем, а также два последних комментария. Таким образом вы будете понимать о чем идет речь.

View File

@ -6,7 +6,11 @@ hide:
---
# GitLab Notification Персональный Telegram для GitLab
# GitLab Notification Персональный Telegram бот для GitLab
Персональный ассистент для взаимодействия с GitLab. Получайте уведомления о событиях в GitLab: новые MR, где вы ревьювер, конфликты в ваших MR, уведомления о новых сообщениях в тредах, где вы являетесь участником, и многое другое.
## :ninja: Privacy
!!! info "GodFather Telegram"
Данный проект использует другой мой проект GodFather Telegram для создания Tlegram ботов различной сложности.
[:material-robot: Создать бота ассистента](getting-started/configuration.md){ .md-button .md-button--primary }

View File

@ -1,4 +1,4 @@
# :ninja: Приватность
# :ninja: Конфиденциальность
Мое решение сфокусировано на приватности и прозрачности. Код и используемые зависимости полностью открыты и доступны для изучения и самостоятельной сборки.

View File

@ -14,4 +14,13 @@
}
.heart {
animation: heart 1000ms infinite;
}
@media(min-width: 768px) {
.frontpage-grid {
display: grid;
grid-template-columns: repeat(2, 1fr);
column-gap: 2em;
row-gap: 1em;
}
}

View File

@ -7,8 +7,8 @@ edit_uri: edit/develop/documentation/ru/docs
nav:
- О проекте: index.md
- Конфиденциальность: privacy.md
- Возможности:
- Приватность: features/privacy.md
- Уведомления: features/notify.md
- Быстрые действия: features/interaction-gitlab.md
- Быстрый старт:
@ -55,7 +55,6 @@ theme:
- navigation.sections
- navigation.tracking
- navigation.footer
- navigation.path
- navigation.prune
- search
- search.suggest
@ -76,9 +75,8 @@ plugins:
# archive_toc: true
# categories: false
# authors: false
- optimize:
cache: false
optimize_jpg_quality: 90
# - optimize:
# optimize_jpg_quality: 90
- tags
- search:
lang: ru