如何发布二级域名文档

2021-07-09 by uino 86 研发

研发平台支持所有研发组,产品,项目组发布文档,以便可以轻松的在互联网上快速访问与传播,方便更新。一般来说准备以下步骤即可快速发布专属文档

编写文档

你可以使用常用的工具编写文档,如使用Markdown格式编写,最后需要全部转换成静态HTML文件即可。

这里有一点需要注意,默认的首页文件名为index.html,请确保HTML文档跟目录里有一个index.html文件

如以下例子

$ ll
total 56
-rw-r--r--   1 Nicholas  staff   6.1K Jun 23 15:27 CHANGELOG.md
-rw-r--r--   1 Nicholas  staff   156B Jun 23 15:27 Dockerfile
-rw-r--r--   1 Nicholas  staff   1.8K Jun 23 15:29 README.md
drwxr-xr-x   6 Nicholas  staff   192B Jun 23 15:27 examples
-rw-r--r--@  1 Nicholas  staff   1.5K Jun 23 15:33 index.html
-rw-r--r--   1 Nicholas  staff    30B Jun 23 15:27 index.js
-rw-r--r--   1 Nicholas  staff   382B Jun 23 15:27 package.json
drwxr-xr-x  12 Nicholas  staff   384B Jun 23 15:27 styles

提交静态目录到Git

首先,在Git上新创建一个仓库

然后,把静态目录下的内容全部推送到仓库上的master分支,并把所有静态资源HTML,CSS和JS都放在docs目录下

如:

publish-docs.png

想好一个二级域名的名称

此名称用在域名,所以必须是小写字母,尽量简单容易记,如以下是现有的二级域名文档例子

发布

把你想好的二级域名以及文档仓库地址告诉DL部门-忠哥,剩下的就等着发布吧~~~