This is an automated email from the ASF dual-hosted git repository.
wangtao29 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozhera.git
The following commit(s) were added to refs/heads/master by this push:
new db3dd41e refactor: add contribution file and copyright info (#498)
db3dd41e is described below
commit db3dd41e6ba8382ec3616e47e8626ccac87298be
Author: psxjoy <[email protected]>
AuthorDate: Tue Nov 12 16:17:06 2024 +0800
refactor: add contribution file and copyright info (#498)
* refactor: add contribution file and copyright info
* refactor: add contribution file and copyright info
* refactor: redirect readme.md contributing's info
* refactor: redirect readme.md contributing's info
* refactor: redirect readme.md contributing's info
* refactor: add contribution file and copyright info
* refactor: add OIP.md which report major proposal on the Apache
OzHera(Incubating) project
* refactor: rename project to satisfy ASF copyright
* refactor: rename project to satisfy ASF copyright
* refactor: remove useless file
---
.github/ISSUE_TEMPLATE/BUG_REPORT.md | 43 ++++++
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 17 +++
.github/ISSUE_TEMPLATE/OIP.md | 47 +++++++
.github/PULL_REQUEST_TEMPLATE.md | 17 +++
CONTRIBUTING.md | 102 +++++++++++++++
CONTRIBUTING_CN.md | 102 +++++++++++++++
README.md | 4 +-
README_CN.md | 6 +-
ozhera-app/README.md | 2 +-
ozhera-app/README_cn.md | 2 +-
ozhera-demo-client/README.md | 2 +-
ozhera-demo-client/README_cn.md | 2 +-
ozhera-demo-server/README.md | 3 +-
ozhera-demo-server/README_cn.md | 3 +-
ozhera-intelligence/README.md | 2 +-
ozhera-intelligence/README_cn.md | 2 +-
ozhera-monitor/README.md | 2 +-
ozhera-monitor/README_cn.md | 2 +-
ozhera-operator/README.md | 2 +-
ozhera-operator/README_CN.md | 2 +-
.../application-integration-document.md | 4 +-
.../application-integration-document_cn.md | 4 +-
readme/contributing/contributing.md | 97 --------------
readme/contributing/contributing_cn.md | 110 ----------------
readme/contributing/images/1-1.PNG | Bin 90840 -> 0 bytes
readme/contributing/images/1-2-1.PNG | Bin 49602 -> 0 bytes
readme/contributing/images/1-2.PNG | Bin 80762 -> 0 bytes
readme/contributing/images/1-3.PNG | Bin 77019 -> 0 bytes
readme/contributing/images/1-4.PNG | Bin 64474 -> 0 bytes
readme/contributing/images/1-5.PNG | Bin 51911 -> 0 bytes
readme/contributing/images/1-6.PNG | Bin 16065 -> 0 bytes
readme/contributing/images/2-1.PNG | Bin 107592 -> 0 bytes
readme/contributing/images/2-2.PNG | Bin 94424 -> 0 bytes
readme/contributing/images/2-3.PNG | Bin 97205 -> 0 bytes
readme/contributing/images/2-4.PNG | Bin 42137 -> 0 bytes
readme/contributing/images/2-5-1.PNG | Bin 107013 -> 0 bytes
readme/contributing/images/2-5.PNG | Bin 75305 -> 0 bytes
readme/contributing/images/2-6.PNG | Bin 101318 -> 0 bytes
readme/contributing/images/2-7-1.PNG | Bin 161687 -> 0 bytes
readme/contributing/images/2-7.PNG | Bin 145088 -> 0 bytes
readme/contributing/images/3-1-1.PNG | Bin 592480 -> 0 bytes
readme/contributing/images/3-1-2.PNG | Bin 96289 -> 0 bytes
readme/contributing/images/3-2-1.PNG | Bin 243137 -> 0 bytes
readme/contributing/images/3-2-2.PNG | Bin 268864 -> 0 bytes
readme/contributing/images/3-2-3.PNG | Bin 154744 -> 0 bytes
readme/custom-tracking/custom-tracking.md | 4 +-
readme/custom-tracking/custom-tracking_cn.md | 4 +-
readme/deploy/ozhera-deploy-document.md | 6 +-
readme/deploy/ozhera-deploy-document_cn.md | 8 +-
readme/optimization/metrics-optimization.md | 2 +-
readme/optimization/metrics-optimization_cn.md | 2 +-
readme/user-manual/user-manual-document.md | 2 +-
readme/user-manual/user-manual-document_cn.md | 2 +-
style/copyright | 14 ++
style/ozhera_checkStyle.xml | 133 +++++++++++++++++++
style/ozhera_codeStyle.xml | 144 +++++++++++++++++++++
56 files changed, 657 insertions(+), 243 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md
b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
new file mode 100644
index 00000000..799a48c3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
@@ -0,0 +1,43 @@
+---`
+
+name: Bug Report
+
+about: If you would like to report an issue to Apache OzHera(Incubating),
please use this template.
+`
+---
+
+### Ⅰ. Issue Description
+
+
+### Ⅱ. Describe what happened
+
+If there is an exception, please attach the exception trace:
+
+```
+Just paste your stack trace here
+```
+
+
+### Ⅲ. Describe what you expected to happen
+
+
+### Ⅳ. How to reproduce it (as minimally and precisely as possible)
+
+1. xxx
+2. xxx
+3. xxx
+
+Minimal yet complete reproducer code (or URL to code):
+
+
+
+### Ⅴ. Anything else we need to know?
+
+
+### Ⅵ. Environment:
+
+- JDK version (e.g. `java -version`):
+- Apache OzHera(Incubating) version:
+- Kubernetes version:
+- OS (e.g. `uname -a`):
+- Others:
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
new file mode 100644
index 00000000..116748e9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
@@ -0,0 +1,17 @@
+---
+name: Feature Request
+
+about: Suggest an idea for Apache OzHera(Incubating)
+
+---
+
+## Why you need it?
+ Is your feature request related to a problem? Please describe in details
+
+
+## How it could be?
+A clear and concise description of what you want to happen. You can explain
more about input of the feature, and output of it.
+
+
+## Other related information
+Add any other context or screenshots about the feature request here.
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/OIP.md b/.github/ISSUE_TEMPLATE/OIP.md
new file mode 100644
index 00000000..10dbb40e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/OIP.md
@@ -0,0 +1,47 @@
+---
+
+name: Major Project Proposal
+
+about: Use this template to report major proposal on the Apache
OzHera(Incubating) project.
+
+---
+
+### Ⅰ. Proposal Summary
+
+Provide a brief overview of the significant proposal or change in the project.
+
+### Ⅱ. Details of the Proposal
+
+Explain the proposal in detail. Include any relevant context or background
information:
+
+- What changed?
+- Why was this update necessary?
+
+### Ⅲ. Expected Impact
+
+Describe the expected impact of this proposal, including but not limited to:
+
+- Performance improvements
+- API changes or additions
+- New features or functionalities
+- Changes to project dependencies
+
+### Ⅳ. Implementation Details
+
+Provide specific details on how the update was implemented:
+
+1. Key steps or phases
+2. Codebase changes (include links if possible)
+3. Testing procedures or verification methods
+
+### Ⅴ. Next Steps or Follow-Up Actions
+
+List any further actions or next steps following this update, such as:
+
+- Future improvements or adjustments
+- Additional testing or validation needs
+- Related updates or dependencies to track
+
+### Ⅵ. Related Documentation
+
+Attach any related documentation, guides, or links to further information for
the community.
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..d773ccbc
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+<!-- Please make sure you have read and understood the contributing guidelines
-->
+
+### Ⅰ. Describe what this PR did
+
+
+### Ⅱ. Does this pull request fix one issue?
+<!-- If that, add "fixes #xxx" below in the next line, for example, fixes #97.
-->
+
+
+### Ⅲ. Why don't you add test cases (unit test/integration test)?
+
+
+### Ⅳ. Describe how to verify it
+
+
+### Ⅴ. Special notes for reviews
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..26eb8ac1
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,102 @@
+# Contributing to the Apache OzHera(incubating) Project
+
+If you’re interested in identifying vulnerabilities or improving the Apache
OzHera(incubating) project, we warmly welcome your involvement. Below is a
guide to help you get started with contributing.
+
+[[Chinese Contributing Document](./CONTRIBUTING_CN.md)]
+
+## Topics
+
+* [Reporting Security Issues](#reporting-security-issues)
+* [Reporting General Issues](#reporting-general-issues)
+* [Code and Documentation Contributions](#code-and-documentation-contributions)
+* [Test Case Contributions](#test-case-contributions)
+* [Participating in Any Way](#participating-in-any-way)
+* [Code Style](#code-style)
+
+## Reporting Security Issues
+
+Security issues are handled with top priority. Please avoid public discussions
of security vulnerabilities. If you discover a security issue in Apache
OzHera(incubating), report it confidentially via email to
[[email protected]](mailto:[email protected]).
+
+## Reporting General Issues
+
+User feedback is crucial to Apache OzHera(incubating)'s growth. After using
Apache OzHera(incubating), feel free to share your suggestions or issues by
creating a [New Issue](https://github.com/apache/ozhera/issues/new/choose). To
improve communication efficiency, we encourage you to search for similar issues
before opening a new one. Add your details to an existing issue when relevant
rather than creating a duplicate.
+
+Consider opening a new issue for:
+
+* Bug Reports
+* Feature Requests
+* Performance Issues
+* Functional Enhancements or Design Suggestions
+* Testing Improvements
+* Incomplete Documentation
+* Other project-related inquiries
+
+When reporting issues, please ensure to remove sensitive information such as
passwords, keys, or private business data.
+
+## Code and Documentation Contributions
+
+We welcome all contributions that improve the Apache OzHera(incubating)
project. On GitHub, all enhancements can be implemented through Pull Requests
(PRs):
+
+* If you spot typos or mistakes, please correct them!
+* If you identify areas for improvement, submit an enhancement!
+* If documentation is inaccurate or incomplete, update it!
+
+> We look forward to your PR.
+
+Please review Apache OzHera(incubating)'s guidelines on submitting PRs:
+
+* [Workspace Preparation](#workspace-preparation)
+* [Branch Definitions](#branch-definitions)
+* [Commit Guidelines](#commit-guidelines)
+* [PR Descriptions](#pr-descriptions)
+
+### Workspace Preparation
+
+Please fork the project and clone it to your local machine for development.
Once you set up the remote repository, you can easily sync your code with
upstream branches.
+
+### Branch Definitions
+
+The Apache OzHera(incubating) project uses the following branch types:
+
+* **Development Branch**: For developing all new features and improvements
+* **Release Branch**: Created when a version is officially released
+* **Hotfix Branch**: Used to address urgent issues in the release version
+
+### Commit Guidelines
+
+We emphasize high-quality commits, which includes:
+
+* Commit Messages: Use clear and specific commit messages, such as `docs:
Update installation guide`
+* Commit Content: Ensure each commit is complete and reviewable, and that it
is linked to your GitHub ID
+
+### PR Descriptions
+
+PRs are the main way to make changes to Apache OzHera(incubating). We
recommend using the [PR template](./.github/PULL_REQUEST_TEMPLATE.md) to
describe your changes.
+
+## Test Case Contributions
+
+The Apache OzHera(incubating) project prioritizes functional test case
contributions. We recommend using JUnit for unit tests and Mockito for
integration tests.
+
+## Participating in Any Way
+
+Apache OzHera(incubating) collaborates on GitHub, and we encourage
contributions in various ways:
+
+* Answer others’ questions
+* Help review others’ PR designs and code
+* Discuss project improvement suggestions
+* Write blogs or share experiences about Ozhera
+
+## Code Style
+
+The Apache OzHera(incubating) project adheres to the Alibaba Java Coding
Guidelines.
+
+### Guidelines
+
+[Alibaba Java Coding
Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/)
+
+### Optional IDE Plugin Installation
+
+* **IDEA**: [p3c-idea-plugin
installation](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md)
+* **Eclipse**: [p3c-eclipse-plugin
installation](https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README.md)
+
+In summary, **any help is a contribution**.
\ No newline at end of file
diff --git a/CONTRIBUTING_CN.md b/CONTRIBUTING_CN.md
new file mode 100644
index 00000000..dd5627dc
--- /dev/null
+++ b/CONTRIBUTING_CN.md
@@ -0,0 +1,102 @@
+# 为 Apache OzHera(incubating) 做贡献
+
+如果您有兴趣寻找关于 Apache OzHera(incubating)
的漏洞,或是希望帮助提升项目质量,我们会非常欢迎您的加入。以下是为您提供的贡献指南列表。
+
+[[English Contributing Document](./CONTRIBUTING.md)]
+
+## 目录
+
+* [报告安全问题](#报告安全问题)
+* [报告一般问题](#报告一般问题)
+* [代码和文档贡献](#代码和文档贡献)
+* [测试用例贡献](#测试用例贡献)
+* [参与帮助任何事项](#参与帮助任何事项)
+* [代码风格](#代码风格)
+
+## 报告安全问题
+
+安全问题是我们最关注的事情。我们建议您不要公开讨论或发布任何关于 Apache OzHera(incubating)
的安全漏洞。如果您发现安全问题,请直接发送电子邮件至
[[email protected]](mailto:[email protected]) 以保密的方式报告。
+
+## 报告一般问题
+
+用户的反馈是项目进步的重要来源。在使用 Apache OzHera(incubating) 后,您可以通过 [NEW
ISSUE](https://github.com/apache/ozhera/issues/new/choose)
提交您的问题或建议。为确保沟通效率,我们建议先搜索是否已存在相关问题,然后在已有问题下添加您的详细信息,而不是创建新问题。
+
+当您遇到以下情况,可以新建一个问题:
+
+* 错误报告
+* 功能请求
+* 性能问题
+* 功能设计或改进建议
+* 测试改进
+* 文档不完整
+* 其他项目相关的问题
+
+请注意,提交问题时请删除任何敏感数据,例如密码、密钥、网络地址等。
+
+## 代码和文档贡献
+
+我们欢迎一切可以让 Apache OzHera(incubating) 项目更好的贡献。在 GitHub 上,所有的改进都可以通过 PR(Pull
Request)实现:
+
+* 如果您发现错别字或错误,请修复它!
+* 如果发现功能可以优化,请提交改进!
+* 如果文档不准确或不完整,欢迎您进行更新!
+
+> 我们期待您的任何PR。
+
+请注意 Apache OzHera(incubating) 项目对 PR 的要求,并在以下指南下提交:
+
+* [工作区准备](#工作区准备)
+* [分支定义](#分支定义)
+* [提交规则](#提交规则)
+* [PR说明](#PR说明)
+
+### 工作区准备
+
+请首先 Fork 项目,然后克隆到本地计算机进行开发。设置远程仓库后,您可以轻松地与上游分支同步代码。
+
+### 分支定义
+
+Apache OzHera(incubating) 项目使用以下几种分支类型:
+
+* **开发分支**:用于所有新功能和改进的开发
+* **发布分支**:发布版本时创建
+* **热修复分支**:用于修复发布版本中的紧急问题
+
+### 提交规则
+
+我们非常重视提交的质量,包括:
+
+* 提交消息:请确保使用明确的提交信息,例如 `docs: update installation guide`
+* 提交内容:提交应包含完整且可审查的内容,并与 GitHub ID 相关联
+
+### PR说明
+
+PR 是更改 Apache OzHera(incubating) 项目文件的主要方式。我们建议使用 [PR
模板](./.github/PULL_REQUEST_TEMPLATE.md) 来描述更改内容。
+
+## 测试用例贡献
+
+Apache OzHera(incubating) 项目优先接收功能测试用例贡献。推荐使用 JUnit 进行单元测试,并使用 Mockito 进行集成测试。
+
+## 参与帮助任何事项
+
+Apache OzHera(incubating) 项目通过 GitHub 进行协作,我们鼓励贡献者通过以下方式参与:
+
+* 回答他人的问题
+* 帮助审查他人的 PR 设计和代码
+* 讨论项目改进建议
+* 撰写关于 Apache OzHera(incubating) 的博客或分享使用经验
+
+## 代码风格
+
+Apache OzHera(incubating) 项目遵循阿里巴巴 Java 编码指南。
+
+### 指南
+
+[阿里巴巴 Java 代码指南](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/)
+
+### IDE 插件安装(可选)
+
+* **Idea IDE**:[p3c-idea-plugin
安装](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md)
+* **Eclipse IDE**:[p3c-eclipse-plugin
安装](https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README.md)
+
+总之,**任何帮助都是贡献**。
\ No newline at end of file
diff --git a/README.md b/README.md
index e7d20def..550e7f3b 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ Welcome to visit the [official
website](https://ozhera.apache.org/) of Apache Oz
---
### Contributing
-Contributors are welcomed to join ozhera project. Please check
[contributing.md](readme%2Fcontributing%2Fcontributing.md) about how to
contribute to this project.
+Contributors are welcomed to join ozhera project. Please check
[contributing.md](CONTRIBUTING.md) about how to contribute to this project.
How can I contribute?
- Take a look at issues with tags marked [good first
issue](https://github.com/apache/ozhera/labels/good%20first%20issue) or
[contribution welcome](https://github.com/apache/ozhera/labels/help%20wanted).
@@ -79,7 +79,7 @@ We warmly welcome your valuable opinions and suggestions
about the project. Whet
#### Community Engagement
- We also welcome you to join our community for discussions and exchanges:
- - Welcome to visit the [community website](https://m.one.mi.com/index) of
Apache OzHera(Incubating), where we will publish Apache OzHera(Incubating)'s
technical documentation, thoughts, and achievements. We welcome everyone to
join the discussion.
+ - Welcome to visit the [community website](https://ozhera.apache.org) of
Apache OzHera(Incubating), where we will publish Apache OzHera(Incubating)'s
technical documentation, thoughts, and achievements. We welcome everyone to
join the discussion.
- [GitHub
Discussions](https://github.com/apache/ozhera/issues?q=is%3Aissue+is%3Aopen+%5BDisscusion%5D+)
---
diff --git a/README_CN.md b/README_CN.md
index 09bf1eec..c1ce341e 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -11,7 +11,7 @@
## Apache OzHera(Incubating)是什么?
-Apache
OzHera(Incubating)是由小米-中国区研发效能团队开源的一款云原生时代的应用观测平台(APM)。以应用为核心,集指标监控、链路追踪、日志、报警于一身,并实现了metrics->tracing->logging的串联和联动,Apache
OzHera(Incubating)还提供应用健康状态列表、应用指标看板、接口大盘、应用大盘、网关大盘等内容丰富的监测看板,以及简洁明了的可视化明文报警,让用户准确、高效定位故障。
+Apache
OzHera(Incubating)是一款云原生时代的应用观测平台(APM)。以应用为核心,集指标监控、链路追踪、日志、报警于一身,并实现了metrics->tracing->logging的串联和联动,Apache
OzHera(Incubating)还提供应用健康状态列表、应用指标看板、接口大盘、应用大盘、网关大盘等内容丰富的监测看板,以及简洁明了的可视化明文报警,让用户准确、高效定位故障。
---
@@ -44,7 +44,7 @@ Apache OzHera(Incubating)是由小米-中国区研发效能团队开源的一款
---
### 部署
-[operator使用文档.md](readme%2Fdeploy%2Fozhera-deploy-document_cn.md)
+[operator使用文档.md](readme/deploy/ozhera-deploy-document_cn.md)
---
@@ -59,7 +59,7 @@ Apache OzHera(Incubating)是由小米-中国区研发效能团队开源的一款
---
### 贡献
-欢迎贡献者加入ozhera项目。请查看
[contributing_cn.md](readme%2Fcontributing%2Fcontributing_cn.md) 以了解如何为该项目做出贡献.
+欢迎贡献者加入ozhera项目。请查看 [contributing_cn.md](CONTRIBUTING_CN.md) 以了解如何为该项目做出贡献.
我该如何贡献?
- 请查看带有标签 [good first
issue](https://github.com/apache/ozhera/labels/good%20first%20issue) 或
[contribution
welcome](https://github.com/apache/ozhera/labels/help%20wanted)的问题.
diff --git a/ozhera-app/README.md b/ozhera-app/README.md
index e935eb87..aef29b8c 100644
--- a/ozhera-app/README.md
+++ b/ozhera-app/README.md
@@ -1,3 +1,3 @@
# ozhera-app
-Ozhera-app is a microservice that manages the basic data of monitoring
applications and is the data service center of the entire ozhera monitoring
system.
+ozhera-app is a microservice that manages the basic data of monitoring
applications and is the data service center of the entire Apache
OzHera(incubating) monitoring system.
Provides unified application data for link tracing, logs, and metric
monitoring, and manages global configuration information.
diff --git a/ozhera-app/README_cn.md b/ozhera-app/README_cn.md
index 0c5245d9..8979a96a 100644
--- a/ozhera-app/README_cn.md
+++ b/ozhera-app/README_cn.md
@@ -1,3 +1,3 @@
# ozhera-app
-ozhera-app 是管理监控应用基础数据的微服务,是整个ozhera监控体系的数据服务中心,
+ozhera-app 是管理监控应用基础数据的微服务,是整个Apache OzHera(incubating)监控体系的数据服务中心,
为链路追踪、日志、指标监控提供一致性的统一应用数据,同时管理着全局的配置信息。
diff --git a/ozhera-demo-client/README.md b/ozhera-demo-client/README.md
index a98e37bf..c4859ab3 100644
--- a/ozhera-demo-client/README.md
+++ b/ozhera-demo-client/README.md
@@ -1,2 +1,2 @@
# introduction
-OZHera demo client
\ No newline at end of file
+OzHera demo client
\ No newline at end of file
diff --git a/ozhera-demo-client/README_cn.md b/ozhera-demo-client/README_cn.md
index 1c43f4a5..5fb4b97f 100644
--- a/ozhera-demo-client/README_cn.md
+++ b/ozhera-demo-client/README_cn.md
@@ -1,2 +1,2 @@
# 概述
-OZHera demo client
\ No newline at end of file
+OzHera demo client
\ No newline at end of file
diff --git a/ozhera-demo-server/README.md b/ozhera-demo-server/README.md
index 1f8887d9..eb9cc143 100644
--- a/ozhera-demo-server/README.md
+++ b/ozhera-demo-server/README.md
@@ -1 +1,2 @@
-# introduce
\ No newline at end of file
+# introduce
+ozhera-demo-server
\ No newline at end of file
diff --git a/ozhera-demo-server/README_cn.md b/ozhera-demo-server/README_cn.md
index 6d30898f..0b6c5a9f 100644
--- a/ozhera-demo-server/README_cn.md
+++ b/ozhera-demo-server/README_cn.md
@@ -1 +1,2 @@
-# 概述
\ No newline at end of file
+# 概述
+ozhera-demo-server
\ No newline at end of file
diff --git a/ozhera-intelligence/README.md b/ozhera-intelligence/README.md
index 49fd4818..88fc900a 100644
--- a/ozhera-intelligence/README.md
+++ b/ozhera-intelligence/README.md
@@ -1,5 +1,5 @@
# Overview
-+ OzHera Intelligence Platform is responsible for generating
intelligent-related functionalities.
++ Apache OzHera(incubating) Intelligence Platform is responsible for
generating intelligent-related functionalities.
+ Currently, features are under development.
+ Planned features to be developed:
+ Root cause analysis, including trace, alerts, and topology-based
intelligent analysis at the application level.
diff --git a/ozhera-intelligence/README_cn.md b/ozhera-intelligence/README_cn.md
index fe30dfc4..66c098ed 100644
--- a/ozhera-intelligence/README_cn.md
+++ b/ozhera-intelligence/README_cn.md
@@ -1,5 +1,5 @@
# 概述
-+ ozhera智能化平台,负责产生智能化相关功能。
++ Apache OzHera(incubating)智能化平台,负责产生智能化相关功能。
+ 目前功能开发中
+ 计划将要开发的功能
+ 根因分析。包括Trace、报警、应用层面的基于拓扑图的智能分析。
diff --git a/ozhera-monitor/README.md b/ozhera-monitor/README.md
index cb73867f..aecc3f02 100644
--- a/ozhera-monitor/README.md
+++ b/ozhera-monitor/README.md
@@ -1,5 +1,5 @@
# Overview
-ozhera-monitor is one of the core projects within the ozhera system. It is
responsible for managing various crucial functions related to the monitoring
system, including the application center, metric monitoring, metric alert
configuration, alert group configuration, monitoring dashboard display, and
more.
+ozhera-monitor is one of the core projects within the Apache
OzHera(incubating) system. It is responsible for managing various crucial
functions related to the monitoring system, including the application center,
metric monitoring, metric alert configuration, alert group configuration,
monitoring dashboard display, and more.
# Supported Environments
JDK: Java 8
diff --git a/ozhera-monitor/README_cn.md b/ozhera-monitor/README_cn.md
index 6c9e74de..1f4de302 100644
--- a/ozhera-monitor/README_cn.md
+++ b/ozhera-monitor/README_cn.md
@@ -1,5 +1,5 @@
# 概述
- ozhera-monitor 是ozhera体系主体工程之一,负责管理监控体系的应用中心、指标监控、指标报警配置、
+ ozhera-monitor 是Apache OzHera(incubating)体系主体工程之一,负责管理监控体系的应用中心、指标监控、指标报警配置、
报警组配置、监控面板展示等多维度的重要功能。
## 涉及的环境
diff --git a/ozhera-operator/README.md b/ozhera-operator/README.md
index 596dfb03..f5c3ef83 100644
--- a/ozhera-operator/README.md
+++ b/ozhera-operator/README.md
@@ -1,5 +1,5 @@
# OzHeraOperator Overview
-OzHeraOperator is used to deploy the entire OzHera system with one click.
+OzHeraOperator is used to deploy the entire Apache OzHera(incubating) system
with one click.
# Environment Requirements
+ k8s cluster
diff --git a/ozhera-operator/README_CN.md b/ozhera-operator/README_CN.md
index 9b261f30..003ae096 100644
--- a/ozhera-operator/README_CN.md
+++ b/ozhera-operator/README_CN.md
@@ -1,5 +1,5 @@
# OzHeraOperator概述
-OzHeraOperator用于一键部署整个OzHera系统。
+OzHeraOperator用于一键部署整个Apache OzHera(incubating)系统。
# 环境要求
+ k8s集群
diff --git
a/readme/application-integeration/application-integration-document.md
b/readme/application-integeration/application-integration-document.md
index cd44f7f4..c12e7d24 100644
--- a/readme/application-integeration/application-integration-document.md
+++ b/readme/application-integeration/application-integration-document.md
@@ -1,8 +1,8 @@
-# OzHera Integration Documentation
+# Apache OzHera(Incubating) Integration Documentation
## I. Dependencies for Application Deployment
-Applications integrating with OzHera require probes, JVM parameters,
environment variables, and the log-agent service.
+Applications integrating with Apache OzHera(incubating) require probes, JVM
parameters, environment variables, and the log-agent service.
### 1. Probes
diff --git
a/readme/application-integeration/application-integration-document_cn.md
b/readme/application-integeration/application-integration-document_cn.md
index eb2d9f0c..c42d91e2 100644
--- a/readme/application-integeration/application-integration-document_cn.md
+++ b/readme/application-integeration/application-integration-document_cn.md
@@ -1,8 +1,8 @@
-# OzHera接入文档
+# Apache OzHera(Incubating)接入文档
## 一、应用部署的依赖
-接入OzHera的应用,需要依赖探针、jvm参数、环境变量以及log-agent服务
+接入Apache OzHera(Incubating)的应用,需要依赖探针、jvm参数、环境变量以及log-agent服务
### 1、探针
diff --git a/readme/contributing/contributing.md
b/readme/contributing/contributing.md
deleted file mode 100644
index 515bc219..00000000
--- a/readme/contributing/contributing.md
+++ /dev/null
@@ -1,97 +0,0 @@
-# PR Submission Guidelines
-
-## 1.Create Issues
-
-### (1)Navigate to the main Issues page
-
-
-
-### (2)Click the green 'New issue' button to start creating
-
-
-access the page as shown below
-
-
-### (3)Assign to a Reviewers or Assignees(Optional)
-
-
-
-### (4)Set Labels (Indicate the Type of Requirement)
-
-There are a total of 9 major labels, and you can choose multiple, but in most
cases, select one. If it's a bug, choose 'bug'.
-
-
-### (5)After selecting the labels, proceed to write the Title
-
-The title has a specific format requirement and must follow the format [Label]
Description. For example, if the label is 'bug,' then the title should be:
[bug] Issue with clicking on 'Get Verification Code.' Please note: there should
be a space after [ ].
-
-
-### (6)Write Content
-
-Expand the title to clarify the issue, which can be in text or image format
(you can paste images directly). When multiple requirements are mixed together
and multiple checkboxes are needed, it should be written as '(Optional)'
-
-```Plaintext
-- [ ] (Input Box) boolean
-```
-
-
-
-## 2.Create pr
-
-### (1) Forking a project from an open-source repository to your own remote
repository.
-
-
-
-### (2) Clone the project from your own repository to your local machine.
-
-
-
-### (3) Remember to regularly sync remote code to your local repository.
-
-
-
-
-### (4) Create a new branch locally from the master branch, make code changes,
submit them to the remote repository, and then click on 'pull request' to
create a PR
-
-
-
-### (5) Create a proper PR (Pull Request).
-
-
-In the PR request, you can include '#702' or 'close #702'. This way, when your
PR is merged, the issue will also be automatically marked as closed. #702
represents the issue number, which can be found in the URL after creating the
issue, such as...
-
-
-### (6) Specify Reviewers and Assignees, it must be specified.
-
-
-
-```Apache
-On GitHub, "reviewer" and "assignee" are two different roles that have
different roles in Pull Request (PR) and Issue management: Reviewer: A
reviewer is a person who is asked to review and evaluate a Pull Request. A
reviewer is usually responsible for viewing code changes to a PR, making
recommendations, checking the quality and maintainability of the code, and
ultimately approving or rejecting the merger of a PR. PR authors or other
collaborators can choose to assign one or more rev [...]
-
-```
-
-### (7) Find the corresponding individuals above to Approve your changes, and
then ask the Reviewer to merge your changes
-
-
-
-
-## 3.close Issues
-
-### (1) Automatically close the Issue.
-
-When your PR is merged, if the PR's content includes 'close #issueId', the
corresponding issue will also be marked as closed
-
-
-
-### (2) Manually merge the PR and close the Issue.
-
-
-
-```SQL
-"Squash and merge" is a useful merge option, especially for projects that want
to maintain a clean commit history. It allows you to combine multiple small
commits into a more organized single commit, reducing noise and clutter in the
branch history. However, please note that the merged commit history will no
longer include every individual commit from the original pull request branch,
so some detailed information may be lost.
-```
-
-When merging PRs, it's important to select the "Squash and merge" option. This
way, the PR ID will be appended to the commit message on the homepage, allowing
you to directly navigate to the PR page using the message. This helps to
effectively link what issue the commit addresses and how it was resolved.
-
-
-
\ No newline at end of file
diff --git a/readme/contributing/contributing_cn.md
b/readme/contributing/contributing_cn.md
deleted file mode 100644
index a7789f1e..00000000
--- a/readme/contributing/contributing_cn.md
+++ /dev/null
@@ -1,110 +0,0 @@
-# 提交pr规范
-
-## 1.创建 Issues
-
-### (1)进入 Issues 的主页面
-
-
-
-### (2)点击 New issue 绿色按钮,就可以去创建
-
-
-进入到如下边的页面
-
-
-### (3)给予受托人(就是把这个需求给某个人来解决)(选填)
-
-
-
-### (4)设置标签(标明是什么类型的需求)
-
-一共有9大标签,可以有多个选择,但是一般情况,选一个。如果是bug的选择bug
-
-
-### (5)选完标签,去写Title(标题)
-
-标题是有格式要求,必须采取 `[标签] 文字描述` 的格式 比如我标签是bug,则我的标题是:[bug] 点击获取验证码的时候有问题 注意:[ ]
后面要有空格
-
-
-### (6)编写内容
-
-将标题进行拓展,把问题说清楚
-
-可以是文字,可以是图片(图片复制进来就可以)
-
-还可以是多个需求混在一起的时候,需要多个多选框,则需要这么写:(可选)
-
-```Plaintext
-- [ ] (输入框) boolean
-```
-
-
-
-## 2.创建pr
-
-### (1) 从开源项目fork项目到自己的远程仓库
-
-
-
-### (2) 在自己的仓库中clone项目到本地.
-
-
-
-### (3) 本地基于master分支创建一个新的分支修改代码提交到远程仓库,然后点击pull request去创建pr
-
-
-
-
-### (4)创建正确的pr
-
-
-
-### (5) .创建正确的pr
-
-
-在pr请求的时候的内容里面填写 #702,也可以填 close #702,这样当你的pr被合并后,issue也会被标记为closed状态
-
-\#702即为每个issue的编号,当你创建完issue后可以在url中看到,如
-
-### (6) 指定Reviewers和Assigner,必须得指定一个.
-
-
-
-```Apache
-在 GitHub 上,"reviewer"(审阅人)和 "assignee"(指派人)是两个不同的角色,它们在 Pull Request(PR)和
Issue 管理中具有不同的作用:
-Reviewer(审阅人):
- 审阅人是指被要求审查和评估 Pull Request 的人员。审阅人通常负责查看 PR
的代码更改、提出建议、检查代码的质量和可维护性,并最终批准或拒绝 PR 的合并。
-PR 的作者或其他协作者可以选择将一个或多个审阅人分配给 PR,以便他们进行审查。
-审阅人的作用是确保代码的质量、一致性和可维护性,并帮助团队确保代码符合项目的标准和要求。
-Assignee(指派人):
- 指派人是指被指定为 Issue 或 PR 的负责人员,他们负责跟踪和解决问题或合并 PR。
-通常情况下,指派人可以是 Issue 或 PR 的创建者,也可以是项目团队的成员,或者根据需要指定的其他人员。
-指派人的作用是确保问题或 PR 得到适当的关注和处理。他们可能需要协调和跟进工作,确保问题在合适的时间内得到解决或 PR 得到合并。
-总结来说,审阅人主要与代码审查和合并相关,而指派人主要与任务和问题的分配和跟踪相关。在实际协作中,这两个角色通常会共同合作,以确保项目的代码和问题得到适当的处理和解决。
-```
-
-### (7) 找到上边对应的人给你Approve,之后让Reviewer给你合并
-
-
-
-
-## 3.关闭Issues
-
-### (1) 自动关闭Issue
-
-当你的pr被合并后,如果pr的内容中有close #issueId ,对应的issue也会被标记为closed状态
-
-
-
-### (2) 手动合并pr,并关闭Issue.
-
-
-
-```SQL
-"Squash and merge"
是一个有用的合并选项,特别适用于那些希望保持干净的提交历史的项目。它可以将多个小的提交合并成一个更有组织的提交,以减少分支历史中的噪音和混乱。但要注意,合并后的提交历史将不再包含原始的拉取请求分支上的每个提交,因此某些详细信息可能会丢失。
-```
-
- 大家合并pr的时候选择一定要选择 Squash and merge 这个按钮,这样会在首页的commit message后追加
pr Id,可以根据message直接跳转到 pr界面,对于提交的这次commit解决了什么问题以及怎么解决的很好的关联起来了,如
-
-
-
\ No newline at end of file
diff --git a/readme/contributing/images/1-1.PNG
b/readme/contributing/images/1-1.PNG
deleted file mode 100644
index c46adde3..00000000
Binary files a/readme/contributing/images/1-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/1-2-1.PNG
b/readme/contributing/images/1-2-1.PNG
deleted file mode 100644
index b279d1b9..00000000
Binary files a/readme/contributing/images/1-2-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/1-2.PNG
b/readme/contributing/images/1-2.PNG
deleted file mode 100644
index e0fe3bed..00000000
Binary files a/readme/contributing/images/1-2.PNG and /dev/null differ
diff --git a/readme/contributing/images/1-3.PNG
b/readme/contributing/images/1-3.PNG
deleted file mode 100644
index bd30b6e8..00000000
Binary files a/readme/contributing/images/1-3.PNG and /dev/null differ
diff --git a/readme/contributing/images/1-4.PNG
b/readme/contributing/images/1-4.PNG
deleted file mode 100644
index 96f57717..00000000
Binary files a/readme/contributing/images/1-4.PNG and /dev/null differ
diff --git a/readme/contributing/images/1-5.PNG
b/readme/contributing/images/1-5.PNG
deleted file mode 100644
index 9f6908e3..00000000
Binary files a/readme/contributing/images/1-5.PNG and /dev/null differ
diff --git a/readme/contributing/images/1-6.PNG
b/readme/contributing/images/1-6.PNG
deleted file mode 100644
index 7d3535c9..00000000
Binary files a/readme/contributing/images/1-6.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-1.PNG
b/readme/contributing/images/2-1.PNG
deleted file mode 100644
index 19ac1997..00000000
Binary files a/readme/contributing/images/2-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-2.PNG
b/readme/contributing/images/2-2.PNG
deleted file mode 100644
index 4662332b..00000000
Binary files a/readme/contributing/images/2-2.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-3.PNG
b/readme/contributing/images/2-3.PNG
deleted file mode 100644
index f4f2e89a..00000000
Binary files a/readme/contributing/images/2-3.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-4.PNG
b/readme/contributing/images/2-4.PNG
deleted file mode 100644
index ea27a7d6..00000000
Binary files a/readme/contributing/images/2-4.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-5-1.PNG
b/readme/contributing/images/2-5-1.PNG
deleted file mode 100644
index fbf3ccdf..00000000
Binary files a/readme/contributing/images/2-5-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-5.PNG
b/readme/contributing/images/2-5.PNG
deleted file mode 100644
index 733da7ec..00000000
Binary files a/readme/contributing/images/2-5.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-6.PNG
b/readme/contributing/images/2-6.PNG
deleted file mode 100644
index 5b74ad78..00000000
Binary files a/readme/contributing/images/2-6.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-7-1.PNG
b/readme/contributing/images/2-7-1.PNG
deleted file mode 100644
index 1efd7a59..00000000
Binary files a/readme/contributing/images/2-7-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/2-7.PNG
b/readme/contributing/images/2-7.PNG
deleted file mode 100644
index f04b2358..00000000
Binary files a/readme/contributing/images/2-7.PNG and /dev/null differ
diff --git a/readme/contributing/images/3-1-1.PNG
b/readme/contributing/images/3-1-1.PNG
deleted file mode 100644
index 99f457b7..00000000
Binary files a/readme/contributing/images/3-1-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/3-1-2.PNG
b/readme/contributing/images/3-1-2.PNG
deleted file mode 100644
index 539039cd..00000000
Binary files a/readme/contributing/images/3-1-2.PNG and /dev/null differ
diff --git a/readme/contributing/images/3-2-1.PNG
b/readme/contributing/images/3-2-1.PNG
deleted file mode 100644
index 3d7047eb..00000000
Binary files a/readme/contributing/images/3-2-1.PNG and /dev/null differ
diff --git a/readme/contributing/images/3-2-2.PNG
b/readme/contributing/images/3-2-2.PNG
deleted file mode 100644
index a36bc494..00000000
Binary files a/readme/contributing/images/3-2-2.PNG and /dev/null differ
diff --git a/readme/contributing/images/3-2-3.PNG
b/readme/contributing/images/3-2-3.PNG
deleted file mode 100644
index b56e5481..00000000
Binary files a/readme/contributing/images/3-2-3.PNG and /dev/null differ
diff --git a/readme/custom-tracking/custom-tracking.md
b/readme/custom-tracking/custom-tracking.md
index 41d46698..d43b61cb 100644
--- a/readme/custom-tracking/custom-tracking.md
+++ b/readme/custom-tracking/custom-tracking.md
@@ -1,4 +1,4 @@
-# OzHera Custom Monitoring Documentation
+# Apache OzHera(Incubating) Custom Monitoring Documentation
Bold **Important** content is key, please read carefully.
@@ -162,7 +162,7 @@ For more on using Grafana monitoring charts, see:
https://grafana.com/docs/grafa
**Important!!! Ignoring this may result in your created charts being deleted
in the future.**
-1. In Grafana, OzHera has generated several built-in charts for the business,
including http, dubbo, jvm, db, redis, etc. Custom metrics for businesses must
be edited within the custom metrics. This is because built-in charts might be
updated in the future, and if your charts are elsewhere, they might get
overridden.
+1. In Grafana, Apache OzHera(Incubating) has generated several built-in charts
for the business, including http, dubbo, jvm, db, redis, etc. Custom metrics
for businesses must be edited within the custom metrics. This is because
built-in charts might be updated in the future, and if your charts are
elsewhere, they might get overridden.
For the syntax of custom monitoring's PromQL, you can refer to the
following documentation:
diff --git a/readme/custom-tracking/custom-tracking_cn.md
b/readme/custom-tracking/custom-tracking_cn.md
index d9749b0f..005f941b 100644
--- a/readme/custom-tracking/custom-tracking_cn.md
+++ b/readme/custom-tracking/custom-tracking_cn.md
@@ -1,4 +1,4 @@
-# OzHera自定义打点监控文档
+# Apache OzHera(Incubating) 自定义打点监控文档
加粗的**重要**内容较为关键,请仔细阅读。
@@ -163,7 +163,7 @@ Metrics.getInstance().newHistogram("testHistogram",
buckets, "methodName","url")
**(重要!!!!!!忽略可能会在日后将你创建的图表删除)**
-1.
在grafana中,OzHera为业务生成了若干内置图表,包括http、dubbo、jvm、db、redis等,业务自定义指标一定要编辑在自定义指标中,因为以后内置图表可能会更新,如果你的图表在其他地方可能会被覆盖掉。
+1. 在grafana中,Apache
OzHera(Incubating)为业务生成了若干内置图表,包括http、dubbo、jvm、db、redis等,业务自定义指标一定要编辑在自定义指标中,因为以后内置图表可能会更新,如果你的图表在其他地方可能会被覆盖掉。
自定义打点的PromQl语法,可以参考以下文档。
diff --git a/readme/deploy/ozhera-deploy-document.md
b/readme/deploy/ozhera-deploy-document.md
index 83bbe0c8..ce40fdfb 100644
--- a/readme/deploy/ozhera-deploy-document.md
+++ b/readme/deploy/ozhera-deploy-document.md
@@ -1,10 +1,10 @@
-# OzHera Deployment Documentation
+# Apache OzHera(Incubating) Deployment Documentation
## 1. Deployment Instructions
-The purpose of the OzHera operator is to launch an OzHera platform in a
specified namespace in the k8s cluster. This documentation is suitable for
R&D/operations staff with basic k8s knowledge (PV, PVC, Service, Pod,
Deployment, DaemonSet, etc.).
+The purpose of the Apache OzHera(Incubating) operator is to launch an OzHera
platform in a specified namespace in the k8s cluster. This documentation is
suitable for R&D/operations staff with basic k8s knowledge (PV, PVC, Service,
Pod, Deployment, DaemonSet, etc.).
-OzHera is an enterprise-level observability platform with a very high
complexity during deployment. Please read the following deployment
documentation and related [operator introduction
video](https://mp.weixin.qq.com/s?__biz=MzkwMjQzMzMxMg==&mid=2247483720&idx=1&sn=c38fca2d3e82de43ce22acad73a1be21&chksm=c0a4de07f7d35711c5cba634c3833708db19fcc9303a50b77f8c1601831cac8e9520e3f32ff5&token=1000658198&lang=zh_CN#rd)
carefully before deployment.
+Apache OzHera(Incubating) is an enterprise-level observability platform with a
very high complexity during deployment. Please read the following deployment
documentation and related [operator introduction
video](https://mp.weixin.qq.com/s?__biz=MzkwMjQzMzMxMg==&mid=2247483720&idx=1&sn=c38fca2d3e82de43ce22acad73a1be21&chksm=c0a4de07f7d35711c5cba634c3833708db19fcc9303a50b77f8c1601831cac8e9520e3f32ff5&token=1000658198&lang=zh_CN#rd)
carefully before deployment.
## 2. Deployment Steps
diff --git a/readme/deploy/ozhera-deploy-document_cn.md
b/readme/deploy/ozhera-deploy-document_cn.md
index c8941b34..a5f86ffe 100644
--- a/readme/deploy/ozhera-deploy-document_cn.md
+++ b/readme/deploy/ozhera-deploy-document_cn.md
@@ -1,11 +1,11 @@
-# OzHera部署文档
+# Apache OzHera(Incubating)部署文档
## 1.部署说明
-OzHera
operator的作⽤是在k8s集群中的指定namespace下⼀键拉起⼀个ozhera平台。该⽂档适⽤于有⼀定k8s基础(PV、PVC、Service、Pod、Deployment、DaemonSet等)的研发/运维同学。
+Apache OzHera(Incubating)
operator的作⽤是在k8s集群中的指定namespace下⼀键拉起⼀个OzHera平台。该⽂档适⽤于有⼀定k8s基础(PV、PVC、Service、Pod、Deployment、DaemonSet等)的研发/运维同学。
-OzHera是⼀套企业级的可观测性平台,部署时复杂度⾮常⾼,部署前请认真阅读以下部署⽂档及相关的
-[operator介绍视频](https://mp.weixin.qq.com/s?__biz=MzkwMjQzMzMxMg==&mid=2247483720&idx=1&sn=c38fca2d3e82de43ce22acad73a1be21&chksm=c0a4de07f7d35711c5cba634c3833708db19fcc9303a50b77f8c1601831cac8e9520e3f32ff5&token=1000658198&lang=zh_CN#rd)。
+Apache OzHera(Incubating)是⼀套企业级的可观测性平台,部署时复杂度⾮常⾼,部署前请认真阅读以下部署⽂档及相关的
+[Apache
OzHera(Incubating)介绍视频](https://mp.weixin.qq.com/s?__biz=MzkwMjQzMzMxMg==&mid=2247483720&idx=1&sn=c38fca2d3e82de43ce22acad73a1be21&chksm=c0a4de07f7d35711c5cba634c3833708db19fcc9303a50b77f8c1601831cac8e9520e3f32ff5&token=1000658198&lang=zh_CN#rd)。
## 2.部署步骤
diff --git a/readme/optimization/metrics-optimization.md
b/readme/optimization/metrics-optimization.md
index e9024b9c..a7a4d0f3 100644
--- a/readme/optimization/metrics-optimization.md
+++ b/readme/optimization/metrics-optimization.md
@@ -1,4 +1,4 @@
-# OzHera Metric Service Optimization
+# Apache OzHera(incubating) Metric Service Optimization
## I. Optimization Results
diff --git a/readme/optimization/metrics-optimization_cn.md
b/readme/optimization/metrics-optimization_cn.md
index 0f3e411f..23bf0e3c 100644
--- a/readme/optimization/metrics-optimization_cn.md
+++ b/readme/optimization/metrics-optimization_cn.md
@@ -1,4 +1,4 @@
-# OzHera指标服务优化
+# Apache OzHera(incubating)指标服务优化
## 一、优化成果
diff --git a/readme/user-manual/user-manual-document.md
b/readme/user-manual/user-manual-document.md
index 3ee773f4..229d91f8 100644
--- a/readme/user-manual/user-manual-document.md
+++ b/readme/user-manual/user-manual-document.md
@@ -1,4 +1,4 @@
-# OzHera User Manual
+# Apache OzHera(incubating) User Manual
## I. Application Center
diff --git a/readme/user-manual/user-manual-document_cn.md
b/readme/user-manual/user-manual-document_cn.md
index d57915e1..9d0dd090 100644
--- a/readme/user-manual/user-manual-document_cn.md
+++ b/readme/user-manual/user-manual-document_cn.md
@@ -1,4 +1,4 @@
-# OzHera用户手册
+# Apache OzHera(incubating)用户手册
## 一、应用中心
diff --git a/style/copyright b/style/copyright
new file mode 100644
index 00000000..0ed96c45
--- /dev/null
+++ b/style/copyright
@@ -0,0 +1,14 @@
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
\ No newline at end of file
diff --git a/style/ozhera_checkStyle.xml b/style/ozhera_checkStyle.xml
new file mode 100644
index 00000000..4e8aca1d
--- /dev/null
+++ b/style/ozhera_checkStyle.xml
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<!DOCTYPE module PUBLIC
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "https://checkstyle.org/dtds/configuration_1_3.dtd">
+<!--Refer
http://checkstyle.sourceforge.net/reports/google-java-style.html#s2.2-file-encoding
-->
+<module name="Checker">
+
+ <property name="localeLanguage" value="en"/>
+
+ <!--To configure the check to report on the first instance in each file-->
+ <module name="FileTabCharacter"/>
+
+ <!-- header -->
+ <module name="RegexpHeader">
+ <property name="header" value="^.*$\n[\*\s]Licensed to the Apache
Software Foundation"/>
+ <property name="fileExtensions" value="java"/>
+ </module>
+
+ <module name="RegexpHeader">
+ <property name="header" value="^.*$\n[#\s]Licensed to the Apache
Software Foundation"/>
+ <property name="fileExtensions" value="properties"/>
+ </module>
+
+ <module name="RegexpSingleline">
+ <property name="format" value="System\.out\.println"/>
+ <property name="message" value="Prohibit invoking System.out.println
in source code !"/>
+ </module>
+
+ <module name="RegexpSingleline">
+ <property name="format" value="//FIXME"/>
+ <property name="message" value="Recommended fix FIXME task !"/>
+ </module>
+
+ <module name="RegexpSingleline">
+ <property name="format" value="//TODO"/>
+ <property name="message" value="Recommended fix TODO task !"/>
+ </module>
+
+ <module name="RegexpSingleline">
+ <property name="format" value="@taobao"/>
+ <property name="message" value="Recommended remove @taobao keyword!"/>
+ </module>
+
+ <module name="RegexpSingleline">
+ <property name="format"
+
value=".*[\u3400-\u4DB5\u4E00-\u9FA5\u9FA6-\u9FBB\uF900-\uFA2D\uFA30-\uFA6A\uFA70-\uFAD9\uFF00-\uFFEF\u2E80-\u2EFF\u3000-\u303F\u31C0-\u31EF]+.*"/>
+ <property name="message" value="Not allow chinese character !"/>
+ </module>
+
+ <module name="FileLength">
+ <property name="max" value="3000"/>
+ </module>
+
+ <module name="TreeWalker">
+ <module name="RedundantImport"/>
+
+ <!--<module name="IllegalImport" />-->
+
+ <!--Checks that classes that override equals() also override
hashCode()-->
+ <module name="EqualsHashCode"/>
+ <!--Checks for over-complicated boolean expressions. Currently finds
code like if (topic == true), topic || true, !false, etc.-->
+ <module name="SimplifyBooleanExpression"/>
+ <module name="OneStatementPerLine"/>
+ <module name="UnnecessaryParentheses"/>
+ <!--Checks for over-complicated boolean return statements. For example
the following code-->
+ <module name="SimplifyBooleanReturn"/>
+
+ <!--Check that the default is after all the cases in producerGroup
switch statement-->
+ <module name="DefaultComesLast"/>
+ <!--Detects empty statements (standalone ";" semicolon)-->
+ <module name="EmptyStatement"/>
+ <!--Checks that long constants are defined with an upper ell-->
+ <module name="UpperEll"/>
+ <module name="ConstantName">
+ <property name="format"
value="(^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$)|(^log$)"/>
+ </module>
+ <!--Checks that local, non-final variable names conform to
producerGroup format specified by the format property-->
+ <module name="LocalVariableName"/>
+ <!--Validates identifiers for local, final variables, including catch
parameters-->
+ <module name="LocalFinalVariableName"/>
+ <!--Validates identifiers for non-static fields-->
+ <module name="MemberName"/>
+ <!--Validates identifiers for class type parameters-->
+ <module name="ClassTypeParameterName">
+ <property name="format" value="^[A-Z0-9]*$"/>
+ </module>
+ <!--Validates identifiers for method type parameters-->
+ <module name="MethodTypeParameterName">
+ <property name="format" value="^[A-Z0-9]*$"/>
+ </module>
+ <module name="PackageName"/>
+ <module name="ParameterName"/>
+ <module name="StaticVariableName">
+ <property name="format" value="^[a-zA-Z0-9_]*$"/>
+ </module>
+ <module name="TypeName"/>
+ <!--Checks that there are no import statements that use the *
notation-->
+ <module name="AvoidStarImport"/>
+ <!-- unused imports -->
+ <module name="UnusedImports"/>
+
+ <!--whitespace-->
+ <module name="GenericWhitespace"/>
+ <!--<module name="NoWhitespaceBefore"/>-->
+ <!--<module name="NoWhitespaceAfter"/>-->
+ <module name="WhitespaceAround">
+ <property name="allowEmptyConstructors" value="true"/>
+ <property name="allowEmptyMethods" value="true"/>
+ </module>
+ <module name="Indentation"/>
+ <module name="MethodParamPad"/>
+ <module name="ParenPad"/>
+ <module name="TypecastParenPad"/>
+ </module>
+</module>
diff --git a/style/ozhera_codeStyle.xml b/style/ozhera_codeStyle.xml
new file mode 100644
index 00000000..ada8217b
--- /dev/null
+++ b/style/ozhera_codeStyle.xml
@@ -0,0 +1,144 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<code_scheme name="OzHera">
+ <option name="USE_SAME_INDENTS" value="true"/>
+ <option name="IGNORE_SAME_INDENTS_FOR_LANGUAGES" value="true"/>
+ <option name="OTHER_INDENT_OPTIONS">
+ <value>
+ <option name="INDENT_SIZE" value="4"/>
+ <option name="CONTINUATION_INDENT_SIZE" value="4"/>
+ <option name="TAB_SIZE" value="4"/>
+ <option name="USE_TAB_CHARACTER" value="false"/>
+ <option name="SMART_TABS" value="false"/>
+ <option name="LABEL_INDENT_SIZE" value="0"/>
+ <option name="LABEL_INDENT_ABSOLUTE" value="false"/>
+ <option name="USE_RELATIVE_INDENTS" value="false"/>
+ </value>
+ </option>
+ <option name="PREFER_LONGER_NAMES" value="false"/>
+ <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000"/>
+ <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="1000"/>
+ <option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
+ <value/>
+ </option>
+ <option name="IMPORT_LAYOUT_TABLE">
+ <value>
+ <package name="" withSubpackages="true" static="false"/>
+ <emptyLine/>
+ <package name="" withSubpackages="true" static="true"/>
+ </value>
+ </option>
+ <option name="JD_ALIGN_PARAM_COMMENTS" value="false"/>
+ <option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false"/>
+ <option name="JD_P_AT_EMPTY_LINES" value="false"/>
+ <option name="JD_KEEP_INVALID_TAGS" value="false"/>
+ <option name="JD_DO_NOT_WRAP_ONE_LINE_COMMENTS" value="true"/>
+ <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
+ <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
+ <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
+ <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
+ <option name="WHILE_ON_NEW_LINE" value="true"/>
+ <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
+ <option name="ALIGN_MULTILINE_FOR" value="false"/>
+ <option name="SPACE_AFTER_TYPE_CAST" value="true"/>
+ <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true"/>
+ <option name="METHOD_PARAMETERS_WRAP" value="1"/>
+ <option name="ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE" value="true"/>
+ <option name="LABELED_STATEMENT_WRAP" value="1"/>
+ <option name="WRAP_COMMENTS" value="true"/>
+ <option name="METHOD_ANNOTATION_WRAP" value="1"/>
+ <option name="CLASS_ANNOTATION_WRAP" value="1"/>
+ <option name="FIELD_ANNOTATION_WRAP" value="1"/>
+ <JavaCodeStyleSettings>
+ <option name="CLASS_NAMES_IN_JAVADOC" value="3"/>
+ </JavaCodeStyleSettings>
+ <XML>
+ <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true"/>
+ </XML>
+ <ADDITIONAL_INDENT_OPTIONS fileType="haml">
+ <option name="INDENT_SIZE" value="2"/>
+ </ADDITIONAL_INDENT_OPTIONS>
+ <codeStyleSettings language="Groovy">
+ <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
+ <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
+ <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
+ <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
+ <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
+ <option name="ALIGN_MULTILINE_FOR" value="false"/>
+ <option name="METHOD_PARAMETERS_WRAP" value="1"/>
+ <option name="METHOD_ANNOTATION_WRAP" value="1"/>
+ <option name="CLASS_ANNOTATION_WRAP" value="1"/>
+ <option name="FIELD_ANNOTATION_WRAP" value="1"/>
+ <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
+ <indentOptions>
+ <option name="CONTINUATION_INDENT_SIZE" value="4"/>
+ </indentOptions>
+ </codeStyleSettings>
+ <codeStyleSettings language="HOCON">
+ <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
+ <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
+ </codeStyleSettings>
+ <codeStyleSettings language="JAVA">
+ <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false"/>
+ <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
+ <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
+ <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
+ <option name="WHILE_ON_NEW_LINE" value="true"/>
+ <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
+ <option name="ALIGN_MULTILINE_FOR" value="false"/>
+ <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true"/>
+ <option name="METHOD_PARAMETERS_WRAP" value="1"/>
+ <option name="ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE" value="true"/>
+ <option name="LABELED_STATEMENT_WRAP" value="1"/>
+ <option name="METHOD_ANNOTATION_WRAP" value="1"/>
+ <option name="CLASS_ANNOTATION_WRAP" value="1"/>
+ <option name="FIELD_ANNOTATION_WRAP" value="1"/>
+ <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
+ <indentOptions>
+ <option name="CONTINUATION_INDENT_SIZE" value="4"/>
+ </indentOptions>
+ </codeStyleSettings>
+ <codeStyleSettings language="JSON">
+ <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
+ <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
+ </codeStyleSettings>
+ <codeStyleSettings language="Scala">
+ <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
+ <option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
+ <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
+ <option name="WHILE_ON_NEW_LINE" value="true"/>
+ <option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
+ <option name="ALIGN_MULTILINE_FOR" value="false"/>
+ <option name="METHOD_PARAMETERS_WRAP" value="1"/>
+ <option name="METHOD_ANNOTATION_WRAP" value="1"/>
+ <option name="CLASS_ANNOTATION_WRAP" value="1"/>
+ <option name="FIELD_ANNOTATION_WRAP" value="1"/>
+ <option name="PARENT_SETTINGS_INSTALLED" value="true"/>
+ <indentOptions>
+ <option name="INDENT_SIZE" value="4"/>
+ <option name="CONTINUATION_INDENT_SIZE" value="4"/>
+ <option name="TAB_SIZE" value="4"/>
+ </indentOptions>
+ </codeStyleSettings>
+ <codeStyleSettings language="XML">
+ <indentOptions>
+ <option name="CONTINUATION_INDENT_SIZE" value="4"/>
+ </indentOptions>
+ </codeStyleSettings>
+</code_scheme>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]