0
0
Fork 0
mirror of https://github.com/healthchecks/healthchecks.git synced 2025-04-08 06:30:05 +00:00

Update screenshots in docs to show the slug field

This commit is contained in:
Pēteris Caune 2023-07-07 10:22:35 +03:00
parent 9c00938516
commit 39682d900f
No known key found for this signature in database
GPG key ID: E28D7679E9A9EDE2
4 changed files with 10 additions and 2 deletions

Binary file not shown.

Before

(image error) Size: 29 KiB

After

(image error) Size: 34 KiB

Binary file not shown.

Before

(image error) Size: 42 KiB

After

(image error) Size: 50 KiB

View file

@ -5,13 +5,17 @@ each cron job to be monitored. SITE_NAME pricing plans are structured primarily
around how many checks you can have in your account. You can create checks
either in SITE_NAME web interface or via <a href="../api/">Management API</a>.</p>
<h2>Name, Tags, Description</h2>
<p>Describe each check using an optional name, tags, and description fields.</p>
<p>Describe each check using an optional name, slug, tags, and description fields.</p>
<p><img alt="Editing name, tags and description" src="IMG_URL/edit_name.png" /></p>
<ul>
<li><strong>Name</strong>: names are optional, but it is a good idea to set them.
Good naming becomes especially important as you add more checks to the
account. SITE_NAME will display check names in the web interface, in email reports,
and in notifications.</li>
<li><strong>Slug</strong>: URL-friendly identifier, used in <a href="../http_api/#success-slug">slug-based ping URLs</a>
(an alternative to the default UUID-based ping URLs). The slug should only contain the
following characters: <code>a-z</code>, <code>0-9</code>, hyphens, underscores. If you don't plan to use
slug-based ping URLs, you can leave the slug field empty.</li>
<li><strong>Tags</strong>: a space-separated list of optional labels. Use tags to organize and group
checks within a project. You can tag checks by the environment
(<code>prod</code>, <code>staging</code>, <code>dev</code>, etc.) or by role (<code>www</code>, <code>db</code>, <code>worker</code>, etc.) or using

View file

@ -8,7 +8,7 @@ either in SITE_NAME web interface or via [Management API](../api/).
## Name, Tags, Description
Describe each check using an optional name, tags, and description fields.
Describe each check using an optional name, slug, tags, and description fields.
![Editing name, tags and description](IMG_URL/edit_name.png)
@ -16,6 +16,10 @@ Describe each check using an optional name, tags, and description fields.
Good naming becomes especially important as you add more checks to the
account. SITE_NAME will display check names in the web interface, in email reports,
and in notifications.
* **Slug**: URL-friendly identifier, used in [slug-based ping URLs](../http_api/#success-slug)
(an alternative to the default UUID-based ping URLs). The slug should only contain the
following characters: `a-z`, `0-9`, hyphens, underscores. If you don't plan to use
slug-based ping URLs, you can leave the slug field empty.
* **Tags**: a space-separated list of optional labels. Use tags to organize and group
checks within a project. You can tag checks by the environment
(`prod`, `staging`, `dev`, etc.) or by role (`www`, `db`, `worker`, etc.) or using