-
Notifications
You must be signed in to change notification settings - Fork 9
Sp docs improvements #114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sp docs improvements #114
Changes from 4 commits
987989f
f344ecc
8388ba8
1466f57
dbcc6d8
61d2cd0
e319447
c4764c5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,15 @@ | ||
| --- | ||
| title: 'Creating a Status Page' | ||
| description: 'Create a status page.' | ||
| description: 'Create a Status Page.' | ||
| sidebarTitle: 'Creating a Status Page' | ||
| --- | ||
|
|
||
| To set up a status page, select ‘New status page’ on the [Status page overview](https://app.checklyhq.com/status-pages). | ||
| To set up a Status Page, select ‘New status page’ on the [Status page overview](https://app.checklyhq.com/status-pages). | ||
|
|
||
| 1. Begin by selecting a name for your page. | ||
| 2. Next, create at least one **card** for your page. Cards define the order and grouping of services on your page. One card can contain one or multiple **services** and will show the average uptime for all the services on the card. | ||
| 3. If you haven’t already created a service for your page, you can do so from the `Services` dropdown. [Read more about services here](/communicate/status-pages/overview#services). | ||
| 4. Select a subdomain for your page. By default status pages will use the domain `.checkly-status-pages.com` but you can also use your own domain. See [Custom domains](/communicate/status-pages/customization#custom-domains) for details on how to configure this. | ||
| 5. When you are happy with your setup, click ‘Create status page.’ You will now see a preview of your page, and below the status page name, you have a link to the public page. | ||
| 1. Begin by entering a name for your page. | ||
| 2. Next, fill in the first **card**'s title and add services to it. Cards enable grouping **services** on your page and will show the average uptime for all the services listed on the card. | ||
| 3. If you haven’t already created any service yet, you can do so from the `Services` dropdown by typing a name and clicking `Create`. See [Services](/communicate/status-pages/overview#services) for more details. | ||
|
thebiglabasky marked this conversation as resolved.
Outdated
|
||
| 4. Customize the subdomain for your page. By default status pages will use the domain `.checkly-status-pages.com` but you can also use your own domain. See [Custom domains](/communicate/status-pages/customization#custom-domains) for more details. | ||
|
thebiglabasky marked this conversation as resolved.
Outdated
|
||
| 5. When you are happy with your setup, click ‘Create status page.’ You will now see a preview of your page, and a link to the public version of the page below the title. | ||
|
|
||
| You can now share the link to your status page, and your users can subscribe to receive notifications when incidents are posted. | ||
|
|
||
| ### Service Creation and Management | ||
|
|
||
| Create services that align with how your users think about your application: | ||
|
|
||
| ```yaml | ||
| # Good service examples | ||
| Frontend Application: | ||
| - Website loading and navigation | ||
| - User interface responsiveness | ||
| - Client-side functionality | ||
|
|
||
| API Services: | ||
| - Core API endpoints | ||
| - Authentication services | ||
| - Data processing capabilities | ||
|
|
||
| Third-party Integrations: | ||
| - Payment processors | ||
| - Email delivery services | ||
| - External data sources | ||
| ``` | ||
|
|
||
| <Tip> | ||
| Create services from your users' perspective, not your internal architecture. Users care about "Login" working, not whether your "Auth microservice cluster" is healthy. | ||
| </Tip> | ||
| You can now share the link to your Status Page, and your users can subscribe to receive notifications when incidents are posted! | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this guide for owners or for users of their status pages? I have mixed feelings, generally feels like they need to understand how subscribing to notifications works, from either perspective, but the simplest way possible? @thebiglabasky
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I picked up the docs as they were but believe the caveat about limits (for owners) is quite important to have if people have questions about that. To some degree it could also explain why users wouldn't receive notifications. |
Uh oh!
There was an error while loading. Please reload this page.