Skip to content

update docs spelling #1365

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

Merged
merged 3 commits into from
Nov 14, 2025
Merged

update docs spelling #1365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c1db33
update docs spelling
MikeShi42 Nov 13, 2025
f3d0cf0
Merge branch 'main' into mikeshi/fix-docs
kodiakhq[bot] Nov 14, 2025
634b3be
Merge branch 'main' into mikeshi/fix-docs
kodiakhq[bot] Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions DEPLOY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
Loading