Skip to content

Commit 53e0ba6

Browse files
Add suggestions from code review
1 parent 62e3365 commit 53e0ba6

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

docs/about-argus.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ server, such as:
6767
* Administration of Argus user accounts
6868
* Creating API authentication tokens for users
6969
* Defining new source systems to collect incidents from
70-
* Creating and update planned maintenance tasks
70+
* Creating and updating planned maintenance tasks
7171

7272
Pick and choose
7373
---------------

docs/reference/models.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,11 @@ Handling maintenance work
9696

9797
PlannedMaintenanceTask
9898
Holds the user a task is created by, when it was created, which is set
99-
automatically, the start and end time of such a task and a description of what
100-
this maintenance work entails or why it is happening.
101-
It also holds a collection of ``Filter``\s that describe what kind of events are covered by the planned maintenance in question.
99+
automatically. Also holds the start and end time of such a task and a description
100+
of what this maintenance work entails or why it is happening.
101+
102+
It also holds a collection of ``Filter``\s that describe what kind of events are
103+
covered by that planned maintenance.
102104

103105
ER diagram
104106
==========

docs/reference/planned-maintenance.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22
Planned maintenance
33
===================
44

5-
To interact with planned maintenance tasks visit the admin interface at
5+
To interact with planned maintenance tasks visit the admin interface at:
66
``/admin/argus_plannedmaintenance/plannedmaintenancetask/``.
77

88
A planned maintenance task consists of a start time and an end time (where the latter
9-
is by default infinity). Those define the period during which planned work is happening and
10-
when notifications for events, for example for affected devices, should not be sent.
9+
is by default infinity). Those define the period during which planned work is happening
10+
and when notifications for events, for example for affected devices, should not be
11+
sent.
1112

12-
Filters are used to define exactly for which kind of events notifications should be
13-
suppressed. As it is for notification profiles, if multiple filters are connected to
14-
one planned maintenance task, then that tasks will only lead to a notification being
13+
Filters are used to define exactly which kind of events notifications should be
14+
suppressed for. As it is for notification profiles, if multiple filters are connected
15+
to one planned maintenance task, then that tasks will only lead to a notification being
1516
suppressed if all of the filters apply to that event.
1617

1718
.. warning:: When notifications are suppressed during a planned maintenance task and
18-
that task ends while the incident is still open, you will not receive a notification.
19+
that task ends, while the incident is still open, you will not receive a
20+
notification.
1921
It is your responsibility to check that everything is resolved when a planned
2022
maintenance task is finished!
2123

@@ -35,7 +37,7 @@ Adding/editing a planned maintenance task
3537

3638
If you want to add a planned maintenance task click the
3739
``Add planned maintenance task`` button. If you want to see details for a specific
38-
tasks or edit it click the username in the column ``created by``.
40+
task or edit it, click the username in the column ``created by``.
3941

40-
You can mark an existing task as finished and see it's history by clicking on the
42+
You can mark an existing task as finished and see its history by clicking on the
4143
buttons in the top right corner of the edit page.

0 commit comments

Comments
 (0)