update mobile app docs (#3876)

# What this PR does

## Which issue(s) this PR fixes

fixes https://github.com/grafana/oncall-mobile-app/issues/417

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
This commit is contained in:
Salvatore Giordano 2024-02-20 18:18:07 +01:00 committed by GitHub
parent 9542a55dd6
commit 0599c8f918
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 85 additions and 8 deletions

View file

@ -30,9 +30,12 @@ Grafana OnCall mobile app key features:
- Override Do Not Disturb on your device to ensure delivery of important alerts
- Receive push notifications according to your personal notification settings
- Viewing, filtering and responding to Alert Groups (acknowledge, resolve, silence, etc).
- Login with a quick and secure QR code authorization
- View your on-call status and information about current and upcoming shift
- Login with a quick and secure QR code authorization, even to multiple OnCall stacks
- Viewing, filtering and responding to Alert Groups (acknowledge, resolve, silence, etc)
- Adding responders to Alert Groups
- Creating new escalation manually
- Browsing and filtering schedules
- View your on-call status and information about current and upcoming shifts
The OnCall mobile app allows users to receive push notifications as part of their notification policy.
Push notifications are one of the many notification options in Grafana OnCall.

View file

@ -24,19 +24,23 @@ On the **Feed** page, you can view Alert groups, under two tabs:
- **Mine** shows Alert Groups that involve you in one way or another. E.g. because a notification went to you about it, or you resolved it.
- **All** shows all Alert Groups, including ones that may not be relevant to you.
You can filter by status via the **filter** button on the top right. We are working on an expansion for this filter, to filter by team, integration name, and more.
You can filter by status via the **filter** button on the top right.
Tap on any Alert Group to go to the detailed view.
From this page, you have various options available to you.
You can open the alert group in Slack for further discussion and collaboration, as well as share the link to this specific alert group with others.
You can browse the grouped alerts as well as the escalation chain used for the alert group and the timeline.
You can invite other participants, open the alert group in Slack for further discussion and collaboration,
as well as share the link to this specific alert group with others.
Additionally, you can take action on the alert group directly from this page. You have the ability to acknowledge, resolve, and silence the alert group.
> **Note:** You need to have sufficient permission to take action on the alert group.
> To learn more about Grafana OnCall user roles and permission,
> refer to [Manage users and teams for Grafana OnCall][].
<img src="/static/img/oncall/mobile-app-alertgroups.png" width="300px">
<img src="/static/img/oncall/mobile-app-alertgroup.png" width="300px">
<img src="/static/img/oncall/mobile-app-alertgroups2.png" width="300px">
<img src="/static/img/oncall/mobile-app-alertgroup2.png" width="300px">
<img src="/static/img/oncall/mobile-app-timeline.png" width="300px">
{{% docs/reference %}}
[Manage users and teams for Grafana OnCall]: "/docs/oncall/ -> /docs/oncall/<ONCALL_VERSION>/manage/user-and-team-management#user-roles-and-permissions"

View file

@ -62,3 +62,20 @@ To connect to Grafana Cloud OnCall, refer to the Cloud page in your OSS Grafana
For Grafana OnCall OSS, the QR code includes an authentication token along with a backend URL.
Your Grafana OnCall OSS instance should be reachable from the same network as your mobile device, preferably from the internet.
### Connect to multiple OnCall stacks
The OnCall mobile app provides a seamless experience for managing multiple OnCall stacks/accounts.
With just a few taps, you can add and switch between different stacks, ensuring you have access to all your alerts and schedules
without the need to log in and out repeatedly.
This feature is designed to support professionals managing multiple projects or working across different teams, enhancing efficiency and response times.
Simply navigate to the settings menu, select the account tile, tap on the + icon and scan the QR code of the stack you wish to connect.
To switch stack, just select the one you wish to visualize from the accounts page.
Stay organized and responsive by managing all your OnCall needs in one place.
<img src="/static/img/oncall/mobile-app-settings-account.png" width="300px">
<img src="/static/img/oncall/mobile-app-accounts-page.png" width="300px">

View file

@ -89,7 +89,9 @@ You can also enable or disable Do Not Disturb override for **important** notific
### On-call shift notifications
On-call shift notifications are sent to announce upcoming shifts, roughly ~15 minutes in advance.
On-call shift notifications are sent to announce upcoming shifts, you can select multiple timing options in the settings page.
<img src="/static/img/oncall/mobile-app-sound-recommendation.png" width="300px">
To enable or disable on-call shift notifications, use the **info notifications** section in the **Push notifications** settings.

View file

@ -0,0 +1,21 @@
---
canonical: https://grafana.com/docs/oncall/latest/mobile-app/on-call-status-and-shifts/
keywords:
- Mobile App
- oncall
- notification
- on-call status
- on-call shift
title: On-call status and shifts
weight: 500
---
# On-call status and shifts
On the **Feed** page, your avatar on top of the screen indicates whether you are oncall, will be on call soon, or not.
Tap it to open the **upcoming shifts** view. This view displays:
- your current shift (if any), per schedule.
- your next upcoming shift (if any), per schedule. This only looks up to 31 days into the future.
<img src="/static/img/oncall/mobile-app-shifts2.png" width="300px">

View file

@ -0,0 +1,30 @@
---
canonical: https://grafana.com/docs/oncall/latest/mobile-app/schedules/
keywords:
- Mobile App
- oncall
- notification
- push notification
- schedules
- shift swap
title: Schedules
weight: 200
---
# Schedules
On the **Schedules** page, you can view schedules, under two tabs:
- **Mine** shows schedules that involve you.
- **All** shows all schedules, including ones that may not be relevant to you.
You can apply filters via the **filter** button on the top right.
Tap on any schedule to go to the detailed view.
You can browse the schedule, highlight just your shifts and create Shift Swap Requests.
<img src="/static/img/oncall/mobile-app-schedules.png" width="300px">
<img src="/static/img/oncall/mobile-app-schedule.png" width="300px">
<img src="/static/img/oncall/mobile-app-schedule-mine.png" width="300px">
<img src="/static/img/oncall/mobile-app-ssr.png" width="300px">