This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 4c914270bd3 docs(observability): add intro card page and rename Legacy
to Custom Build (#3949)
4c914270bd3 is described below
commit 4c914270bd321e7c4874bfba77cca38d31b69dad
Author: Mingyu Chen (Rayner) <[email protected]>
AuthorDate: Tue Jun 23 14:47:05 2026 +0800
docs(observability): add intro card page and rename Legacy to Custom Build
(#3949)
## What
Add a card-based intro landing page for the **Observability with Doris**
section and repoint the sidebar category link to it. The page presents
the two parallel solutions as cards:
- **DOG Stack** — turnkey observability stack on Doris + OpenTelemetry +
Grafana
- **Custom Build** — build your own platform directly on Doris with SQL
Also rename the **Legacy** sub-category to **Custom Build**, since it is
a distinct, still-current approach rather than a deprecated one, and
drop the `overview` docs from the sub-category `items` lists (they
remain the category links, matching the deploy-on-kubernetes intro
pattern).
## Scope
Applied consistently across both versions and both locales:
| Version / Locale | Intro page | Sidebar |
| --- | --- | --- |
| current / en | `docs/observability/intro.mdx` | `sidebars.ts` |
| current / zh | `i18n/zh-CN/.../current/observability/intro.mdx` |
(shared) |
| 4.x / en | `versioned_docs/version-4.x/observability/intro.mdx` |
`versioned_sidebars/version-4.x-sidebars.json` |
| 4.x / zh | `i18n/zh-CN/.../version-4.x/observability/intro.mdx` |
(shared) |
Reuses the existing `GettingStartedCard` component and `cards-grid`
style (same pattern as the deploy-on-kubernetes intro).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
---
docs/install/deploy-on-kubernetes/intro.mdx | 10 ++------
docs/observability/intro.mdx | 27 ++++++++++++++++++++++
.../current/install/deploy-on-kubernetes/intro.mdx | 10 ++------
.../current/observability/intro.mdx | 27 ++++++++++++++++++++++
.../install/deploy-on-kubernetes/intro.mdx | 10 ++------
.../version-4.x/observability/intro.mdx | 27 ++++++++++++++++++++++
sidebars.ts | 6 ++---
.../install/deploy-on-kubernetes/intro.mdx | 10 ++------
versioned_docs/version-4.x/observability/intro.mdx | 27 ++++++++++++++++++++++
versioned_sidebars/version-4.x-sidebars.json | 6 ++---
10 files changed, 120 insertions(+), 40 deletions(-)
diff --git a/docs/install/deploy-on-kubernetes/intro.mdx
b/docs/install/deploy-on-kubernetes/intro.mdx
index b59a4cb90fe..8a4f5c2bd3a 100644
--- a/docs/install/deploy-on-kubernetes/intro.mdx
+++ b/docs/install/deploy-on-kubernetes/intro.mdx
@@ -14,9 +14,9 @@ On Kubernetes, Apache Doris is managed by Doris Operator.
Choose the guide that
<div className="cards-grid">
<GettingStartedCard
- title="Doris Operator"
+ title="Pre-deployment Preparation"
description="Learn what Doris Operator can do and how to install it on
Kubernetes services from different cloud providers"
- link="../doris-operator/intro"
+ link="doris-operator/intro"
/>
<GettingStartedCard
@@ -30,10 +30,4 @@ On Kubernetes, Apache Doris is managed by Doris Operator.
Choose the guide that
description="Deploy a Doris cluster on Kubernetes in storage-compute
separation mode"
link="separating-storage-compute/install-doris-cluster"
/>
-
-<GettingStartedCard
- title="Deploy Prometheus and Grafana"
- description="Deploy Prometheus and Grafana on Kubernetes with Helm to
collect and visualize metrics for a Doris compute-storage decoupled cluster"
- link="separating-storage-compute/install-prometheus-and-grafana"
-/>
</div>
diff --git a/docs/observability/intro.mdx b/docs/observability/intro.mdx
new file mode 100644
index 00000000000..3cde2faefb2
--- /dev/null
+++ b/docs/observability/intro.mdx
@@ -0,0 +1,27 @@
+---
+{
+ "title": "Observability with Doris",
+ "language": "en",
+ "description": "Build an open, high-performance, low-cost platform for
unified log, trace, and metrics analytics on Apache Doris. Choose the turnkey
DOG Stack or a custom build."
+}
+---
+
+import GettingStartedCard from
'@site/src/components/getting-started-card/getting-started-card';
+
+# Observability with Doris
+
+Apache Doris powers an open, high-performance, and low-cost platform for
unified log, trace, and metrics analytics. Choose the approach that fits your
team.
+
+<div className="cards-grid">
+<GettingStartedCard
+ title="DOG Stack"
+ description="A turnkey observability stack built on Doris, OpenTelemetry,
and Grafana, with a Kibana-like search and Jaeger-like trace experience out of
the box."
+ link="dogstack/overview"
+/>
+
+<GettingStartedCard
+ title="Custom Build"
+ description="Build your own platform directly on Doris with SQL, designing
the schema, ingestion pipelines, and dashboards yourself for full flexibility."
+ link="overview"
+/>
+</div>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/intro.mdx
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/intro.mdx
index 34524e71284..6167d167753 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/intro.mdx
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/intro.mdx
@@ -14,9 +14,9 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
<div className="cards-grid">
<GettingStartedCard
- title="Doris Operator"
+ title="部署前准备"
description="了解 Doris Operator 的能力, 以及在不同云厂商 Kubernetes 服务上的安装方式"
- link="../doris-operator/intro"
+ link="doris-operator/intro"
/>
<GettingStartedCard
@@ -30,10 +30,4 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
description="在 Kubernetes 上以存算分离模式部署 Doris 集群"
link="separating-storage-compute/install-doris-cluster"
/>
-
-<GettingStartedCard
- title="部署 Prometheus 与 Grafana"
- description="在 Kubernetes 上通过 Helm 部署 Prometheus 与 Grafana，为存算分离 Doris
集群采集与可视化监控指标"
- link="separating-storage-compute/install-prometheus-and-grafana"
-/>
</div>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/observability/intro.mdx
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/observability/intro.mdx
new file mode 100644
index 00000000000..0990ffd4dcb
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/observability/intro.mdx
@@ -0,0 +1,27 @@
+---
+{
+ "title": "基于 Doris 的可观测性",
+ "language": "zh-CN",
+ "description": "基于 Apache Doris 构建开放、高性能、低成本的 Log/Trace/Metrics
统一可观测性平台。可选择开箱即用的 DOG Stack 或自建方案。"
+}
+---
+
+import GettingStartedCard from
'@site/src/components/getting-started-card/getting-started-card';
+
+# 基于 Doris 的可观测性
+
+Apache Doris 可支撑开放、高性能、低成本的 Log/Trace/Metrics 统一可观测性分析。请根据团队需求选择合适的方案。
+
+<div className="cards-grid">
+<GettingStartedCard
+ title="DOG Stack"
+ description="基于 Doris、OpenTelemetry 和 Grafana 构建的开箱即用可观测性方案，内置类 Kibana
的搜索与类 Jaeger 的链路追踪体验。"
+ link="dogstack/overview"
+/>
+
+<GettingStartedCard
+ title="Custom Build"
+ description="直接基于 Doris 使用 SQL 自建可观测性平台，自主设计表结构、采集链路与可视化看板，灵活度最高。"
+ link="overview"
+/>
+</div>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
index 34524e71284..6167d167753 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
@@ -14,9 +14,9 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
<div className="cards-grid">
<GettingStartedCard
- title="Doris Operator"
+ title="部署前准备"
description="了解 Doris Operator 的能力, 以及在不同云厂商 Kubernetes 服务上的安装方式"
- link="../doris-operator/intro"
+ link="doris-operator/intro"
/>
<GettingStartedCard
@@ -30,10 +30,4 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
description="在 Kubernetes 上以存算分离模式部署 Doris 集群"
link="separating-storage-compute/install-doris-cluster"
/>
-
-<GettingStartedCard
- title="部署 Prometheus 与 Grafana"
- description="在 Kubernetes 上通过 Helm 部署 Prometheus 与 Grafana，为存算分离 Doris
集群采集与可视化监控指标"
- link="separating-storage-compute/install-prometheus-and-grafana"
-/>
</div>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/observability/intro.mdx
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/observability/intro.mdx
new file mode 100644
index 00000000000..0990ffd4dcb
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/observability/intro.mdx
@@ -0,0 +1,27 @@
+---
+{
+ "title": "基于 Doris 的可观测性",
+ "language": "zh-CN",
+ "description": "基于 Apache Doris 构建开放、高性能、低成本的 Log/Trace/Metrics
统一可观测性平台。可选择开箱即用的 DOG Stack 或自建方案。"
+}
+---
+
+import GettingStartedCard from
'@site/src/components/getting-started-card/getting-started-card';
+
+# 基于 Doris 的可观测性
+
+Apache Doris 可支撑开放、高性能、低成本的 Log/Trace/Metrics 统一可观测性分析。请根据团队需求选择合适的方案。
+
+<div className="cards-grid">
+<GettingStartedCard
+ title="DOG Stack"
+ description="基于 Doris、OpenTelemetry 和 Grafana 构建的开箱即用可观测性方案，内置类 Kibana
的搜索与类 Jaeger 的链路追踪体验。"
+ link="dogstack/overview"
+/>
+
+<GettingStartedCard
+ title="Custom Build"
+ description="直接基于 Doris 使用 SQL 自建可观测性平台，自主设计表结构、采集链路与可视化看板，灵活度最高。"
+ link="overview"
+/>
+</div>
diff --git a/sidebars.ts b/sidebars.ts
index d9cdc2c2fcd..667e5583d0e 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -764,7 +764,7 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'Observability with Doris',
- link: {type: 'doc', id: 'observability/dogstack/overview'},
+ link: {type: 'doc', id: 'observability/intro'},
collapsed: true,
items: [
{
@@ -773,7 +773,6 @@ const sidebars: SidebarsConfig = {
collapsed: true,
link: {type: 'doc', id:
'observability/dogstack/overview'},
items: [
- 'observability/dogstack/overview',
'observability/dogstack/quickstart',
'observability/dogstack/deployment',
'observability/dogstack/search',
@@ -784,11 +783,10 @@ const sidebars: SidebarsConfig = {
},
{
type: 'category',
- label: 'Legacy',
+ label: 'Custom Build',
collapsed: true,
link: {type: 'doc', id: 'observability/overview'},
items: [
- 'observability/overview',
'observability/log',
'observability/trace',
]
diff --git a/versioned_docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
b/versioned_docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
index b59a4cb90fe..8a4f5c2bd3a 100644
--- a/versioned_docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
+++ b/versioned_docs/version-4.x/install/deploy-on-kubernetes/intro.mdx
@@ -14,9 +14,9 @@ On Kubernetes, Apache Doris is managed by Doris Operator.
Choose the guide that
<div className="cards-grid">
<GettingStartedCard
- title="Doris Operator"
+ title="Pre-deployment Preparation"
description="Learn what Doris Operator can do and how to install it on
Kubernetes services from different cloud providers"
- link="../doris-operator/intro"
+ link="doris-operator/intro"
/>
<GettingStartedCard
@@ -30,10 +30,4 @@ On Kubernetes, Apache Doris is managed by Doris Operator.
Choose the guide that
description="Deploy a Doris cluster on Kubernetes in storage-compute
separation mode"
link="separating-storage-compute/install-doris-cluster"
/>
-
-<GettingStartedCard
- title="Deploy Prometheus and Grafana"
- description="Deploy Prometheus and Grafana on Kubernetes with Helm to
collect and visualize metrics for a Doris compute-storage decoupled cluster"
- link="separating-storage-compute/install-prometheus-and-grafana"
-/>
</div>
diff --git a/versioned_docs/version-4.x/observability/intro.mdx
b/versioned_docs/version-4.x/observability/intro.mdx
new file mode 100644
index 00000000000..3cde2faefb2
--- /dev/null
+++ b/versioned_docs/version-4.x/observability/intro.mdx
@@ -0,0 +1,27 @@
+---
+{
+ "title": "Observability with Doris",
+ "language": "en",
+ "description": "Build an open, high-performance, low-cost platform for
unified log, trace, and metrics analytics on Apache Doris. Choose the turnkey
DOG Stack or a custom build."
+}
+---
+
+import GettingStartedCard from
'@site/src/components/getting-started-card/getting-started-card';
+
+# Observability with Doris
+
+Apache Doris powers an open, high-performance, and low-cost platform for
unified log, trace, and metrics analytics. Choose the approach that fits your
team.
+
+<div className="cards-grid">
+<GettingStartedCard
+ title="DOG Stack"
+ description="A turnkey observability stack built on Doris, OpenTelemetry,
and Grafana, with a Kibana-like search and Jaeger-like trace experience out of
the box."
+ link="dogstack/overview"
+/>
+
+<GettingStartedCard
+ title="Custom Build"
+ description="Build your own platform directly on Doris with SQL, designing
the schema, ingestion pipelines, and dashboards yourself for full flexibility."
+ link="overview"
+/>
+</div>
diff --git a/versioned_sidebars/version-4.x-sidebars.json
b/versioned_sidebars/version-4.x-sidebars.json
index 089ec16ed64..2e72889479d 100644
--- a/versioned_sidebars/version-4.x-sidebars.json
+++ b/versioned_sidebars/version-4.x-sidebars.json
@@ -893,7 +893,7 @@
"label": "Observability with Doris",
"link": {
"type": "doc",
- "id": "observability/dogstack/overview"
+ "id": "observability/intro"
},
"collapsed": true,
"items": [
@@ -906,7 +906,6 @@
"id": "observability/dogstack/overview"
},
"items": [
- "observability/dogstack/overview",
"observability/dogstack/quickstart",
"observability/dogstack/deployment",
"observability/dogstack/search",
@@ -917,14 +916,13 @@
},
{
"type": "category",
- "label": "Legacy",
+ "label": "Custom Build",
"collapsed": true,
"link": {
"type": "doc",
"id": "observability/overview"
},
"items": [
- "observability/overview",
"observability/log",
"observability/trace"
]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
