Browse Source

"Projects and Teams" in docs

pull/328/head
Pēteris Caune 5 years ago
parent
commit
1b8460f39f
No known key found for this signature in database GPG Key ID: E28D7679E9A9EDE2
8 changed files with 111 additions and 4 deletions
  1. BIN
      static/img/docs/projects.png
  2. BIN
      static/img/docs/team_access.png
  3. BIN
      static/img/docs/transfer_check.png
  4. +5
    -2
      templates/docs/configuring_notifications.html
  5. +6
    -2
      templates/docs/configuring_notifications.md
  6. +43
    -0
      templates/docs/projects_teams.html
  7. +56
    -0
      templates/docs/projects_teams.md
  8. +1
    -0
      templates/front/base_docs.html

BIN
static/img/docs/projects.png View File

Before After
Width: 1217  |  Height: 637  |  Size: 47 KiB

BIN
static/img/docs/team_access.png View File

Before After
Width: 669  |  Height: 740  |  Size: 51 KiB

BIN
static/img/docs/transfer_check.png View File

Before After
Width: 1010  |  Height: 750  |  Size: 87 KiB

+ 5
- 2
templates/docs/configuring_notifications.html View File

@ -29,7 +29,7 @@ play a loud notification sound on your phone every 5 minutes until the notificat
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.
Set them up in <a href="../../accounts/profile/">Account Settings › Email Reports</a>:</li>
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>
@ -43,4 +43,7 @@ to. For each check it lists:</p>
<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>
</ul>
<p><img alt="Example monthly report" src="IMG_URL/monthly_report.png" /></p>
<p><img alt="Example monthly report" src="IMG_URL/monthly_report.png" /></p>
<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>

+ 6
- 2
templates/docs/configuring_notifications.md View File

@ -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)
![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.

+ 43
- 0
templates/docs/projects_teams.html View File

@ -0,0 +1,43 @@
<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>
<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
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
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>
<ul>
<li>create, edit and remove checks</li>
<li>create and remove integrations</li>
<li>rename the project</li>
<li>view and regenerate project's API keys</li>
<li>give up their membership
(from their <a href="../../accounts/profile">Account Settings</a> page)</li>
</ul>
<p>The members <strong>can not</strong>:</p>
<ul>
<li>invite new members into the project</li>
<li>manage project's billing</li>
<li>remove the project</li>
</ul>
<h2>Projects and Resource Limits</h2>
<p>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.</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>
<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>

+ 56
- 0
templates/docs/projects_teams.md View File

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

+ 1
- 0
templates/front/base_docs.html View File

@ -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" %}
<li class="nav-header">Pinging Examples</li>
{% include "front/docs_nav_item.html" with slug="http_api" title="HTTP API" %}


Loading…
Cancel
Save