Skip to content

Commit 4c91427

Browse files
morningmanclaude
morningman
and
claude
authored
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) <noreply@anthropic.com>
1 parent bad2eb7 commit 4c91427

10 files changed

Lines changed: 120 additions & 40 deletions

File tree

‎docs/install/deploy-on-kubernetes/intro.mdx‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ On Kubernetes, Apache Doris is managed by Doris Operator. Choose the guide that
1414

1515
<div className="cards-grid">
1616
<GettingStartedCard
17-
title="Doris Operator"
17+
title="Pre-deployment Preparation"
1818
description="Learn what Doris Operator can do and how to install it on Kubernetes services from different cloud providers"
19-
link="../doris-operator/intro"
19+
link="doris-operator/intro"
2020
/>
2121

2222
<GettingStartedCard
@@ -30,10 +30,4 @@ On Kubernetes, Apache Doris is managed by Doris Operator. Choose the guide that
3030
description="Deploy a Doris cluster on Kubernetes in storage-compute separation mode"
3131
link="separating-storage-compute/install-doris-cluster"
3232
/>
33-
34-
<GettingStartedCard
35-
title="Deploy Prometheus and Grafana"
36-
description="Deploy Prometheus and Grafana on Kubernetes with Helm to collect and visualize metrics for a Doris compute-storage decoupled cluster"
37-
link="separating-storage-compute/install-prometheus-and-grafana"
38-
/>
3933
</div>

‎docs/observability/intro.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
{
3+
"title": "Observability with Doris",
4+
"language": "en",
5+
"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."
6+
}
7+
---
8+
9+
import GettingStartedCard from '@site/src/components/getting-started-card/getting-started-card';
10+
11+
# Observability with Doris
12+
13+
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.
14+
15+
<div className="cards-grid">
16+
<GettingStartedCard
17+
title="DOG Stack"
18+
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."
19+
link="dogstack/overview"
20+
/>
21+
22+
<GettingStartedCard
23+
title="Custom Build"
24+
description="Build your own platform directly on Doris with SQL, designing the schema, ingestion pipelines, and dashboards yourself for full flexibility."
25+
link="overview"
26+
/>
27+
</div>

‎i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/intro.mdx‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
1414

1515
<div className="cards-grid">
1616
<GettingStartedCard
17-
title="Doris Operator"
17+
title="部署前准备"
1818
description="了解 Doris Operator 的能力, 以及在不同云厂商 Kubernetes 服务上的安装方式"
19-
link="../doris-operator/intro"
19+
link="doris-operator/intro"
2020
/>
2121

2222
<GettingStartedCard
@@ -30,10 +30,4 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
3030
description="在 Kubernetes 上以存算分离模式部署 Doris 集群"
3131
link="separating-storage-compute/install-doris-cluster"
3232
/>
33-
34-
<GettingStartedCard
35-
title="部署 Prometheus 与 Grafana"
36-
description="在 Kubernetes 上通过 Helm 部署 Prometheus 与 Grafana，为存算分离 Doris 集群采集与可视化监控指标"
37-
link="separating-storage-compute/install-prometheus-and-grafana"
38-
/>
3933
</div>

‎i18n/zh-CN/docusaurus-plugin-content-docs/current/observability/intro.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
{
3+
"title": "基于 Doris 的可观测性",
4+
"language": "zh-CN",
5+
"description": "基于 Apache Doris 构建开放、高性能、低成本的 Log/Trace/Metrics 统一可观测性平台。可选择开箱即用的 DOG Stack 或自建方案。"
6+
}
7+
---
8+
9+
import GettingStartedCard from '@site/src/components/getting-started-card/getting-started-card';
10+
11+
# 基于 Doris 的可观测性
12+
13+
Apache Doris 可支撑开放、高性能、低成本的 Log/Trace/Metrics 统一可观测性分析。请根据团队需求选择合适的方案。
14+
15+
<div className="cards-grid">
16+
<GettingStartedCard
17+
title="DOG Stack"
18+
description="基于 Doris、OpenTelemetry 和 Grafana 构建的开箱即用可观测性方案，内置类 Kibana 的搜索与类 Jaeger 的链路追踪体验。"
19+
link="dogstack/overview"
20+
/>
21+
22+
<GettingStartedCard
23+
title="Custom Build"
24+
description="直接基于 Doris 使用 SQL 自建可观测性平台，自主设计表结构、采集链路与可视化看板，灵活度最高。"
25+
link="overview"
26+
/>
27+
</div>

‎i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/install/deploy-on-kubernetes/intro.mdx‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
1414

1515
<div className="cards-grid">
1616
<GettingStartedCard
17-
title="Doris Operator"
17+
title="部署前准备"
1818
description="了解 Doris Operator 的能力, 以及在不同云厂商 Kubernetes 服务上的安装方式"
19-
link="../doris-operator/intro"
19+
link="doris-operator/intro"
2020
/>
2121

2222
<GettingStartedCard
@@ -30,10 +30,4 @@ Apache Doris 在 Kubernetes 上由 Doris Operator 管理。请根据您要部署
3030
description="在 Kubernetes 上以存算分离模式部署 Doris 集群"
3131
link="separating-storage-compute/install-doris-cluster"
3232
/>
33-
34-
<GettingStartedCard
35-
title="部署 Prometheus 与 Grafana"
36-
description="在 Kubernetes 上通过 Helm 部署 Prometheus 与 Grafana，为存算分离 Doris 集群采集与可视化监控指标"
37-
link="separating-storage-compute/install-prometheus-and-grafana"
38-
/>
3933
</div>

