Skip to content
Permalink
Browse files

[README] Create a new README in zh_tw (#55)

* 新增繁中翻译

* Create README-zh_tw.md

* 改檔名

zh to zh_cn

* 改第一行code

* new this md

* change first line of code.

* change first line of code

* change first line of code

* change the permutation of first line.

* Update README-zh_tw.md

* 翻一半

* 翻譯成繁中

* 繁中細節修改

* create file

* create file with translating

* change the title to zh_cn

* first line

* first line of code

* Update API-zh_tw.md

* first line of code and the title

* Update CONTRIBUTING.md

* Update README.md

* Update CONTRIBUTING.md

* translating to zh_tw

* modifying the hyperlink

* Update README-zh_tw.md

簡體中文 to 簡
繁體中文 to 繁

* Update API-zh_cn.md

簡體中文 to 簡
繁體中文 to 繁

* Update CONTRIBUTING-zh_cn.md

簡體中文 to 簡
繁體中文 to 繁

* Update CONTRIBUTING-zh_tw.md

簡體中文 to 簡
繁體中文 to 繁

* Update README-zh_cn.md

簡體中文 to 簡
繁體中文 to 繁

* Update API-zh_tw.md

簡體中文 to 簡
繁體中文 to 繁

* Update CONTRIBUTING.md

* Update README-zh_tw.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING-zh_cn.md

* Update CONTRIBUTING-zh_tw.md

* Update README-zh_cn.md

* Update README-zh_tw.md
  • Loading branch information...
kevinyin9 authored and import-yuefeng committed Mar 26, 2019
1 parent 1319ecb commit 0b29538a93c31ff2a41af64b7dc69ddc13d100ae
@@ -1,4 +1,4 @@
<p align="right">English | <a href="./docs/CONTRIBUTING-zh.md">中文</a></p>
<p align="right">En | <a href="./docs/CONTRIBUTING-zh_cn.md">简</a> | <a href="./docs/CONTRIBUTING-zh_tw.md">繁</a></p>

# Contributing

@@ -1,4 +1,4 @@
<p align="right">English | <a href="./docs/README-zh.md">中文</a></p>
<p align="right">En | <a href="./docs/README-zh_cn.md">简</a> | <a href="./docs/README-zh_tw.md">繁</a></p>

<div align="center">

@@ -1,4 +1,6 @@
# instantbox 服务API文档
<p align="right">简 | <a href="./API-zh_tw.md">繁</a></p>

# instantbox 服务API文档

文档版本:0.0.3

@@ -0,0 +1,261 @@
<p align="right">繁 | <a href="./API-zh_cn.md">简</a></p>

# instantbox 服務API文件

文件版本:0.0.3

修訂歷史:

- 0.0.1:初稿 2018/12/11

- 0.0.2:修改狀態碼 2018/12/11

- 0.0.3:修改 webshell 生成方式,改進 API,支持 Ubuntu/CentOS/Alpine 的大部分鏡像 2018/12/18

主要改進如下:

​ 1. API 從 <font color=#DC143C>/v1/superspire/</font> -> <font color=#DC143C>/v2/superinspire/</font>

​ 2. 支援 Ubuntu 14.04~18.04, CentOS6.10, CentOS7, Alpine latest

​ 3. 支援 nginx 頻率控制,預設返回 503 錯誤


## API請求方式說明

- 目前所有的提交類接口僅支援 POST 方式,查詢類接口僅支援 GET 方式 [暫時都開放]
- 所有參數在傳入時應當使用:**UTF-8 編碼**


### 請求的URL

格式:
```
/v2/superinspire/{relative_path}?{query_string}
```

舉例:
```
/v2/superinspire/getOS?os=10000
```

### 參數說明

| **參數名稱** | **描述** |
| ----------- | ------- |
| relative_path | API 操作相對路徑,如:`getOS` |
| query_string | 放在 HTTP header傳入的參數,必須經過 UrlEncode 編碼 |

### HTTP GET 和 POST 方式使用說明

| 請求方式 | GET | POST |
| -------- | --- | ---- |
| URL | `/v2/superinspire/{relative_path}?{query_string}` | `/v2/superinspire/{relative_path}?{query_string}` |
| 請求參數 | 全部攜帶在 HTTP 請求header的 query_string 中。 | 既可攜帶在 query_string 中,也可攜帶在 HTTP Body 中。攜帶在 query_string 中的參數的值,必須進行 UrlEncode 編碼; 攜帶在 HTTP Body 中的參數,則不需要進行 UrlEncode 編碼。 |
| HTTP BODY | 不攜帶 HTTP Body | multipart/form-data |

註:

- 如果 HTTP Body 和 query_string 存在相同的參數,則以 query_string 中的參數為準。
- HTTP URL 長度有限,若參數值長度過長,建議將參數放在 HTTP Body 中進行傳輸


### API 回應格式說明

| | 正常請求 | 異常請求 |
| --------- | ------- | ------- |
| HTTP狀態碼 | 1 OK | 4** : 用戶請求錯誤。 5** : server 服務失敗。 |
| HTTP BODY | API 響應內容。除特殊說明外,為 JSON 字符串,例如:`{"statusCode":1, "message": "SUCCESS"}` | JSON 字符串,例如:`{"statusCode":404, "message": "Not support OS!"}` |


## 狀態碼

**狀態碼**用於指示錯誤類型。即:回應體(json 格式)的 `statusCode` 字段。

| 狀態碼 (statusCode) | 描述 |
| ------------------ | ---------- |
| 1 | 操作執行成功 |
| 0 | 操作執行失敗 |


## API列表

### 容器列表

```
GET /getOSList
```

#### 請求參數

| 參數名 | 類型 | 描述 | 必選 |
| ----- | --- | ---- | --- |
| 無 | 無 | 無 | 無 |

#### 返回

| 參數名 | 類型 | 必選 |
| -------- | -------- | --- |
| json 數據 | json 類型 | 是 |

返回範例
```json
[
{
"label": "Ubuntu",
"value": "Ubuntu",
"logoUrl": "https://cdn.jsdelivr.net/gh/instantbox/instantbox-images/icon/ubuntu.png",
"subList": [
{
"label": "12.04",
"osCode": "10000"
},
{
"label": "14.04",
"osCode": "10001"
},
{
"label": "16.04",
"osCode": "10002"
},
{
"label": "18.04",
"osCode": "10003"
},
{
"label": "latest",
"osCode": "10004"
}
]
},
{
"label": "CentOS",
"value": "CentOS",
"logoUrl": "https://cdn.jsdelivr.net/gh/instantbox/instantbox-images/icon/centos.png",
"subList": [
{
"label": "6.10",
"osCode": "20000"
},
{
"label": "7",
"osCode": "20001"
},
{
"label": "latest",
"osCode": "20002"
}
]
},
{
"label": "Arch Linux",
"value": "Arch Linux",
"logoUrl": "https://cdn.jsdelivr.net/gh/instantbox/instantbox-images/icon/arch.png",
"subList": [
{
"label": "2018.12.01",
"osCode": "30000"
},
{
"label": "latest",
"osCode": "30001"
}
]
},
{
"label": "Debian",
"value": "Debian",
"logoUrl": "https://cdn.jsdelivr.net/gh/instantbox/instantbox-images/icon/debian.png",
"subList": [
{
"label": "9.6.0",
"osCode": "40000"
},
{
"label": "latest",
"osCode": "40001"
}
]
},
{
"label": "Fedora",
"value": "Fedora",
"logoUrl": "https://cdn.jsdelivr.net/gh/instantbox/instantbox-images/icon/fedora.png",
"subList": [
{
"label": "28",
"osCode": "50000"
},
{
"label": "29",
"osCode": "50001"
},
{
"label": "latest",
"osCode": "50002"
}
]
},
{
"label": "Alpine",
"value": "Alpine",
"logoUrl": "https://cdn.jsdelivr.net/gh/instantbox/instantbox-images/icon/alpine.png",
"subList": [
{
"label": "latest",
"osCode": "60000"
}
]
}
]
```


### 生成容器

```
GET /getOS
```

#### 請求參數

| 參數名 | 類型 | 描述 | 必選 | 例子 |
| ------- | ------------ | ---------------------------------------- | ---- | ---------- |
| os | string | 指定系統請求編碼 | 是 | 10000 |
| timeout | string | 容器最長存活時間時間戳 [當前時間戳+存活時間長度] | 否 | 1544514176 |
| cpu | string(Core) | 請求給予 CPU 資源使用限制 | 否 | 1 |
| mem | string(MB) | 請求給予內存資源使用限制 | 否 | 512 |
| port | string | 開放的Port,目前只允許開放一個Port | 否 | 80 |

#### 返回

| 參數名 | 類型 | 描述 | 必選 |
| ----------- | ------- | --------------------------------------- | --- |
| statusCode | integer | 狀態碼 (1, 302, 403, 404) | 是 |
| message | string | 狀態解讀 | 是 |
| shareUrl | string | 容器 Url 地址 | 否 |
| containerId | string | 容器標識碼 | 否 |
| openPort | string | 若要測試帶Port的應用,給予臨時Port(預設不提供) | 否 |


### 刪除容器

```
GET /rmOS
```

#### 請求參數

| 參數名 | 類型 | 描述 | 必選 |
| ----------- | ------ | ----------- | --- |
| containerId | string | 容器標識碼 | 是 |
| shareUrl | string | 容器 Url 地址 | 是 |
| timestamp | string | 當前時間戳 | 是 |

#### 返回

| 參數名 | 類型 | 描述 | 必選 |
| ---------- | ------- | ----------------- | --- |
| statusCode | integer | 狀態碼 (1, 2, 302) | 是 |
| message | string | 狀態解讀 | 是 |

@@ -1,4 +1,4 @@
<p align="right">中文 | <a href="../CONTRIBUTING.md">English</a></p>
<p align="right"> | <a href="./CONTRIBUTING-zh_tw.md">繁</a> | <a href="../CONTRIBUTING.md">En</a></p>

### 一起来贡献 instantbox 吧!

@@ -0,0 +1,85 @@
<p align="right">繁 | <a href="./CONTRIBUTING-zh_cn.md">简</a> | <a href="../CONTRIBUTING.md">En</a></p>

### 一起來貢獻 instantbox 吧!

> 首先感謝您關注 instantbox 的發展, 這裡會告訴您如何參與共同建構更好的 instantbox !

# 貢獻指南

> 按照共同的貢獻指南才能更好的參與貢獻和持續推動整個項目的發展

### Commit message 指南

* 盡量 "一次修改" 就提交 "一次 message"

例如當前有如下工作:

* 一個 bug 需要修復
* 一個新 feature 開發

建議選擇一個更為重要的工作先行處理,並在通過測試後進行 commit

而不是在一次 commit 中完成多項工作(既完成 bug 修復, 同時也完成新 feature 開發)

* Commit message 格式

項目使用 AngularJS 的 [commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) [[中文]](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)

`<type>(<scope>): <subject>`

其中 `type` 有以下可選項:
* feat:新功能(feature)
* fix:修補bug
* docs:文檔(documentation)
* style: 格式(不影響代碼運行的變動)
* refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
* perf:提升性能
* test:增加測試
* chore:建構過程或輔助工具的變動

例如:

* docs(README): add sponsor link

* style(file.py): fix syntax error

* fix(api): fix create docker container bug


### Issue 指南

* 盡可能提供足夠的運行環境的訊息

* 盡可能提供運行時的問題

* 盡可能提供完整打出錯誤日誌(log)的訊息


### Pull request 指南

* 盡量保持 commit history 乾淨完整

* 確認程式碼風格通過 pycodestyle 驗證

* 編寫並確認程式碼通過單元測試

* 盡量能夠描述修改內容和原因

* 每一個 PR 需要經過至少一次他人的 review


### 加入 instantbox

想加入 instantbox 團隊? 非常歡迎!

請將您的請求發送到 team@instantbox.org 並註明請求和需求即可~

歡迎你參與 instantbox , 同時希望 instantbox 能幫助你成長, 不過作為一個窮窮的小開源組織(哭), 我們暫時不能提供任何經濟上的回饋, 還請理解 > . <


### 其他疑問?

歡迎前往 [telegram](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ) 參與交流或者直接提起 issue 來砸向我們呀~

@@ -1,4 +1,4 @@
<p align="right">中文 | <a href="../README.md">English</a></p>
<p align="right"> | <a href="../README.md">En</a> | <a href="./README-zh_tw.md">繁</a></p>

<div align="center">

Oops, something went wrong.

0 comments on commit 0b29538

Please sign in to comment.
You can’t perform that action at this time.