harmacist/healthchecks
1
0
Fork 0
forked from GithubBackups/healthchecks
Code Issues Pull Requests Projects Releases Wiki Activity

Grammar and style fixes.

Browse Source
This commit is contained in:
Pēteris Caune 2020-09-09 12:21:18 +03:00
parent e63aa9fe8d
commit b4729cdb57
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
4 changed files with 92 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
templates/docs/configuring_notifications.html
View File

@ -1,31 +1,30 @@
<h1>Configuring Notifications</h1>
<p>You can set up multiple ways to receive notifications when checks in your account
change state. This is useful for multiple reasons:</p>
change state. This is useful for several reasons:</p>
<ul>
<li><strong>Redundancy in case of notification failures.</strong> Set up notifications using two different
transports (for example, email and Slack). If one transport fails (e.g., an email
message goes to spam), you still receive the notification over the other transport.</li>
<li><strong>Redundancy in case of notification failures.</strong> Set up notifications using two
different notification channels (for example, email and Slack). If one transport
fails (e.g., an email message goes to spam), you still receive a notification over the
other channel.</li>
<li><strong>Use different notification methods depending on urgency</strong>. For example, if a
low-priority housekeeping script fails, post a message in chat. If a vital service fails,
post in chat, send an email, and send SMS.</li>
post in chat, send an email and send SMS.</li>
<li>Route notifications to the right people.</li>
</ul>
<p>Notification methods ("integrations") are scoped to a project:
if you want to use a notification method in multiple projects, it must be
set up in each project separately.</p>
<p>In the web interface, the list of checks shows a visual overview of which alerting
methods are enabled for each check. You can click the icons to toggle them on and off:</p>
<p>Each notification method ("integration") belongs to a project:
if you want to use a notification method in multiple projects, you will need to
set it up in each project separately.</p>
<p>In the web interface, the "Checks" page shows a visual overview of which alerting
methods are active for each check. You can click the icons to toggle them on and off:</p>
<p><img alt="Integration icons in the checks list" src="IMG_URL/checks_integrations.png" /></p>
<p>You can also toggle the integrations on and off when viewing an individual check by
clicking on the "ON" / "OFF" labels:</p>
<p>You can also toggle the integrations by clicking the "ON" / "OFF" labels in
individual check's details pages:</p>
<p><img alt="Integration on/off toggles in the check details page" src="IMG_URL/details_integrations.png" /></p>
<h2>SMS, WhatsApp and Phone Call Monthly Quotas</h2>
<p>SITE_NAME limits the maximum number of SMS, WhatsApp and phone call notifications an
account can send per any given month. The specific limit depends on account's
billing plan.</p>
<p>The limit is applied to the combined number of sent SMS, WhatsApp and phone call
notifications. It automatically resets at the start of each month. The "unused" sends
from one month do not carry over to the next month.</p>
<h2>SMS, WhatsApp, and Phone Call Monthly Quotas</h2>
<p>SITE_NAME sets a quota on the maximum number of SMS, WhatsApp, and phone-call
notifications an account can send per given month. The specific limit depends on the
account's billing plan. The quota automatically resets at the start of each month.
The "unused" sends from one month do not carry over to the next month.</p>
<p>When an account exceeds its monthly limit, SITE_NAME will:</p>
<ul>
<li>Send a warning email to account's primary email address</li>
@ -41,22 +40,22 @@ PagerTree), you can set up escalation rules there.</li>
play a loud notification sound on your phone every 5 minutes until the notification
is acknowledged.</li>
<li>SITE_NAME can send <strong>hourly or daily email reminders</strong> if any check is down
across all projects you have access to.
in any of your projects.
Set them up in <a href="../../accounts/profile/notifications">Account Settings › Email Reports</a>:</li>
</ul>
<p><img alt="Email reminder options" src="IMG_URL/email_reports.png" /></p>
<h2>Monthly Reports</h2>
<p>SITE_NAME sends monthly email reports at the start of each month. Use them
to make sure all checks have their expected state and nothing has
"fallen through the cracks".</p>
<p>A monthly report shows checks from all projects you have access
to. For each check it lists:</p>
"fallen through the cracks."</p>
<p>A monthly report shows checks from all your projects.
For each check it lists:</p>
<ul>
<li>check's current status</li>
<li>the number of downtimes by month, for the two previous months</li>
<li>the total downtime duration by month, for the two previous months</li>
<li>the number of downtimes by month, for the last two months</li>
<li>the total downtime duration by month, for the last two months</li>
</ul>
<p><img alt="Example monthly report" src="IMG_URL/monthly_report.png" /></p>
<p>You can opt out from the monthly reports in the
<p>You can opt-out from the monthly reports in the
<a href="../../accounts/profile/notifications/">Account Settings › Email Reports</a> page
or by clicking the "Unsubscribe" link in report's footer.</p>
or by clicking the "Unsubscribe" link in the email report's footer.</p>

