diff --git a/docs/cn/SUMMARY.md b/docs/cn/SUMMARY.md index 83d3747e18..18a97f6457 100644 --- a/docs/cn/SUMMARY.md +++ b/docs/cn/SUMMARY.md @@ -107,6 +107,7 @@ * [贡献指南](contributing/CONTRIBUTING.md) * [开发者](contributing/developer.md) +* [成就](contributing/achievement.md) ## 性能测试 diff --git a/docs/cn/contributing/CONTRIBUTING.md b/docs/cn/contributing/CONTRIBUTING.md index c460400a03..d9689033ee 100644 --- a/docs/cn/contributing/CONTRIBUTING.md +++ b/docs/cn/contributing/CONTRIBUTING.md @@ -64,8 +64,9 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的 * 适合新手开发,对应 label: good first issue。 * 修复 bug,对应 label: bug。 * 测试框架或测试用例补充,对应 label: test。 +* [配置样例或K8s部署案例补充](#config),对应 label: example config。 * 文档补充、完善(document),对应 label: documentation。 -* 案例类,对应 label: awesome ilogtail。 +* [案例类](#case),对应 label: awesome ilogtail。 * 回答、解决问题,对应 label: question。我们建议优先提到 [Discussions](https://github.com/alibaba/ilogtail/discussions) 中讨论。 以下为附加标签: @@ -81,7 +82,15 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的 * 优雅性:代码简练、复用度高,有着完善的设计。 * 测试:重要的代码需要有完善的测试用例(单元测试、E2E 测试),对应的衡量标准是测试覆盖率。 -### 案例分享 +### 配置分享 + +除了共享代码,您也可以为我们的配置样板库做出贡献。 + +`example_config/data_pipelines`目录包含场景化的采集配置模版,重点突出processor / aggregator插件功能。如您对某些常见日志(如Apache、Spring Boot)的处理有一定心得,可以参考已有样例和[README](https://github.com/alibaba/ilogtail/tree/main/example_config#readme)进行提交。 + +`k8s_templates`目录包含完整的K8s部署案例,从源到典型处理到输出,以input / flusher插件进行划分。如您对某些常见的日志处理场景(如将数据采集到Elastic Search、Clickhouse)的部署有一定心得,可以参考已有样例和[README](https://github.com/alibaba/ilogtail/tree/main/k8s_templates#readme)进行提交。 + +### 案例分享 我们也欢迎您分享任何关于 iLogtail 的使用案例。我们在知乎建立了专栏 [iLogtail社区](https://www.zhihu.com/column/c_1533139823409270785),欢迎大家投稿,分享 iLogtail 的使用案例。 diff --git a/docs/cn/contributing/achievement.md b/docs/cn/contributing/achievement.md new file mode 100644 index 0000000000..df00133367 --- /dev/null +++ b/docs/cn/contributing/achievement.md @@ -0,0 +1 @@ +# 成就 diff --git a/docs/cn/contributing/developer.md b/docs/cn/contributing/developer.md index 788e576b07..2b31d3114d 100644 --- a/docs/cn/contributing/developer.md +++ b/docs/cn/contributing/developer.md @@ -63,14 +63,4 @@ iLogtail 社区包含 Maintainer、Committer、Contributor、User 等角色, ### Contributor -* Weilong Pan([@panawala](https://github.com/panawala)) -* Haoxiang Zhang([@henryzhx8](https://github.com/henryzhx8)) -* Haorui([@haoruilee](https://github.com/haoruilee)) -* Chao Lee([@chaolee50](https://github.com/chaolee50)) -* Zehua Yang([@Takuka0311](https://github.com/Takuka0311)) -* Jinchen([@pj1987111](https://github.com/pj1987111)) -* timchenxiaoyu([@timchenxiaoyu](https://github.com/timchenxiaoyu)) -* Doslin([@Doslin](https://github.com/Doslin)) -* Howie([@Howie59](https://github.com/Howie59)) -* Xiaolei Wang([@fatelei](https://github.com/fatelei)) -* Lework([@lework](https://github.com/lework)) + diff --git a/example_config/README.md b/example_config/README.md index ec90200afa..82ae154e7e 100644 --- a/example_config/README.md +++ b/example_config/README.md @@ -15,3 +15,5 @@ The `data_pipelines` directory contains more advanced examples for different use 模版内注释需要说明清楚适用场景和应用前需要替换的部分。 原则上模版应尽量全面精简正交,便于用户理解后查找,自由组合。模版中若不需要突出input或flusher的使用,直接使用file_log / flusher_stdout即可,避免意义不大的重复建设。 + +提交模版时,Issue / PR 请打上标签`example config`。 diff --git a/example_config/start_with_k8s/ilogtail-secret.yaml b/example_config/start_with_k8s/ilogtail-secret.yaml index 5b731c067a..1f38d8f64b 100644 --- a/example_config/start_with_k8s/ilogtail-secret.yaml +++ b/example_config/start_with_k8s/ilogtail-secret.yaml @@ -19,5 +19,5 @@ metadata: namespace: ilogtail type: Opaque data: - access_key: # accesskey id if you want to flush to SLS - access_key_id: # accesskey secret if you want to flush to SLS + access_key_id: # accesskey id if you want to flush to SLS + access_key: # accesskey secret if you want to flush to SLS \ No newline at end of file diff --git a/k8s_templates/README.md b/k8s_templates/README.md index 1fd9089e9e..6a26be597c 100644 --- a/k8s_templates/README.md +++ b/k8s_templates/README.md @@ -13,3 +13,5 @@ Please feel free to add one if it doesn't cover your case. 模版内注释需要说明清楚适用场景和应用前需要替换的部分。 原则上模版应经量全面精简正交,便于用户理解后查找,自由组合。source为主的模版除 `file_log` 和 `service_docker_stdout` 插件具备kafka和sls 2个flusher外,其余都统一使用 `flusher_sls` 作为flusher。flusher为主的模版除 `flusher_kafka` 和 `flusher_sls` 外,应只选用1个配合最佳的插件作为input(容器场景通常是 `service_docker_stdout` ),避免意义不大的重复建设。 + +提交模版时,Issue / PR 请打上标签`example config`。