From 6c1db337efd5781bb43be4243be5f7c7d0c80349 Mon Sep 17 00:00:00 2001 From: Mike Shi Date: Thu, 13 Nov 2025 18:02:05 -0500 Subject: [PATCH] update docs spelling --- CONTRIBUTING.md | 2 +- DEPLOY.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ce24d611..f20d049fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Service Descriptions: OpAMP supervisor that dynamically pulls configuration from HyperDX API. - ClickHouse (ch-server): ClickHouse database, stores all telemetry. - MongoDB (db): Stores user/saved search/alert/dashboard data. -- HyperDX API (api): Node.js API, executes Clickhouse queries on behalf of the +- HyperDX API (api): Node.js API, executes ClickHouse queries on behalf of the frontend and serves the frontend. serves the frontend. Can also run alert checker. - HyperDX UI (app): Next.js frontend, serves the UI. diff --git a/DEPLOY.md b/DEPLOY.md index 67e90597e..d39904922 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -2,7 +2,7 @@ [HyperDX](https://hyperdx.io) helps engineers quickly figure out why production is broken by making it easy to search & visualize logs and traces on top of any -Clickhouse cluster (imagine Kibana, for Clickhouse). You can learn more about +ClickHouse cluster (imagine Kibana, for ClickHouse). You can learn more about HyperDX in our [README](/README.md). HyperDX can be deployed in a few different ways: @@ -36,7 +36,7 @@ the URL your HyperDX instance is hosted on. ## All-in-one Docker Compose Stack The easiest way to get started with HyperDX from scratch is to use our -all-in-one Docker Compose stack. This stack will start Clickhouse, an +all-in-one Docker Compose stack. This stack will start ClickHouse, an OpenTelemetry collector, and HyperDX with a MongoDB instance. To get started, clone this repository and run the following command: @@ -62,7 +62,7 @@ variable to a random string. HyperDX can also be deployed alongside your existing local development stack to help you debug issues locally. This mode will start an OpenTelemetry collector, -Clickhouse, and HyperDX with a MongoDB in a single instance, without any +ClickHouse, and HyperDX with a MongoDB in a single instance, without any authentication or configuration persistence. To get started, spin up the local mode container: