-
Notifications
You must be signed in to change notification settings - Fork 4
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 all 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,14 @@ | ||
| --- | ||
| 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 title**. Now add or create services in it. Group several **services** on a single card to display the average uptime for all services listed in the card. For example, you can use one card per feature, and aggregate all services associated with the feature into a single card. | ||
| 4. Customize the subdomain slug for your page. Status pages use the domain `<slug>.checkly-status-pages.com` by default. See [Custom domains](/communicate/status-pages/customization#custom-domains) for more details on how to use your own domain. | ||
| 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! |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,25 +4,46 @@ description: 'Add a custom domain and look & feel to your Status Page.' | |||||
| sidebarTitle: 'Customization' | ||||||
| --- | ||||||
|
|
||||||
| ## Custom Domain | ||||||
| You can host your Status Page under your own domain. To make this work, you need to do a few things: | ||||||
| ## Custom domain | ||||||
|
|
||||||
| 1. Add a valid custom domain to your status page. | ||||||
| <Note> | ||||||
| Custom domains are available on Communicate Starter, Team and Enterprise plans. [View pricing](https://checklyhq.com/pricing) | ||||||
| </Note> | ||||||
|
|
||||||
| You can host your Status Page on your own domain. To set it up, add the domain in Checkly and create the required DNS records with your DNS provider. | ||||||
|
|
||||||
| <Steps> | ||||||
| <Step title="Add a custom domain to your Status Page"> | ||||||
|  | ||||||
| </Step> | ||||||
|
|
||||||
| 2. Create a CNAME record in your DNS that points to custom-domain.checkly-status-page.com | ||||||
| Any DNS provider will have the option to easily add CNAME records. For example on Cloudflare this looks as follows. | ||||||
| <Step title="Create a CNAME record that points to `custom-slug.checkly-status-page.com`"> | ||||||
| Create a CNAME record with your DNS provider and point it to `custom-slug.checkly-status-page.com` | ||||||
| For example, in Cloudflare, the configuration looks like this: | ||||||
|  | ||||||
| If your provider is Cloudflare, you also need to disable the proxy on the CNAME, it should always be set to DNS only. | ||||||
| If your provider is Cloudflare, you must disable the proxy on the CNAME, it should always be set to DNS only. | ||||||
| </Step> | ||||||
|
|
||||||
| 3. Verify you are the owner of the domain by adding a `TXT` record to your DNS. The record can be copied from the status page configuration page after providing a custom domain and saving the page once. | ||||||
| <Step title="Verify domain ownership by adding a TXT record"> | ||||||
| Copy the domain-verification TXT record from the Status Page configuration after you've added your custom domain and save the page. | ||||||
|
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.
Suggested change
|
||||||
|
|
||||||
| 4. Add validation `TXT` record(s). The record can be copied from the status page configuration page after providing a custom domain and saving the page once. | ||||||
|  | ||||||
| <Note> | ||||||
| Search engines require this verification to index and list your Status Page. | ||||||
|
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. For search engine indexing, they'll need to verify ownership of their domain from the Google Console rather, the TXT for this is provided by Google during verification, not us. I'd say this step customers should be aware, but it would come after everything is set up already with the custom domain
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. Do you think we should update the accordingly then? Just trying to ensure we're not saying anything technically wrong for now
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. Yeah I think we can either skip mentioning indexing at all, or mention it at the bottom after the custom domain setup details |
||||||
| </Note> | ||||||
| </Step> | ||||||
| <Step title="Add validation `TXT` record(s)"> | ||||||
| Copy the validation TXT record(s) from the Status Page configuration after you've added your custom domain and save the page. | ||||||
|  | ||||||
| </Step> | ||||||
| </Steps> | ||||||
|
|
||||||
| ## Customize your status page to match your brand identity | ||||||
| ## Customize your Status Page to match your brand identity | ||||||
|
|
||||||
| - Upload your company logo and the link it should direct to | ||||||
| - Upload your company logo and the link it should open | ||||||
| - Upload a custom favicon | ||||||
| - Choose the default theme between auto (system), light or dark theme | ||||||
| - Choose the default theme: auto (system), light or dark | ||||||
| - Customize the color theme to match your brand | ||||||
|
|
||||||
| <Note> | ||||||
| Theme customization is available on Communicate Team and Enterprise plans. [View pricing](https://checklyhq.com/pricing) | ||||||
| </Note> | ||||||
|
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has to be specifically
custom-domain.checkly-status-page.com