Streaming

Quickstart link preview

This page mirrors the link types on the Redpanda quickstart. None of the external links below use the ^ suffix — the docs-ui rule opens them in a new tab anyway (which is what makes the per-link ^ unnecessary).

Deploy Redpanda

This quickstart uses Docker. To download the Redpanda binary, see GitHub. For a managed option, sign up for Redpanda Cloud.

For Docker Compose, see the Docker Compose documentation. On Windows, use Windows Subsystem for Linux.

The source code for the data transform function is in the docker-compose/transform/transform.go file that you downloaded. This file is commented to explain how it works.

The profile is configured in the docker-compose/rpk-profile.yaml file that you downloaded.

Explore Redpanda Console

Redpanda Console runs locally at Console on localhost:8080, and the object store UI is at MinIO on localhost:9001. These now open in a new tab too.

Hardening cases

These exercise the URL parsing in the JS (hostname comparison, not substring matching):

  • An external URL that mentions an internal host in its path still opens in a new tab: example.com/docs.redpanda.com/…​. (The CSS icon rule is substring-based, so this link shows no icon — a known, cosmetic-only divergence.)

  • An external host that merely ends with an internal host’s spelling is still external: fakenetlify.app.example.com — new tab. Real subdomains such as deploy-preview-417—​docs-ui.netlify.app stay internal.

  • A mailto: link is untouched — same tab semantics, no icon, no hint: email support.

  • An explicit target set by the author is respected and not overridden: redpanda.com blog, forced same-tab.

Next steps

  • For production, see the internal docs: Kubernetes deployment guides — an internal docs.redpanda.com link, so no icon and same tab.

  • An internal link written with ^ opens in a new tab but shows no icon (it’s on docs.redpanda.com): Intro to events. It should still get rel="noopener" and the "(opens in a new tab)" hint.

  • An external link written with ^ still works and is not double-targeted: Redpanda home.