Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Update Heartbeat check overview page#1265

Merged
guolau merged 11 commits into
mainfrom
guolau/update-heartbeat-check-overview-page
May 6, 2025
Merged

Update Heartbeat check overview page#1265
guolau merged 11 commits into
mainfrom
guolau/update-heartbeat-check-overview-page

Conversation

@guolau

@guolau guolau commented Apr 25, 2025

Copy link
Copy Markdown
Contributor

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 Bot commented Apr 25, 2025

Copy link
Copy Markdown

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 6, 2025 2:39pm

@ragog ragog left a comment

Copy link
Copy Markdown
Contributor

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.

For example, this is how you ping a Heartbeat check from a Heroku job:

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

Copy link
Copy Markdown
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.

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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

guolau commented Apr 30, 2025

Copy link
Copy Markdown
Contributor Author

@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 👀


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

Check out this video for a quick explainer:

Copy link
Copy Markdown
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

guolau commented May 1, 2025

Copy link
Copy Markdown
Contributor Author

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
@ragog ragog requested a review from Dgiordano33 May 2, 2025 15:06
@ragog

ragog commented May 2, 2025

Copy link
Copy Markdown
Contributor

@Dgiordano33 want to give your final OK on this?

@Dgiordano33

Copy link
Copy Markdown
Collaborator

Looks great @guolau - much more balanced and super actionable!

@ragog ragog left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM @guolau

@guolau guolau merged commit c6fab96 into main May 6, 2025
6 checks passed
@guolau guolau deleted the guolau/update-heartbeat-check-overview-page branch May 6, 2025 15:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants