Skip to content

Commit 0069325

Browse files
committed
update contribute doc
1 parent 2c54526 commit 0069325

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ HyperApp 是一个基于 SSH 和 Docker 的自动化部署工具, 您可以在
1919
* [新手教程:如何一键搭建支持 https 的网站](./zh/Get-Started.md)
2020
* [新手教程:如何一键科学上网](./zh/GFW.md)
2121
* [新手教程:如何添加 GCE 和 AWS 的服务器](./zh/Add-Sever-Cloud.md)
22+
* [如何使用 URL Scheme](./zh/workflow.md)
2223
* [使用须知](#使用须知)
2324
* [支持的系统](#支持的-linux-系统)
2425
* [商店应用配置](./zh/Apps.md)

zh/contribute.md

+32-3
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22

33
开发者精力有限,很难有时间添加各类相关的文档,但是文档对于新手来说又是不可或缺的,为了完善 HyperApp 相关的文档,开发者决定凡是参与编写文档的贡献者均赠送至少一枚 HyperApp 兑换码作为感谢。具体所需要添加的文档以及要求请看下文。
44

5+
先Fork本仓库,编写文章完成后,提交PR到主仓库。文章版权归贡献者所有,但自动授予开发者在 HyperApp 相关的文档、社交账号里任意修改、发布的权利。
6+
7+
58
### 文档格式
69

10+
需要是图文教程,每一步都要有截图。
11+
712
1. 统一使用 `Markdown` 文件,请参阅 [Github 官方的 Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
813
1. 不要更改 README 首页文件,我会在首页添加链接
914
2. 文档要放在各语言子目录下面,比如中文的要放在 `zh` 目录下面,同时按功能放入子目录中(参见下面各个分类的要求)
@@ -13,7 +18,7 @@
1318
## 任务列表
1419

1520

16-
### 厂商使用
21+
### 厂商使用教程
1722

1823
讲述各厂商如何创建服务器并添加到 HyperApp 中,同时文档要面向非技术用户。
1924

@@ -27,13 +32,37 @@
2732

2833
文档放在 `语言/vendors` 下面。比如 Linode 放在 `zh/vendors/Linode.md`,图片放在 `zh/vendors/images/Linode-1.png`
2934

30-
- [ ] Google Cloud Engine
35+
- [x] Google Cloud Engine
3136
- [ ] Amazon AWS
3237
- [ ] Vultr
3338
- [ ] Digital Ocean
3439
- [ ] Linode
40+
- [ ] 搬瓦工(需要说明如何分辨 OpenVZ 和 KVM,并且声明 Docker 不支持 OpenVZ 的主机)
41+
- [ ] 樱花
42+
43+
---
44+
45+
### 应用使用教程
46+
47+
所有可以使用 Nginx 和 SSL 的应用,都需要介绍 Nginx 和 SSL 的配置,可以复制下面这段话:
48+
49+
```md
50+
### Nginx 和自动 SSL 证书
51+
52+
如果你需要在同一个服务器上部署多个应用,那么需要配置 Nginx 将不同域名的请求代理到不同的应用上。你可以点击“显示Nginx 和SSL设置"。填入设置并且将应用安装到主机上后,并不需要重启 Nginx 和 Nginx SSL Support,会自动检测。
53+
54+
首先需要在目标机器上安装 `Nginx` 和 `Nginx SSL Support`。
55+
56+
Nginx 配置:
57+
1. 域名:填入要访问的域名,比如是博客的话可以填入 blog.xx.com
58+
2. 端口:这个是反向代理的端口,不填的话会自动检测,如果自动检测失败,那么可以填写Docker容器中expose出来的那个端口。
3559

60+
SSL 配置:
61+
1. 域名:填入要支持SSL的域名,一般情况下需要与上面的域名一样。
62+
2. 邮箱:
63+
```
3664

37-
### 应用
3865

66+
- [ ] Resilio Sync 如何安装。客户端如何安装。
67+
- [ ]
3968

workflow.md zh/workflow.md

File renamed without changes.

0 commit comments

Comments
 (0)