Skip to content

Commit f2980b9

Browse files
authored
[zh] Sync demo/_index, development, and forking (#7207)
Signed-off-by: windsonsea <[email protected]>
1 parent 4caa447 commit f2980b9

File tree

3 files changed

+111
-20
lines changed

3 files changed

+111
-20
lines changed

content/zh/docs/demo/_index.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ cascade:
66
weight: 180
77
default_lang_commit: c2cd5b14 # patched
88
drifted_from_default: true
9-
cSpell:ignore: OLJCESPC
109
---
1110

1211
欢迎使用 [OpenTelemetry 演示](/ecosystem/demo/)文档,
1312
此文档介绍了如何安装和运行演示,以及一些可用来查看 OpenTelemetry 实际运行情况的场景。
1413

15-
## 运行演示
14+
## 运行演示 {#running-the-demo}
1615

1716
想要部署演示并查看其实际效果吗?从这里开始:
1817

1918
- [Docker](docker-deployment/)
2019
- [Kubernetes](kubernetes-deployment/)
2120

22-
## 语言特性参考
21+
## 语言特性参考 {#language-feature-reference}
2322

2423
想要了解特定编程语言的工具是如何工作的?从这里开始:
2524

@@ -36,44 +35,41 @@ cSpell:ignore: OLJCESPC
3635
| Ruby | | [电子邮件服务](services/email/) | [电子邮件服务](services/email/) |
3736
| Rust | | [发货服务](services/shipping/) | [发货服务](services/shipping/) |
3837

39-
## 服务文档
38+
## 服务文档 {#service-documentation}
4039

4140
有关如何在每个服务中部署 OpenTelemetry 的具体信息可以在此处找到:
4241

42+
- [记账服务](services/accounting/)
4343
- [广告服务](services/ad/)
4444
- [购物车服务](services/cart/)
45-
- [结账服务](services/checkout/)
46-
- [电子邮箱服务](services/email/)
47-
- [前端](services/frontend/)
45+
- [结算服务](services/checkout/)
46+
- [电子邮件服务](services/email/)
47+
- [前端服务](services/frontend/)
4848
- [负载生成器](services/load-generator/)
4949
- [支付服务](services/payment/)
5050
- [产品目录服务](services/product-catalog/)
5151
- [报价服务](services/quote/)
5252
- [推荐服务](services/recommendation/)
53-
- [发货服务](services/shipping/)
54-
- [图片提供商服务](services/image-provider/?i18n-patch)
53+
- [物流服务](services/shipping/)
54+
- [图像提供服务](services/image-provider/)
55+
- [React 原生应用](services/react-native-app/)
5556

56-
## 应用场景
57+
## 应用场景 {#feature-flag-scenarios}
5758

5859
如何使用 OpenTelemetry 解决问题?这些场景将引导你解决一些预先配置的问题,
5960
并向你展示如何解释 OpenTelemetry 数据来解决这些问题。
6061

61-
随着时间的推移,我们将添加更多场景:
62+
## 参考资料 {#reference}
6263

63-
- 使用功能标志服务为产品 ID 为 `OLJCESPC7Z``GetProduct` 请求生成[产品目录错误](feature-flags)
64-
- 发现内存泄漏并使用指标和追踪对其进行诊断,[阅读更多](feature-flags/recommendation-cache/)
65-
66-
## 参考
67-
68-
项目参考文档,例如需求和功能矩阵:
64+
项目的参考文档,包括需求和功能矩阵等内容:
6965

7066
- [架构](architecture/)
7167
- [开发](development/)
72-
- [功能标志参考](feature-flags/)
68+
- [特性开关参考](feature-flags/)
7369
- [指标功能矩阵](telemetry-features/metric-coverage/)
74-
- [要求](./requirements/)
70+
- [需求说明](./requirements/)
7571
- [截图](screenshots/)
7672
- [服务](services/)
7773
- [Span 属性参考](telemetry-features/manual-span-attributes/)
7874
- [测试](tests/)
79-
- [Trace 功能矩阵](telemetry-features/trace-coverage/)
75+
- [链路追踪功能矩阵](telemetry-features/trace-coverage/)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: 开发
3+
default_lang_commit: 82eee93552827dde1e716a5e711935e876803914
4+
cSpell:ignore: grpcio intellij libcurl libprotobuf nlohmann openssl protoc
5+
---
6+
7+
[OpenTelemetry Demo GitHub 仓库](https://github.com/open-telemetry/opentelemetry-demo)
8+
9+
开发本演示项目需要使用多种编程语言的工具链。
10+
尽可能会注明所需的最低版本,但推荐为所有工具更新至最新版本。
11+
OpenTelemetry 演示团队将尽力使本仓库中的服务在可能的情况下始终使用依赖项和工具的最新版本。
12+
13+
## 生成 protobuf 文件 {#generate-protobuf-files}
14+
15+
提供了 `make generate-protobuf` 命令用于为所有服务生成 protobuf 文件。
16+
这个命令可以在本地编译代码(无需 Docker),并在 IntelliJ 或 VS Code 等 IDE 中获得代码提示。
17+
生成文件前,可能需要先在 frontend 源代码目录中运行 `npm install`
18+
19+
## 开发工具要求 {#development-tooling-requirements}
20+
21+
### .NET
22+
23+
- .NET 8.0+
24+
25+
### C++
26+
27+
- build-essential
28+
- cmake
29+
- libcurl4-openssl-dev
30+
- libprotobuf-dev
31+
- nlohmann-json3-dev
32+
- pkg-config
33+
- protobuf-compiler
34+
35+
### Go
36+
37+
- Go 1.19+
38+
- protoc-gen-go
39+
- protoc-gen-go-grpc
40+
41+
### Java
42+
43+
- JDK 17+
44+
- Gradle 7+
45+
46+
### JavaScript
47+
48+
- Node.js 16+
49+
50+
### PHP
51+
52+
- PHP 8.1+
53+
- Composer 2.4+
54+
55+
### Python
56+
57+
- Python 3.10
58+
- grpcio-tools 1.48+
59+
60+
### Ruby
61+
62+
- Ruby 3.1+
63+
64+
### Rust
65+
66+
- Rust 1.61+
67+
- protoc 3.21+
68+
- protobuf-dev

content/zh/docs/demo/forking.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Fork 演示仓库
3+
linkTitle: 派生
4+
default_lang_commit: 82eee93552827dde1e716a5e711935e876803914
5+
---
6+
7+
[演示仓库][demo repository]旨在被 Fork 使用,作为展示你如何使用 OpenTelemetry 的工具。
8+
9+
设置一个 Fork 或演示环境通常只需要覆盖一些环境变量,并可能替换一些容器镜像。
10+
11+
你可以将在线演示添加到该演示项目的
12+
[README](https://github.com/open-telemetry/opentelemetry-demo/blob/main/README.md?plain=1)
13+
中。
14+
15+
## 给 Fork 维护者的建议 {#suggestions-for-fork-maintainers}
16+
17+
- 如果你希望增强演示项目所生成或收集的遥测数据,我们强烈建议你将相关更改反向合并到此主仓库中。
18+
对于厂商或实现特定的更改,建议采用通过配置文件在数据处理管道中修改遥测的方式,而不是更改底层代码。
19+
- 拓展而非替换。新增与现有 API 交互的新服务,是添加特定厂商或工具功能的良好方式,
20+
尤其是在无法通过修改遥测实现目标的情况下。
21+
- 为了支持可拓展性,请使用仓库(Repository)或门面(Facade)模式来封装诸如队列、数据库、缓存等资源。
22+
这样可以便于为不同平台替换或接入不同的实现。
23+
- 请不要尝试将特定厂商或工具的增强功能反向合并到主仓库中。
24+
25+
如果你有任何问题,或者希望提出建议帮助我们更好地支持 Fork 维护者的工作,请提交一个 Issue。
26+
27+
[demo repository]: <{{% param repo %}}>

0 commit comments

Comments
 (0)