‎i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/observability/intro.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
{
3+
"title": "基于 Doris 的可观测性",
4+
"language": "zh-CN",
5+
"description": "基于 Apache Doris 构建开放、高性能、低成本的 Log/Trace/Metrics 统一可观测性平台。可选择开箱即用的 DOG Stack 或自建方案。"
6+
}
7+
---
8+
9+
import GettingStartedCard from '@site/src/components/getting-started-card/getting-started-card';
10+
11+
# 基于 Doris 的可观测性
12+
13+
Apache Doris 可支撑开放、高性能、低成本的 Log/Trace/Metrics 统一可观测性分析。请根据团队需求选择合适的方案。
14+
15+
<div className="cards-grid">
16+
<GettingStartedCard
17+
title="DOG Stack"
18+
description="基于 Doris、OpenTelemetry 和 Grafana 构建的开箱即用可观测性方案，内置类 Kibana 的搜索与类 Jaeger 的链路追踪体验。"
19+
link="dogstack/overview"
20+
/>
21+
22+
<GettingStartedCard
23+
title="Custom Build"
24+
description="直接基于 Doris 使用 SQL 自建可观测性平台，自主设计表结构、采集链路与可视化看板，灵活度最高。"
25+
link="overview"
26+
/>
27+
</div>

‎sidebars.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ const sidebars: SidebarsConfig = {
764764
{
765765
type: 'category',
766766
label: 'Observability with Doris',
767-
link: {type: 'doc', id: 'observability/dogstack/overview'},
767+
link: {type: 'doc', id: 'observability/intro'},
768768
collapsed: true,
769769
items: [
770770
{
@@ -773,7 +773,6 @@ const sidebars: SidebarsConfig = {
773773
collapsed: true,
774774
link: {type: 'doc', id: 'observability/dogstack/overview'},
775775
items: [
776-
'observability/dogstack/overview',
777776
'observability/dogstack/quickstart',
778777
'observability/dogstack/deployment',
779778
'observability/dogstack/search',
@@ -784,11 +783,10 @@ const sidebars: SidebarsConfig = {
784783
},
785784
{
786785
type: 'category',
787-
label: 'Legacy',
786+
label: 'Custom Build',
788787
collapsed: true,
789788
link: {type: 'doc', id: 'observability/overview'},
790789
items: [
791-
'observability/overview',
792790
'observability/log',
793791
'observability/trace',
794792
]

‎versioned_docs/version-4.x/install/deploy-on-kubernetes/intro.mdx‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ On Kubernetes, Apache Doris is managed by Doris Operator. Choose the guide that
1414

1515
<div className="cards-grid">
1616
<GettingStartedCard
17-
title="Doris Operator"
17+
title="Pre-deployment Preparation"
1818
description="Learn what Doris Operator can do and how to install it on Kubernetes services from different cloud providers"
19-
link="../doris-operator/intro"
19+
link="doris-operator/intro"
2020
/>
2121

2222
<GettingStartedCard
@@ -30,10 +30,4 @@ On Kubernetes, Apache Doris is managed by Doris Operator. Choose the guide that
3030
description="Deploy a Doris cluster on Kubernetes in storage-compute separation mode"
3131
link="separating-storage-compute/install-doris-cluster"
3232
/>
33-
34-
<GettingStartedCard
35-
title="Deploy Prometheus and Grafana"
36-
description="Deploy Prometheus and Grafana on Kubernetes with Helm to collect and visualize metrics for a Doris compute-storage decoupled cluster"
37-
link="separating-storage-compute/install-prometheus-and-grafana"
38-
/>
3933
</div>

‎versioned_docs/version-4.x/observability/intro.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
{
3+
"title": "Observability with Doris",
4+
"language": "en",
5+
"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."
6+
}
7+
---
8+
9+
import GettingStartedCard from '@site/src/components/getting-started-card/getting-started-card';
10+
11+
# Observability with Doris
12+
13+
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.
14+
15+
<div className="cards-grid">
16+
<GettingStartedCard
17+
title="DOG Stack"
18+
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."
19+
link="dogstack/overview"
20+
/>
21+
22+
<GettingStartedCard
23+
title="Custom Build"
24+
description="Build your own platform directly on Doris with SQL, designing the schema, ingestion pipelines, and dashboards yourself for full flexibility."
25+
link="overview"
26+
/>
27+
</div>

‎versioned_sidebars/version-4.x-sidebars.json‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -893,7 +893,7 @@
893893
"label": "Observability with Doris",
894894
"link": {
895895
"type": "doc",
896-
"id": "observability/dogstack/overview"
896+
"id": "observability/intro"
897897
},
898898
"collapsed": true,
899899
"items": [
@@ -906,7 +906,6 @@
906906
"id": "observability/dogstack/overview"
907907
},
908908
"items": [
909-
"observability/dogstack/overview",
910909
"observability/dogstack/quickstart",
911910
"observability/dogstack/deployment",
912911
"observability/dogstack/search",
@@ -917,14 +916,13 @@
917916
},
918917
{
919918
"type": "category",
920-
"label": "Legacy",
919+
"label": "Custom Build",
921920
"collapsed": true,
922921
"link": {
923922
"type": "doc",
924923
"id": "observability/overview"
925924
},
926925
"items": [
927-
"observability/overview",
928926
"observability/log",
929927
"observability/trace"
930928
]

0 commit comments

Comments
 (0)