Skip to content

Update Heartbeat check overview page #1265

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Update Heartbeat check overview page #1265

wants to merge 10 commits into from

Conversation

guolau
Copy link
Contributor

@guolau guolau commented Apr 25, 2025

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Pre-Requisites

  • Code is linted (npm run lint)

Notes for the Reviewer

Updated the Heartbeat check overview page according to the check overview page facelift proposal.

@guolau guolau requested a review from ragog April 25, 2025 15:45
@guolau guolau requested a review from tnolet as a code owner April 25, 2025 15:45
@vercel Vercel
Copy link

vercel bot commented Apr 25, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
checklyhq-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 1, 2025 8:54pm

ragog
ragog requested changes Apr 27, 2025
View reviewed changes
Copy link
Contributor

@ragog ragog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@guolau looking good, let's address some minor points and then we're good to go.

site/content/docs/heartbeat-checks/_index.md

Here is an example of how to have a Heroku job send a ping to a Checkly heartbeat check.
{{< tabs "Heroku example" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@guolau let's not remove these tabs even when there is a single example. They still provide useful context, i.e. the language used in the snippet.

site/content/docs/heartbeat-checks/_index.md Outdated
wget -T 5 -t 3 https://ping.checklyhq.com/87c05896-3b7d-49ae-83ff-5e81323a54c4
```

You can use curl in the [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@guolau wdyt about exchanging this with Vercel cron jobs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the Heroku example and adding a Vercel one? I think that'd be good, Vercel seems more popular atm.

Vercel has examples for different JS frameworks. I could create a separate section for these examples, and copy and modify their examples for heartbeat pings.

image

@Dgiordano33
Copy link
Collaborator

@guolau @ragog - this looks great, love the change to Vercel too from Heroku, makes way more sense. Two quick things:

  1. This wasn't changed, so just feedback on the OG doc - I think the Video and Image are both too high at the top, and distract from when you land on the page. Think we could move the "What is Heartbeat Checks" text to above the nice intro image. Or just have the video first, then text, then maybe more text, then the image.

  2. Again, feedback on the OG doc - this is a single page and it's so dense. Can any of this be moved to another page in the Heartbeat Section dropdown?

@guolau
Copy link
Contributor Author

guolau commented Apr 30, 2025

@Dgiordano33 Thanks for looking over this!

  1. I see your point here, let me play around with this. The other docs pages (API, Browser have a similar format, so I'll make a note to adjust those too (at some point).
  2. Let me make the Ping examples its own page, there are quite a few of those 👀

@vercel vercel bot deployed to staging May 1, 2025 20:54 Active
guolau
guolau commented May 1, 2025
View reviewed changes
site/content/docs/heartbeat-checks/_index.md
@@ -16,19 +16,15 @@ aliases:

Monitor your scheduled jobs with Heartbeat checks. Heartbeat checks listen for regular pings from your automated tasks, to ensure that they are running as expected.

![Heartbeat check overview page](/docs/images/heartbeat-checks/heartbeat-check-overview.png)

Check out this video for a quick explainer:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this video. It takes up a lot of space and there's not really a good place for it.

It would be nice to incorporate the YouTube videos more into the docs, though. We have useful videos about all the check types, we just need a more compact format. Something like this, but for videos:
image

@guolau
Copy link
Contributor Author

guolau commented May 1, 2025

Summary of changes:

  • Moved the first image further down the page
  • Removed embedded video
  • Ping examples
    • Removed Heroku as a separate example
    • Added Vercel cron job examples
    • Made Ping examples its own docs page

@guolau guolau requested a review from ragog May 1, 2025 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tnolet tnolet Awaiting requested review from tnolet tnolet is a code owner

@ragog ragog Awaiting requested review from ragog

Requested changes must be addressed to merge this pull request.

Assignees

@guolau guolau

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@guolau @Dgiordano33 @ragog