Huawei LiteOS（以下简称LiteOS）欢迎开发者参与到开源社区的贡献中来，本文主要介绍参与LiteOS文档贡献的写作规范，如果贡献者提交文档的修改或提交新的文档，请参照此规范。如需提交新的文档，在LiteOS代码仓doc目录下创建新的.md文件，命名需遵循xxx_xxx.md格式，根据文档的内容来声明。比如介绍写作规范的文档，

查看更多 →

签名审核规范 格式限制 签名名称不能含有黄赌毒及其他违反法律规定的信息； 签名不支持中性化签名，需能辨别所属公司或公司归属的网站、产品、APP； 国内短信签名由【】及签名名称组成，签名名称要求2~12个字（只能包含中文、数字、字母，不能为纯数字，国内短信签名名称尽量使用中文）；

查看更多 →

异形字、语句不通顺、非常用的表达法等。 如遇到违反规范并造成恶劣影响的，将严肃处理并进行封号。请严格遵守规范要求，加强自身业务安全，健康发送短信。 内容规范可能随运营商规则变化实时调整，以最终 内容审核 结果为准。 父主题： 审核规范

查看更多 →

设计规范 命名规范 数据库对象（库名、表名、字段名、索引名）命名建议全部使用小写字母开头，后面跟字母或者数字，数据库对象（库名、表名、字段名、索引名）名字长度建议都不要大于32字节。 数据库名称不能使用特殊字符("",.,$,\,/,*,?,~,#,:,|")和空字符\0，数据库

查看更多 →

实例使用规范 数据库连接 RDS for PostgreSQL是进程架构，每个客户端连接都对应一个后端服务进程。 根据业务的复杂度，合理配置“max_connections”，例如，参考pgtune： WEB应用：“max_connections ”配置为 200 OLTP应用：

查看更多 →

实例使用规范 数据库实例 数据库实例类型选择 主备 一主一备的经典高可用架构。适用于大中型企业的生产数据库，覆盖互联网、物联网、零售电商、物流、游戏等行业应用。 备机提高了实例的可靠性，创建主机的过程中，同步创建备机，备机创建成功后，用户不可见。 当主节点故障后，会发生主备切换，

查看更多 →

构造规范请求 使用AK/SK方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与云服务API网关使用相同的请求规范，可以确保同一个HTTP请求的前后端得到相同的签名结果，从而完成身份校验。 HTTP请求规范伪代码如下： CanonicalRequest =

查看更多 →

目前，社区有多种 Commit message 的写法规范。LiteOS采用的是Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。格式化的Commit message有几个好处：提供更多的历史信息，方便快速浏览。可以过滤某些commit（比如文档改动），便于快速查找信息。可以直接从commit生成Change

查看更多 →

服务包规范 本规范主要面向对象为初次开发的服务以及想要使用OSC平台提供的附加能力进行规范转换的服务。 如果开发者已有或仅想使用Helm/Operator-Framework规范的服务，可以直接参考章节开源服务包规范。 OSC服务包介绍 元数据Metadata 资源集合Manifests

查看更多 →

#【必选】CustomResourceDefinition自定义资源定义文件，可多个。 更多介绍参见官网Operator Framework。 接入规范说明 父主题： 开源服务包规范

查看更多 →

接入规范说明 开源OLM服务（operator-framework）服务支持自定义配置服务场景、支持架构等配置，其描述说明定义在clusterserviceversion.yaml中，具体样例如下： apiVersion: operators.coreos.com/v1alpha1

查看更多 →

接入规范说明 开源helm服务支持自定义配置服务场景、支持架构等配置，其描述说明定义在Chart.yaml中，具体样例如下： apiVersion: v1 description: "nginx \n" maintainers: - email: support@rancher.com

查看更多 →

基础命令规范 查询命令 写入/更新命令 删除命令 父主题： 数据库使用规范

查看更多 →

设计规范 命名规范 数据库对象（库名、表名、字段名、索引名）命名建议全部使用小写字母开头，后面跟字母或者数字，数据库对象（库名、表名、字段名、索引名）名字长度建议都不要大于32字节。 数据库名称不能使用特殊字符("",.,$,\,/,*,?,~,#,:,|")和空字符\0，数据库

查看更多 →

模板规范和变量规范包含哪些内容？ 模板规范 模板规范分为模板格式规范和模板内容规范。 模板格式规范 文本短信模板限500字符。 不支持使用【】，【】可能会与签名混淆，导致发送失败。 不支持使用特殊符号，如￥、★、^_^、&、√、※、[]等，特殊符号可能会导致短信出现乱码。 模板内容规范

查看更多 →

数据格式规范 推荐系统OBS文件夹规范 离线数据源 实时日志 全局特征信息文件 父主题： 用户指南（旧版）

查看更多 →

运维流程规范 运维管理流程规范 遵从运维流程，为招标方提供规范性、标准化服务，从而提高解决问题的效率、缩短业务故障时间。 图1 运维管理流程规范 服务台：服务台是云平台和云服务用户之间的单一联系点。它通过提供一个集中和专职的服务联系点促进了组织业务流程与服务管理基础架构集成。服务

查看更多 →

Doris组件使用规范 本章节介绍Doris组件使用规范。 建表规范 【强制】创建表指定分桶buckets时，每个桶的数据大小为应保持在100M-3G之间，单分区中最大分桶数据不超过5000。 【强制】表数据超过5亿条以上必须设置分区分桶策略。 【强制】分桶的列不要设置太多，一般

查看更多 →

gui.json规范 gui.json文件是组件的配置文件。本文介绍gui.json文件的字段详情，您可以参考本文的字段说明，根据自身需求，灵活修改gui.json文件，自定义组件的配置面板。 gui.json规范示例： 1 2 3 4 5 6 7 { "name": "newCom"

查看更多 →

缓存访问失败时，具备降级措施，从DB获取数据；或者具备容灾措施，自动切换到另一个Redis使用。 - 数据设计规范 分类 原则 原则说明 备注 Key相关规范 使用统一的命名规范。 一般使用业务名（或数据库名）为前缀，用冒号分隔。Key的名称保证语义清晰。 例如，业务名:子业务名:id

查看更多 →

用例总体规范 测试用例是为特定目的而设计的一组测试输入、执行条件和预期结果。设计测试用例不能只凭借一些主观或直观的想法，应该要以成熟的测试规范为指导，设计出风格一致、用词一致、精确、简洁、易懂、易确认的测试用例，减少测试用例理解偏差及用例管理成本，提升测试效率及质量；测试用例之间也需保持相互独立，不要依赖其他用例。

查看更多 →