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

查看更多 →

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

查看更多 →

涉及实时发送的短信，建议提前加模板，以免造成延迟（类似于航班信息订票类信息等）。 内容规范可能随运营商规则变化实时调整，以最终 内容审核 结果为准。 推广短信内容规范 推广短信模板内容不支持变量。 不支持给非会员用户发送推广短信。 推广短信发送时间为每日8：00 - 21：00，尽量避免夜间发送。 禁止发送涉及以下行业的短信：

查看更多 →

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

查看更多 →

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

查看更多 →

DDL操作规范 建议3.1 DDL操作（CREATE除外）避免在业务高峰期和长事务中执行 违反规范的影响： DDL操作普遍持锁级别高，如ALTER、DROP、TRUNCATE、REINDEX、VACUUM FULL等，执行时会造成业务等锁阻塞。 高峰期执行持锁级别高的DDL操作，造成业务等锁阻塞。

查看更多 →

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

查看更多 →

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

查看更多 →

网站接入 如何在添加 域名 中配置防护域名？ 添加域名时，防护网站端口需要和源站端口配置一样吗？ 如何放行云模式WAF的回源IP段？ 删除防护域名后CNAME记录会保留多久？ 后端 服务器 配置多个源站地址时的注意事项？ Web应用防火墙 支持配置泛域名吗？ Web应用防火墙支持防护中文域名吗？

查看更多 →

网站管理 创建网站资产 删除网站资产 获取网站资产 认证网站资产 更新网站配置 获取网站配置 父主题： API

查看更多 →

网站管理 查看网站基本信息 导出网站设置列表 切换防护模式 修改负载均衡算法 更换网站绑定的防护策略 更新网站绑定的证书 修改服务器配置信息 查看防护网站的云监控信息 批量跨企业项目迁移域名 删除防护网站 父主题： 网站设置

查看更多 →

网站设置 网站接入后推荐配置 网站管理

查看更多 →

在“资产列表 > 网站”页签，单击对应的网站信息“操作”列的“删除”。 用户可以同时删除多个网站。勾选多个网站后，单击列表左上方的“批量删除”，在弹出的确认对话框单击“确认”，即可批量删除网站。 在弹出的确认对话框中，单击“确认”。 在页面右上角弹出“域名删除成功”，则说明网站删除成功。

查看更多 →

访问网站 域名解析 选择“域名与网站 > 域名注册”。 在域名右侧操作列单击“解析”。 单击域名进入域名详情页后，单击“添加记录集”。 添加记录集。 网站备案 根据国家规定，如果客户网站所使用的服务器是在中国大陆，就需要进行ICP备案，没有备案的域名不能访问网站。具体操作请参见备案中心。

查看更多 →

取消接入，变成空壳网站。 网站内容不合规，被取消接入，变成空壳网站。 空壳网站的影响 空壳网站不能提交备案申请。 图1 管局驳回空壳网站备案 处理方法 方法一：请联系网站当前使用的服务器接入商，申请接入备案。如果您的域名解析至华为 云服务器 ，具体操作流程请参考，步骤一：填写订单 方法二：注销当前的空壳网站，并重新备案。

查看更多 →

目前，社区有多种 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

查看更多 →

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

查看更多 →