First draft for TCP check docs page

[sujaya-sys]

Overview

• Developer documentation for TCP checks
• For TCP related updates of our existing documentation a separate PR will be created

Open Questions

• The "TCP check" menu item is shown at the very bottom. I'd like to move it below "API checks". Does anyone know how this can be done? The weight in _index does not seem to work here.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
checklyhq-com	✅ Ready (Inspect)	Visit Preview	✅ 1 resolved	Dec 20, 2024 0:51am

[pmallol]

Open Questions

• The "TCP check" menu item is shown at the very bottom. I'd like to move it below "API checks". Does anyone know how this can be done? The weight in _index does not seem to work here.
• I commented out the tabs for CLI; TF; Pulumi in the code but they still show up in the preview. Any idea how to avoid that?

cc @sujaya-sys

1. If I understand correctly we need to explicitly add it to the configuration file:
   

   docs.checklyhq.com/site/config.toml

   Lines 63 to 82 in f77870f

   	[[menu.resources]]
   	name = "API checks"
   	url = "/docs/api-checks/"
   	weight = 20
   	[[menu.resources]]
   	name = "Browser checks"
   	url = "/docs/browser-checks/"
   	weight = 30
   	[[menu.resources]]
   	name = "Heartbeat checks"
   	url = "/docs/heartbeat-checks/"
   	weight = 35
   	[[menu.resources]]
   	name = "Multistep checks"
   	url = "/docs/multistep-checks/"
   	weight = 40

2. In Hugo templating you can comment out code using {{ % comment %}} [...] {{ % /comment %}} or just deleting the content if not being used for the moment

[tnolet]

Looks like a good placeholder for further content, having the UI / CLI / TF / Pulumi in tabs feels a bit much. The reference documentation can be used here to explain the what and why of a TCP check. We can describe shortly how the MaC variants can be used to create one, but we should add the extensive reference docs for a TCPCheck construct for CLI/TF/Pulumi in the relevant sections.

This means I would ditch the tabbed menus once we have these providers and just give a short example inline. This makes it easier to read as scrolling is much more a native reading experience than clicking tabs.

I would just make a small H2 or H3. This will also make them show up in the Table of Contents on the right side. Then we can link to the "extensive" reference docs in the relevant section, e.g. CLI / Constructs.

But lets fix that once we have actual MaC providers.

[sujaya-sys]

Looks like a good placeholder for further content, having the UI / CLI / TF / Pulumi in tabs feels a bit much. The reference documentation can be used here to explain the what and why of a TCP check. We can describe shortly how the MaC variants can be used to create one, but we should add the extensive reference docs for a TCPCheck construct for CLI/TF/Pulumi in the relevant sections.

This means I would ditch the tabbed menus once we have these providers and just give a short example inline. This makes it easier to read as scrolling is much more a native reading experience than clicking tabs.

I would just make a small H2 or H3. This will also make them show up in the Table of Contents on the right side. Then we can link to the "extensive" reference docs in the relevant section, e.g. CLI / Constructs.

But lets fix that once we have actual MaC providers.

That makes a lot of sense, thanks Tim! Let's keep the tabs to make it clear for early users that we're only supporting the UI ATM and replace them with proper references once CLI/TF etc. docs are available 👍