Fix format issues introduced by markdown linter (#1223)

# What this PR does
Restore proper formatting to lists in schedule docs introduced by PR
#1202

## Checklist

- [ ] Tests updated
- [ ] Documentation added
- [ ] `CHANGELOG.md` updated

Co-authored-by: Joey Orlando <joseph.t.orlando@gmail.com>
This commit is contained in:
Alyssa Wada 2023-01-26 06:59:48 -07:00 committed by GitHub
parent 4a8011d236
commit 6456e78ba6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 36 additions and 34 deletions

View file

@ -1,5 +1,8 @@
{
"extends": "../.markdownlint.json",
"MD013": {
"line_length": "140"
},
"MD025": false,
"MD036": false
}

View file

@ -41,11 +41,11 @@ features of your calendar app to configure event recurrence, duplicate events, e
To create an on-call schedule calendar:
1. Create a new calendar in your calendar app, then review and adjust default settings as needed.
2. In your new calendar, create events that represent on-call shifts. You must use Grafana usernames as the event title
3. to associate users with each shift.
4. Once your on-call calendar is complete, go to your calendar settings to locate the secret iCal URL. For example, in
5. a Google calendar, this URL can be found in **Settings** > **Settings for my calendars** > **Integrate calendar** >
6. **Secret address in iCal format**.
1. In your new calendar, create events that represent on-call shifts. You must use Grafana usernames as the event title
to associate users with each shift.
1. Once your on-call calendar is complete, go to your calendar settings to locate the secret iCal URL. For example, in
a Google calendar, this URL can be found in **Settings** > **Settings for my calendars** > **Integrate calendar** >
**Secret address in iCal format**.
To learn more about how to configure your calendar events, refer to Calendar events.
@ -60,11 +60,11 @@ instance.
To import an on-call schedule:
1. In Grafana OnCall, navigate to the **Schedules** tab and click **+ New schedule**.
2. Navigate to **Import schedule from iCal URL** and click **+ Create**.
3. Copy the secret iCal URL from your calendar and paste it the **Primary schedule iCal URL** field. Repeat this step
4. for the **Override schedule iCal URL** field if you have an override calendar.
5. Provide a name and review available schedule settings.
6. When youre done, click **Create Schedule**.
1. Navigate to **Import schedule from iCal URL** and click **+ Create**.
1. Copy the secret iCal URL from your calendar and paste it the **Primary schedule iCal URL** field. Repeat this step
for the **Override schedule iCal URL** field if you have an override calendar.
1. Provide a name and review available schedule settings.
1. When youre done, click **Create Schedule**.
### Create an override calendar (Optional)
@ -74,7 +74,7 @@ override calendar will always override overlapping events on the primary calenda
1. Create a new calendar using the same calendar service you used to create the primary calendar.
1. Be sure to set permissions that allow team members to edit the calendar.
1. In the **Schedules** tab of Grafana OnCall, select the primary calendar you want to override.Click **Edit**.
1. In the **Schedules** tab of Grafana OnCall, select the primary calendar you want to override. Click **Edit**.
1. Enter the secret iCal URL in the **Overrides schedule iCal URL** field and click **Update**.
## Calendar events

View file

@ -32,12 +32,10 @@ the gear icon next to an existing schedule.
Available schedule settings:
- **Slack channel:** Choose a primary Slack channel to send notifications about on-call shifts, such as unassigned
- on-call shifts.
- **Slack channel:** Choose a primary Slack channel to send notifications about on-call shifts, such as unassigned on-call shifts.
- **Slack user group:** Choose a Slack user group to receive current on-call updates.
- **Notification frequency:** Specify whether or not to send shift notifications to scheduled team members.
- **Action for slot when no one is on-call:** Define how your team is notified when an empty shift causes a gap in
- on-call coverage.
- **Action for slot when no one is on-call:** Define how your team is notified when an empty shift causes a gap in on-call coverage.
- **Current shift notification settings:** Select how users are notified when their on-call shift begins.
- **Next shift notification settings:** Specify how users are notified of upcoming shifts.
@ -51,7 +49,7 @@ Understand your schedule view:
- **Final schedule:** The final schedule provides a combined view of rotations and overrides
- **Rotations:** The rotations calendar represents all recurring on-call rotations for a given schedule.
- **Overrides:** The override calendar represents temporary adjustments to the recurring on-call schedule. Any events
- on this calendar will take precedence over the rotations calendar.
on this calendar will take precedence over the rotations calendar.
## Schedule export

View file

@ -22,9 +22,9 @@ rest of your schedule.
There are two schedule export options available:
- **On-call schedule export** - Exports all on-call shifts for a particular schedule, including rotations, overrides,
- and assigned users.
and assigned users.
- **User-specific schedule export** - Exports assigned on-call shifts for a particular user. Use this export option to
- add your assigned on-call shifts to your calendar.
add your assigned on-call shifts to your calendar.
> **Note:** Calendar exports include all scheduled shifts, including those which are lower priority or overridden.
@ -36,11 +36,11 @@ calendars.
To export a schedule from Grafana OnCall:
1. In Grafana OnCall, navigate to the **Schedules** tab.
2. Open the schedule youd like to export by clicking on the schedule name.
3. Click **Export** in the upper right corner, then click **+ Create iCal link** to generate a secret iCal URL.
4. Copy the iCal link and store it somewhere youll remember. Once you close the schedule export window, you won't be
5. able to access the iCal link.
6. Open your calendar settings to add a calendar from a URL (This step varies based on your calendar app).
1. Open the schedule youd like to export by clicking on the schedule name.
1. Click **Export** in the upper right corner, then click **+ Create iCal link** to generate a secret iCal URL.
1. Copy the iCal link and store it somewhere youll remember. Once you close the schedule export window, you won't be
able to access the iCal link.
1. Open your calendar settings to add a calendar from a URL (This step varies based on your calendar app).
## Export a user on-call schedule
@ -49,12 +49,12 @@ Use this export option to add your assigned on-call shifts to your calendar. Bes
To export your on-call schedule:
1. In Grafana OnCall, navigate to the **Users** tab.
2. Click **View my profile** in the upper right corner.
3. From the **User Info** tab, navigate to the iCal link section.
4. Click **+ Create iCal link** to generate your secret iCal URL.
5. Copy the iCal link and store it somewhere youll remember. Once you close your user profile, you won't be able to
6. access the iCal link again.
7. Open your calendar settings to add a calendar from a URL (This step varies based on your calendar app).
1. Click **View my profile** in the upper right corner.
1. From the **User Info** tab, navigate to the iCal link section.
1. Click **+ Create iCal link** to generate your secret iCal URL.
1. Copy the iCal link and store it somewhere youll remember. Once you close your user profile, you won't be able to
access the iCal link again.
1. Open your calendar settings to add a calendar from a URL (This step varies based on your calendar app).
## Revoke an iCal export link

View file

@ -49,11 +49,12 @@ Think of a rotation as a recurring schedule containing on-call shifts that users
To add a rotation to an on-call schedule:
1. From your newly created schedule, click **+ Add rotation** and select **New Layer**.
2. Complete the rotation creation form according to your rotation parameters.
3. Add users to the rotation from the dropdown.
You can separate users into user groups to rotate through individual users per shift. User groups that contain
4. multiple users results in all users in the group being included in corresponding shifts.
5. When youre satisfied with the rotation preview, click **Create**.
1. Complete the rotation creation form according to your rotation parameters.
1. Add users to the rotation from the dropdown.
You can separate users into user groups to rotate through individual users per shift.
User groups that contain
multiple users results in all users in the group being included in corresponding shifts.
1. When youre satisfied with the rotation preview, click **Create**.
### Add an on-call schedule to escalation chains