54
templates/docs/configuring_notifications.md
View File

@ -1,39 +1,37 @@
# Configuring Notifications
You can set up multiple ways to receive notifications when checks in your account
change state. This is useful for multiple reasons:
change state. This is useful for several reasons:
* **Redundancy in case of notification failures.** Set up notifications using two different
transports (for example, email and Slack). If one transport fails (e.g., an email
message goes to spam), you still receive the notification over the other transport.
* **Redundancy in case of notification failures.** Set up notifications using two
different notification channels (for example, email and Slack). If one transport
fails (e.g., an email message goes to spam), you still receive a notification over the
other channel.
* **Use different notification methods depending on urgency**. For example, if a
low-priority housekeeping script fails, post a message in chat. If a vital service fails,
post in chat, send an email, and send SMS.
post in chat, send an email and send SMS.
* Route notifications to the right people.
Notification methods ("integrations") are scoped to a project:
if you want to use a notification method in multiple projects, it must be
set up in each project separately.
Each notification method ("integration") belongs to a project:
if you want to use a notification method in multiple projects, you will need to
set it up in each project separately.
In the web interface, the list of checks shows a visual overview of which alerting
methods are enabled for each check. You can click the icons to toggle them on and off:
In the web interface, the "Checks" page shows a visual overview of which alerting
methods are active for each check. You can click the icons to toggle them on and off:
![Integration icons in the checks list](IMG_URL/checks_integrations.png)
You can also toggle the integrations on and off when viewing an individual check by
clicking on the "ON" / "OFF" labels:
You can also toggle the integrations by clicking the "ON" / "OFF" labels in
individual check's details pages:
![Integration on/off toggles in the check details page](IMG_URL/details_integrations.png)
## SMS, WhatsApp and Phone Call Monthly Quotas
## SMS, WhatsApp, and Phone Call Monthly Quotas
SITE_NAME limits the maximum number of SMS, WhatsApp and phone call notifications an
account can send per any given month. The specific limit depends on account's
billing plan.
The limit is applied to the combined number of sent SMS, WhatsApp and phone call
notifications. It automatically resets at the start of each month. The "unused" sends
from one month do not carry over to the next month.
SITE_NAME sets a quota on the maximum number of SMS, WhatsApp, and phone-call
notifications an account can send per given month. The specific limit depends on the
account's billing plan. The quota automatically resets at the start of each month.
The "unused" sends from one month do not carry over to the next month.
When an account exceeds its monthly limit, SITE_NAME will:
@ -52,7 +50,7 @@ PagerTree), you can set up escalation rules there.
play a loud notification sound on your phone every 5 minutes until the notification
is acknowledged.
* SITE_NAME can send **hourly or daily email reminders** if any check is down
across all projects you have access to.
in any of your projects.
Set them up in [Account Settings › Email Reports](../../accounts/profile/notifications):
![Email reminder options](IMG_URL/email_reports.png)
@ -61,17 +59,17 @@ Set them up in [Account Settings › Email Reports](../../accounts/profile/notif
SITE_NAME sends monthly email reports at the start of each month. Use them
to make sure all checks have their expected state and nothing has
"fallen through the cracks".
"fallen through the cracks."
A monthly report shows checks from all projects you have access
to. For each check it lists:
A monthly report shows checks from all your projects.
For each check it lists:
* check's current status
* the number of downtimes by month, for the two previous months
* the total downtime duration by month, for the two previous months
* the number of downtimes by month, for the last two months
* the total downtime duration by month, for the last two months
![Example monthly report](IMG_URL/monthly_report.png)
You can opt out from the monthly reports in the
You can opt-out from the monthly reports in the
[Account Settings › Email Reports](../../accounts/profile/notifications/) page
or by clicking the "Unsubscribe" link in report's footer.
or by clicking the "Unsubscribe" link in the email report's footer.

39
templates/docs/projects_teams.html
View File

@ -1,7 +1,7 @@
<h1>Projects and Teams</h1>
<p>Use Projects to organize checks in your SITE_NAME account. Your account initially
has a single default project. You can create additional projects and organize
your checks in them as your usage grows.</p>
has a single default project. You can create additional projects and transfer
your checks between them as your usage grows.</p>
<p><img alt="An overview of projects" src="IMG_URL/projects.png" /></p>
<p>Checks and integrations are project-scoped: each check and each configured
integration always belongs to a particular project. Checks can be transferred
@ -9,12 +9,12 @@ from one project to another, preserving check's ping address:</p>
<p><img alt="The transfer dialog" src="IMG_URL/transfer_check.png" /></p>
<h2>Team Access</h2>
<p>You can grant your colleagues access to a project by inviting them into
the project's team. Each project has its own separate team so you can grant access
the project's team. Each project has its separate team so you can grant access
selectively. Inviting team members is <strong>more convenient and more
secure</strong> than sharing a password to a single account.</p>
<p><img alt="Team access section" src="IMG_URL/team_access.png" /></p>
<p>The user who originally created the project is listed as <strong>owner</strong>. Any invited users
are listed as <strong>members</strong>. The members can:</p>
<p>The user who created the project is the <strong>owner</strong>. Any invited users
are <strong>members</strong>. The members can:</p>
<ul>
<li>create, edit and remove checks</li>
<li>create and remove integrations</li>
@ -30,7 +30,7 @@ are listed as <strong>members</strong>. The members can:</p>
<li>remove the project</li>
</ul>
<h2>Read-only Access</h2>
<p>When inviting a team member, their membership can be marked as read-only:</p>
<p>When inviting a team member, you can mark their membership as read-only:</p>
<p><img alt="The Access Level parameter in the Invite form" src="IMG_URL/invite_member.png" /></p>
<p>Read-only members can:</p>
<ul>
@ -38,25 +38,26 @@ are listed as <strong>members</strong>. The members can:</p>
<li>view integrations</li>
<li>give up their membership</li>
</ul>
<p>Read-only members can not modify checks, integrations or project settings.
They also cannot access project's API keys as that would effectively give them
<p>Read-only members can not modify checks, integrations, or project settings.
They also cannot access the project's API keys as that would effectively give them
read-write access through API.</p>
<h2>Projects and Check Limits</h2>
<p><strong>Check limit</strong> is the total number of checks your account can have. The specific
limit depends on the account's billing plan.</p>
<p>Account's check limit is shared by all projects owned by your account.
<p><strong>Check Limit</strong> is the total number of checks your account can have. The specific
limit depends on the account's billing plan. When you reach the Check Limit
you will not be able to create new checks.</p>
<p>All projects owned by your account shares your account's Check Limit.
For example, consider a Business account with two projects,
"Project A" and "Project B". If A has 70 checks, then B cannot have more than
30 checks, in order to not exceed the Business account's total limit of 100.</p>
<p>However, only checks from your own projects count towards your account's
quota. If you get invited to somebody else's project, that does not change
the number of checks you can create in your own projects.</p>
the number of checks you can create in your projects.</p>
<h2>Projects and Team Size Limits</h2>
<p><strong>Team size</strong> is the number of unique users you can invite in your projects.
The team size limit is also shared by all projects owned by your account.
However, if you invite the same user (using the same email address) into several
projects, it only takes up a single "seat".</p>
<p><strong>Team Size</strong> is the number of <em>unique</em> users you can invite in your projects.
Same as with Check Limit, all projects share your account's Team Size limit.
However, if you invite the same user (using the same email address) into multiple
projects, it only takes up a single seat.</p>
<h2>Projects and Monthly Reports</h2>
<p>SITE_NAME sends monthly email reports at the
start of each month. The monthly reports list a summary of checks from
<strong>all projects you have access to</strong> (either as the owner or as a member).</p>
<p>SITE_NAME sends monthly email reports at the start of each month. The monthly reports
list a summary of checks from <strong>all your projects</strong>. It contains status summaries for
both the projects you own, and the projects you are a member of.</p>

39
templates/docs/projects_teams.md
View File

@ -1,8 +1,8 @@
# Projects and Teams
Use Projects to organize checks in your SITE_NAME account. Your account initially
has a single default project. You can create additional projects and organize
your checks in them as your usage grows.
has a single default project. You can create additional projects and transfer
your checks between them as your usage grows.
![An overview of projects](IMG_URL/projects.png)
@ -15,14 +15,14 @@ from one project to another, preserving check's ping address:
## Team Access
You can grant your colleagues access to a project by inviting them into
the project's team. Each project has its own separate team so you can grant access
the project's team. Each project has its separate team so you can grant access
selectively. Inviting team members is **more convenient and more
secure** than sharing a password to a single account.
![Team access section](IMG_URL/team_access.png)
The user who originally created the project is listed as **owner**. Any invited users
are listed as **members**. The members can:
The user who created the project is the **owner**. Any invited users
are **members**. The members can:
* create, edit and remove checks
* create and remove integrations
@ -39,7 +39,7 @@ The members **can not**:
## Read-only Access
When inviting a team member, their membership can be marked as read-only:
When inviting a team member, you can mark their membership as read-only:
![The Access Level parameter in the Invite form](IMG_URL/invite_member.png)
@ -49,33 +49,34 @@ Read-only members can:
* view integrations
* give up their membership
Read-only members can not modify checks, integrations or project settings.
They also cannot access project's API keys as that would effectively give them
Read-only members can not modify checks, integrations, or project settings.
They also cannot access the project's API keys as that would effectively give them
read-write access through API.
## Projects and Check Limits
**Check limit** is the total number of checks your account can have. The specific
limit depends on the account's billing plan.
**Check Limit** is the total number of checks your account can have. The specific
limit depends on the account's billing plan. When you reach the Check Limit
you will not be able to create new checks.
Account's check limit is shared by all projects owned by your account.
All projects owned by your account shares your account's Check Limit.
For example, consider a Business account with two projects,
"Project A" and "Project B". If A has 70 checks, then B cannot have more than
30 checks, in order to not exceed the Business account's total limit of 100.
However, only checks from your own projects count towards your account's
quota. If you get invited to somebody else's project, that does not change
the number of checks you can create in your own projects.
the number of checks you can create in your projects.
## Projects and Team Size Limits
**Team size** is the number of unique users you can invite in your projects.
The team size limit is also shared by all projects owned by your account.
However, if you invite the same user (using the same email address) into several
projects, it only takes up a single "seat".
**Team Size** is the number of *unique* users you can invite in your projects.
Same as with Check Limit, all projects share your account's Team Size limit.
However, if you invite the same user (using the same email address) into multiple
projects, it only takes up a single seat.
## Projects and Monthly Reports
SITE_NAME sends monthly email reports at the
start of each month. The monthly reports list a summary of checks from
**all projects you have access to** (either as the owner or as a member).
SITE_NAME sends monthly email reports at the start of each month. The monthly reports
list a summary of checks from **all your projects**. It contains status summaries for
both the projects you own, and the projects you are a member of.