openstatus.dev / openstatus
Openstatus www.openstatus.dev
fork atom

📝 docs (#857)

authored by

Thibault Le Ouay and committed by
GitHub 3265afdf 16e85345

+45 -19
apps/docs/api-reference/page/get-page:id.mdx apps/docs/api-reference/page/get-page-id.mdx
+10
apps/docs/help/support.mdx
··· 1 + --- 2 + title: Support 3 + description: "We're always here to help." 4 + --- 5 + 6 + If you have any questions, feedback, or need help you can: 7 + - Schedule a [call](https://cal.com/team/openstatus/30min) with us. 8 + - Join our [Discord](https://www.openstatus.dev/discord) community. 9 + - Send us an email at [ping@openstatus.dev](mailto:ping@openstatus.dev) 10 + - Open an issue on our [GitHub](https://www.github.com/openstatushq/openstatus) repository.
apps/docs/images/incident/incident-detail.png

This is a binary file and will not be displayed.

+4 -1
apps/docs/mint.json
··· 80 80 "group": "Features", 81 81 "pages": [ 82 82 "synthetic/features/incident", 83 - "synthetic/features/heartbeat", 84 83 "synthetic/features/monitor", 85 84 { 86 85 "group": "Notifications", ··· 124 123 "contributing/get-started", 125 124 "contributing/setup-env" 126 125 ] 126 + }, 127 + { 128 + "group": "Help", 129 + "pages": ["help/support"] 127 130 }, 128 131 { 129 132 "group": "API Documentation",
-14
apps/docs/synthetic/features/heartbeat.mdx
··· 1 - --- 2 - title: Cron Monitor 3 - description: "How to create your first cron monitor with OpenStatus.dev" 4 - --- 5 - 6 - ## What is a Cron Monitor? 🤔 7 - 8 - A cron monitor allows you to monitor your cron jobs. You call your OpenStatus 9 - endpoint at the end of your cron job. If we haven't received your call we will 10 - trigger an alert and notify you. 11 - 12 - ## Configure your cron monitor 🛠 13 - 14 - 🚧 Coming soon 🚧
+16
apps/docs/synthetic/features/incident.mdx
··· 21 21 22 22 We automatically resolve an incident when the monitor is passing in more than 23 23 50% of the locations. 24 + 25 + 26 + ## Incident detail page 27 + 28 + On the incident page, you can see the details of the incident, the monitor that failed, and the duration. 29 + We are also taking a screenshot of the monitor when the incident is created, and when it's resolved. 30 + 31 + 32 + <Frame caption="Incident page detail"> 33 + <img 34 + src="/images/incident/incident-detail.png" 35 + alt="Incident page" 36 + /> 37 + </Frame> 38 + 39 + <Info>There might be a delay between the incident creation and the screenshot capture. Your endpoint could have already recovered.</Info>
+7
apps/docs/synthetic/features/monitor.mdx
··· 10 10 11 11 We will make a request to your endpoint on a regular schedule and record. 12 12 13 + If the check fails, a <a href="/synthetic/features/notification">notification</a> is sent and an <a href="/synthetic/features/incident">incident</a> is created. 14 + 15 + <Info>If you are monitoring an endpoint you don't own (e.g google.com), your request might be blocked by the remote server.</Info> 16 + 13 17 14 18 ## Configure your monitor 🛠 15 19 ··· 28 32 /> 29 33 </Frame> 30 34 35 + 31 36 ### HTTP Request 📤 32 37 33 38 Customize the request sent to your endpoint. ··· 40 45 > OpenStatus automatically set the `"User-Agent": "OpenStatus/1.0"` header to 41 46 > your request. This header is used to identify the request as a ping request 42 47 > and can be exluded from your analytics. 48 + 49 + 43 50 44 51 If you select the `POST` method, you can add a custom **HTTP Body** to your 45 52 request.
+8 -4
packages/emails/emails/welcome.tsx
··· 4 4 return ( 5 5 <Html> 6 6 <Head> 7 - <title>Level up your website and API monitoring.</title> 7 + <title>Welcome to OpenStatus</title> 8 8 <Preview>Take the most of your OpenStatus monitoring</Preview> 9 9 <Body> 10 10 Hey 👋 ··· 26 26 </a>{" "} 27 27 to manage your monitors 28 28 <br />- Integrate your status within your application with our{" "} 29 - <a href="https://docs.openstatus.dev/packages/status-widget">API</a>{" "} 29 + <a href="https://docs.openstatus.dev/packages/status-widget"> 30 + API 31 + </a>{" "} 30 32 and{" "} 31 33 <a href="https://docs.openstatus.dev/packages/react">React Widget</a> 32 34 <br />- Build your own status page with our{" "} ··· 38 40 that you can easily host on CloudFlare 39 41 <br /> 40 42 <br /> 41 - If you have any questions, just let me know. 43 + If you have any questions, just let me know, or book a call with me{" "} 44 + <a href="https://cal.com/team/openstatus/30min">here</a>. 42 45 <br /> 43 46 Thank you, 44 47 <br /> ··· 47 50 <br /> 48 51 <br />⭐ Star us on{" "} 49 52 <Link href="https://github.com/openstatushq/openstatus">GitHub</Link> 50 - <br />🚀 Visit our website{" "} 53 + <br /> 54 + 🚀 Visit our website{" "} 51 55 <Link href="https://www.openstatus.dev">OpenStatus.dev</Link> 52 56 </Body> 53 57 </Head>