Error code optimization and documentation checklist

[binbinCheng]

Error code optimization and documentation checklist

---

In order to standardize the use of error codes of linkis modules, the linkis error codes are currently optimized.
Requires sorting and optimization by module

• 1. List the existing error codes of the module, organize them into md documents and put them in the directory https://github.com/apache/incubator-linkis/tree/dev-1.3.1/docs/errorcode/xxx.md
• 2. Optimize the use of error code classes and use enumeration classes uniformly
• 3. Error descriptions in Chinese need to be adjusted to English ("Chinese") mode
• 4. Exception and error code usage specification
     https://linkis.apache.org/en-US/community/development-specification/exception-catch

---

为了统一规范linkis模块的错误码使用，目前对linkis错误码进行优化整理
要求按模块进行整理优化

1. 罗列该模块已有的错误码 整理到md文档 放到目录 https://github.com/apache/incubator-linkis/tree/dev-1.3.1/docs/errorcode/xxx.md
2. 优化错误码类的使用，统一使用枚举类
3. 中文的错误描述 需要调整为 英文("中文") 模式
4. 异常和错误码使用规范
   https://linkis.apache.org/zh-CN/community/development-specification/exception-catch

---

• [linkis-common ]module errorcode optimization and documentation #3355
• [linkis-rpc] module errorcode optimization and documentation #3361
• [linkis-cli-application ]module errorcode optimization and documentation #3365
• [linkis-cli-core]module errorcode optimization and documentation #3367
• [linkis-computation-governance-common]module errorcode optimization and documentation #3368
• [linkis-cli-application ]module errorcode optimization and documentation #3369
• [linkis-computation-engineconn ]module errorcode optimization and documentation #3370
• [linkis-engineconn-core ]module errorcode optimization and documentation #3371
• [accessible-executor ]module errorcode optimization and documentation #3372
• [linkis-engineconn-plugin-core ]module errorcode optimization and documentation #3373
• [linkis-engineconn-manager-core]module errorcode optimization and documentation #3374
• [linkis-engineconn-manager-server ]module errorcode optimization and documentation #3375
• [linkis-entrance]module errorcode optimization and documentation #3376
• [linkis-label-common]module errorcode optimization and documentation #3377
• [linkis-manager-common ]module errorcode optimization and documentation #3378
• [linkis-manager-persistence] module errorcode optimization and documentation #3379
• [elasticsearch ]module errorcode optimization and documentation #3380
• [flink ]module errorcode optimization and documentation #3383
• [hive ]module errorcode optimization and documentation #3384
• [jdbc ]module errorcode optimization and documentation #3385
• [openlookeng ]module errorcode optimization and documentation #3386
• [pipeline ]module errorcode optimization and documentation #3387
• [persto ]module errorcode optimization and documentation #3397
• [python ]module errorcode optimization and documentation #3399
• [shell ]module errorcode optimization and documentation #3400
• [spark]module errorcode optimization and documentation #3402
• [sqoop]module errorcode optimization and documentation #3403
• [linkis-orchestrator-core]module errorcode optimization and documentation #3404
• [linkis-bml-client ]module errorcode optimization and documentation #3405
• [linkis-bml-server]module errorcode optimization and documentation #3406
• [linkis-configuration ]module errorcode optimization and documentation #3407
• [linkis-cs-client ]module errorcode optimization and documentation #3408
• [linkis-cs-common ]module errorcode optimization and documentation #3409
• [ linkis-cs-server ]module errorcode optimization and documentation #3410
• [linkis-datasource-client ]module errorcode optimization and documentation #3411
• [linkis-datasource-manager ]module errorcode optimization and documentation #3412
• [ linkis-metadata ]module errorcode optimization and documentation #3413
• [linkis-metadata-query ]module errorcode optimization and documentation #3414
• [linkis-instance-label ]module errorcode optimization and documentation #3415
• [linkis-storage-script-dev-server ]module errorcode optimization and documentation #3416
• [linkis-gateway-authentication ]module errorcode optimization and documentation #3417
• [linkis-gateway-core]module errorcode optimization and documentation #3418
• [linkis-gateway-httpclient-support ]module errorcode optimization and documentation  #3419
• [linkis-spring-cloud-gateway ]module errorcode optimization and documentation  #3420
• [linkis-udf-common ]module errorcode optimization and documentation #3422
• [linkis-httpclient ]module errorcode optimization and documentation #3423
• [linkis-module]module errorcode optimization and documentation #3424
• [linkis-scheduler ]module errorcode optimization and documentation #3425
• [linkis-storage ]module errorcode optimization and documentation #3426

[github-actions]

😊 Welcome to the Apache Linkis (incubating) community!!
We are glad that you are contributing by opening this issue.

Please make sure to include all the relevant context.
We will be here shortly.

If you are interested in contributing to our website project, please let us know!
You can check out our contributing guide on
👉 How to Participate in Project Contribution.

WeChat Group:

Mailing Lists:

name	description	Subscribe	Unsubscribe	archive
dev@linkis.apache.org	community activity information	subscribe	unsubscribe	archive