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

This commit is contained in:
Struchkov Mark 2023-02-26 22:20:48 +03:00
parent 80294316de
commit 607e50cb12
Signed by: upagge
GPG Key ID: D3018BE7BA428CA6
7 changed files with 112 additions and 6 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

View File

@ -24,7 +24,7 @@
Пока вы явно не нажмете :bell:, вы не будете получать никаких уведомлений. Более того, приложение даже не будет запрашивать MR и прочие сущности репозитория, не будет сохранять их в БД. Пока вы явно не нажмете :bell:, вы не будете получать никаких уведомлений. Более того, приложение даже не будет запрашивать MR и прочие сущности репозитория, не будет сохранять их в БД.
## Новый MR { id="new-mr" } ## Новый MR { id="new-mr" }
Это уведомление приходит, когда вас назначают ответственным и/или ревьювером. Это уведомление приходит, когда вас назначают ответственным и/или ревьювером. При этом не важно когда это произошло: вас указали при создании MR, или потом заменили кого-то вами. Вы в любом случае получите уведомление.
<figure markdown> <figure markdown>
![notify about new merge request](img/notify-new-mr.png){ loading=lazy width="500" } ![notify about new merge request](img/notify-new-mr.png){ loading=lazy width="500" }
@ -99,10 +99,108 @@
## Новый тред в MR ## Новый тред в MR
В GitLab можно создавать не просто комментарии, а треды. Если кто-то создаст такое обсуждение в вашем MR, то вы сразу об этом узнаете. В GitLab можно создавать не просто комментарии, а треды. Если кто-то создаст такое обсуждение в вашем MR, то вы сразу об этом узнаете.
## Упоминание в треде Это уведомление поддерживает уровни конфиденциальности:
Допустим, кто-то упомянул вас в MR, нужен ваш совет. Автор этого MR не вы, ответственным назначали тоже не вас. Даже в этом случае вам придет уведомление, так вы не пропустите сообщения с вашим упоминанием.
## Ответ в треде 1. `WITHOUT_NOTIFY` — уведомления по тредам не отправляются совсем.
Важно оставаться в теме обсуждения, поэтому при появлении новых ответов в дискуссия, в которых вы участвовали, вы получите уведомление. 2. `NOTIFY_WITHOUT_CONTEXT` — вы получаете уведомление о факте нового треда, но без текста сообщений и отправителей.
3. `NOTIFY_WITHOUT_CONTEXT` — самое подробное уведомление. Содержит текст сообщений и имена отправителей.
=== "NOTIFY_WITH_CONTEXT"
<figure markdown>
![notify about new thread in merge request](img/notify-new-thread.png){ loading=lazy width="500" }
</figure>
Уведомление содержит:
- Название MR
- Первое сообщение треда с автором треда
- Остальные сообщения треда, если таковые имеются.
=== "NOTIFY_WITHOUT_CONTEXT"
<figure markdown>
![notify about new thread in merge request](img/notify-new-thread-without-context.png){ loading=lazy width="500" }
</figure>
Уведомление содержит:
- Название MR
Доступные быстрые действия:
- Ответ в GitLab из Telegram.
- :eyes: — прочитано. Удаляет сообщение.
- :link: — ссылка на тред.
- :no_bell: — не получать уведомления по этому треду. Уведомления по другим тредам в это MR продолжат поступать.
## Новое сообщение в треде
Важно оставаться в теме обсуждения, поэтому при появлении новых ответов в тредах, в которых вы участвовали, вы получите уведомление.
Это уведомление поддерживает уровни конфиденциальности:
1. `WITHOUT_NOTIFY` — уведомления по тредам не отправляются совсем.
2. `NOTIFY_WITHOUT_CONTEXT` — вы получаете уведомление о факте нового треда, но без текста сообщений и отправителей.
3. `NOTIFY_WITHOUT_CONTEXT` — самое подробное уведомление. Содержит текст сообщений и имена отправителей.
=== "NOTIFY_WITH_CONTEXT"
<figure markdown>
![notify about new message in thread](img/notify-new-comment-in-thread.png){ loading=lazy width="500" }
</figure>
Уведомление содержит:
- Название MR
- Первое сообщение треда с автором треда
- Предпоследнее сообщение треда
- Новое сообщение треда
!!! tip ""
Такой объем информации должен помочь вам вспомнить/понять контекст обсуждения и ответить прямо из Telegram.
=== "NOTIFY_WITHOUT_CONTEXT"
<figure markdown>
![notify about new comment in thread without context](img/notify-new-comment-in-thread-without-context.png){ loading=lazy width="500" }
</figure>
Уведомление содержит:
- Название MR
Доступные быстрые действия:
- Ответ в GitLab из Telegram.
- :eyes: — прочитано. Удаляет сообщение.
- :link: — ссылка на тред.
- :no_bell: — не получать уведомления по этому треду. Уведомления по другим тредам в это MR продолжат поступать.
### Упоминание в треде
Допустим, кто-то упомянул вас в MR используя тегирование GitLab (@GitlabLogin). Автор этого MR не вы, ответственным назначали тоже не вас.
Если вы отслеживаете репозиторий этого MR, но не участвовали в дискуссии, то в этом случае вам придет уведомление. Так вы не пропустите сообщения с вашим упоминанием.
Формат и быстрые действия такие же, как у уведомления "Новое сообщение в треде".
## Уведомление о решенном треде
## Уведомление о пайплайне
Полезно сразу узнавать, что сборка закончилась успешно или упала.
<figure markdown>
![notify about new pipeline](img/notify-new-pipeline.png){ loading=lazy width="500" }
</figure>
Уведомление содержит:
- Предыдущий статус пайплайна и новый
-
Доступные быстрые действия:
- :eyes: — прочитано. Удаляет сообщение.
- :link: — ссылка на результат работы пайплайна.
Оно будет содержать начальное сообщение обсуждения, ваше последнее сообщение в нем, а также два последних комментария. Таким образом вы будете понимать о чем идет речь.

View File

@ -6,6 +6,14 @@
font-weight: 500; font-weight: 500;
} }
.md-typeset h2 {
margin-top: 4rem;
}
.md-typeset h3 {
margin-top: 2.2rem;
}
@keyframes heart { @keyframes heart {
0%, 40%, 80%, 100% { 0%, 40%, 80%, 100% {
transform: scale(1); transform: scale(1);