diff --git a/static/img/docs/projects.png b/static/img/docs/projects.png new file mode 100644 index 00000000..e5fb9ec0 Binary files /dev/null and b/static/img/docs/projects.png differ diff --git a/static/img/docs/team_access.png b/static/img/docs/team_access.png new file mode 100644 index 00000000..728fe00c Binary files /dev/null and b/static/img/docs/team_access.png differ diff --git a/static/img/docs/transfer_check.png b/static/img/docs/transfer_check.png new file mode 100644 index 00000000..cfec3c54 Binary files /dev/null and b/static/img/docs/transfer_check.png differ diff --git a/templates/docs/configuring_notifications.html b/templates/docs/configuring_notifications.html index 024d113d..8abbc4ee 100644 --- a/templates/docs/configuring_notifications.html +++ b/templates/docs/configuring_notifications.html @@ -29,7 +29,7 @@ play a loud notification sound on your phone every 5 minutes until the notificat is acknowledged.
  • SITE_NAME can send hourly or daily email reminders if any check is down across all projects you have access to. -Set them up in Account Settings › Email Reports:
  • +Set them up in Account Settings › Email Reports:

    Email reminder options

    Monthly Reports

    @@ -43,4 +43,7 @@ to. For each check it lists:

  • the number of downtimes by month, for the two previous months
  • the total downtime duration by month, for the two previous months
  • -

    Example monthly report

    \ No newline at end of file +

    Example monthly report

    +

    You can opt out from the monthly reports in the +Account Settings › Email Reports page +or by clicking the "Unsubscribe" link in report's footer.

    \ No newline at end of file diff --git a/templates/docs/configuring_notifications.md b/templates/docs/configuring_notifications.md index 6a2fdc5e..69a52752 100644 --- a/templates/docs/configuring_notifications.md +++ b/templates/docs/configuring_notifications.md @@ -36,7 +36,7 @@ play a loud notification sound on your phone every 5 minutes until the notificat is acknowledged. * SITE_NAME can send **hourly or daily email reminders** if any check is down across all projects you have access to. -Set them up in [Account Settings › Email Reports](../../accounts/profile/): +Set them up in [Account Settings › Email Reports](../../accounts/profile/notifications): ![Email reminder options](IMG_URL/email_reports.png) @@ -53,4 +53,8 @@ to. For each check it lists: * the number of downtimes by month, for the two previous months * the total downtime duration by month, for the two previous months -![Example monthly report](IMG_URL/monthly_report.png) \ No newline at end of file +![Example monthly report](IMG_URL/monthly_report.png) + +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. \ No newline at end of file diff --git a/templates/docs/projects_teams.html b/templates/docs/projects_teams.html new file mode 100644 index 00000000..35d26b43 --- /dev/null +++ b/templates/docs/projects_teams.html @@ -0,0 +1,43 @@ +

    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.

    +

    An overview of projects

    +

    Checks and integrations are project-scoped: each check and each configured +integration always belongs to a particular project. Checks can be transferred +from one project to another, preserving check's ping address:

    +

    The transfer dialog

    +

    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 +selectively. Inviting team members is more convenient and more +secure than sharing a password to a single account.

    +

    Team access section

    +

    The user who originally created the project is listed as owner. Any invited users +are listed as members. The members can:

    + +

    The members can not:

    + +

    Projects and Resource Limits

    +

    Your account limits (such as the total number of checks) are shared by all projects +owned by your account. 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 Bussiness 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.

    +

    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).

    \ No newline at end of file diff --git a/templates/docs/projects_teams.md b/templates/docs/projects_teams.md new file mode 100644 index 00000000..93fcbf97 --- /dev/null +++ b/templates/docs/projects_teams.md @@ -0,0 +1,56 @@ +# 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. + +![An overview of projects](IMG_URL/projects.png) + +Checks and integrations are project-scoped: each check and each configured +integration always belongs to a particular project. Checks can be transferred +from one project to another, preserving check's ping address: + +![The transfer dialog](IMG_URL/transfer_check.png) + +## 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 +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: + +* create, edit and remove checks +* create and remove integrations +* rename the project +* view and regenerate project's API keys +* give up their membership +(from their [Account Settings](../../accounts/profile) page) + +The members **can not**: + +* invite new members into the project +* manage project's billing +* remove the project + +## Projects and Resource Limits + +Your account limits (such as the total number of checks) are shared by all projects +owned by your account. 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 Bussiness 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. + + +## 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). diff --git a/templates/front/base_docs.html b/templates/front/base_docs.html index c11f11c3..8b3004b6 100644 --- a/templates/front/base_docs.html +++ b/templates/front/base_docs.html @@ -14,6 +14,7 @@ {% include "front/docs_nav_item.html" with slug="monitoring_cron_jobs" title="Monitoring cron jobs" %} {% include "front/docs_nav_item.html" with slug="configuring_checks" title="Configuring checks" %} {% include "front/docs_nav_item.html" with slug="configuring_notifications" title="Configuring notifications" %} + {% include "front/docs_nav_item.html" with slug="projects_teams" title="Projects and teams" %} {% include "front/docs_nav_item.html" with slug="http_api" title="HTTP API" %}