improved docs (#164)

README-CN.md

@@ -30,7 +30,7 @@ Alibaba Cloud Client for PHP 是帮助 PHP 开发者管理凭据、发送请求
 
 
 ## 先决条件
-您的系统需要满足[先决条件](docs/0-Prerequisites-CN.md)，包括 PHP> = 5.5。 我们强烈建议使用cURL扩展，并使用TLS后端编译cURL 7.16.2+。
+您的系统需要满足[先决条件](docs/zh/0-Prerequisites.md)，包括 PHP> = 5.5。 我们强烈建议使用cURL扩展，并使用TLS后端编译cURL 7.16.2+。
 
 
 ## 安装依赖
@@ -40,7 +40,7 @@ composer require alibabacloud/client
 ```
 > 一些用户可能由于网络问题无法安装，可以尝试切换 Composer 镜像地址。
 
-请看 [安装](docs/1-Installation-CN.md) 有关通过 Composer 和其他方式安装的详细信息。
+请看[安装](docs/zh/1-Installation.md)有关通过 Composer 和其他方式安装的详细信息。
 
 
 ## 快速使用
@@ -113,17 +113,17 @@ try {
 
 
 ## 文档
-* [先决条件](docs/0-Prerequisites-CN.md)
-* [安装](docs/1-Installation-CN.md)
-* [客户端](docs/2-Client-CN.md)
-* [请求](docs/3-Request-CN.md)
-* [结果](docs/4-Result-CN.md)
-* [区域](docs/5-Region-CN.md)
-* [域名](docs/6-Host-CN.md)
-* [SSL 验证](docs/7-Verify-CN.md)
-* [调试](docs/8-Debug-CN.md)
-* [日志](docs/9-Log-CN.md)
-* [测试](docs/10-Test-CN.md)
+* [先决条件](docs/zh/0-Prerequisites.md)
+* [安装](docs/zh/1-Installation.md)
+* [客户端](docs/zh/2-Client.md)
+* [请求](docs/zh/3-Request.md)
+* [结果](docs/zh/4-Result.md)
+* [区域](docs/zh/5-Region.md)
+* [域名](docs/zh/6-Host.md)
+* [SSL 验证](docs/zh/7-Verify.md)
+* [调试](docs/zh/8-Debug.md)
+* [日志](docs/zh/9-Log.md)
+* [测试](docs/zh/10-Test.md)
 
 
 ## 问题

README.md

@@ -30,7 +30,7 @@ Alibaba Cloud Client for PHP is a client tool that helps PHP developers manage c
 
 
 ## Prerequisites
-Your system will need to meet the [Prerequisites](docs/0-Prerequisites-EN.md), including having PHP >= 5.5. We highly recommend having it compiled with the cURL extension and cURL 7.16.2+.
+Your system will need to meet the [Prerequisites](docs/en/0-Prerequisites.md), including having PHP >= 5.5. We highly recommend having it compiled with the cURL extension and cURL 7.16.2+.
 
 
 ## Installation
@@ -40,7 +40,7 @@ composer require alibabacloud/client
 ```
 > Some users may not be able to install due to network problems, you can try to switch the Composer mirror.
 
-Please see the [Installation](docs/1-Installation-EN.md) for more detailed information about installing the Alibaba Cloud Client for PHP through Composer and other means.
+Please see the [Installation](docs/en/1-Installation.md) for more detailed information about installing the Alibaba Cloud Client for PHP through Composer and other means.
 
 
 ## Quick Examples
@@ -113,17 +113,17 @@ try {
 
 
 ## Documentation
-* [Prerequisites](docs/0-Prerequisites-EN.md)
-* [Installation](docs/1-Installation-EN.md)
-* [Client](docs/2-Client-EN.md)
-* [Request](docs/3-Request-EN.md)
-* [Result](docs/4-Result-EN.md)
-* [Region](docs/5-Region-EN.md)
-* [Host](docs/6-Host-EN.md)
-* [SSL Verify](docs/7-Verify-EN.md)
-* [Debug](docs/8-Debug-EN.md)
-* [Log](docs/9-Log-EN.md)
-* [Test](docs/10-Test-EN.md)
+* [Prerequisites](docs/en/0-Prerequisites.md)
+* [Installation](docs/en/1-Installation.md)
+* [Client](docs/en/2-Client.md)
+* [Request](docs/en/3-Request.md)
+* [Result](docs/en/4-Result.md)
+* [Region](docs/en/5-Region.md)
+* [Host](docs/en/6-Host.md)
+* [SSL Verify](docs/en/7-Verify.md)
+* [Debug](docs/en/8-Debug.md)
+* [Log](docs/en/9-Log.md)
+* [Test](docs/en/10-Test.md)
 
 
 ## Issues

docs/0-Prerequisites-EN.md → docs/en/0-Prerequisites.md

@@ -1,4 +1,4 @@
-[← Home](../README.md) | Prerequisites[(中文)](0-Prerequisites-CN.md) | [Installation →](1-Installation-EN.md)
+[← Home](../../README.md) | Prerequisites[(中文)](../zh/0-Prerequisites.md) | [Installation →](1-Installation.md)
 ***
 
 # Requirements and Recommendations
@@ -16,7 +16,7 @@ Before using the Alibaba Cloud Client for PHP, please ensure your environment su
 - In a production environment, do not use [Xdebug][xdebug]
 
 ***
-[← Home](../README.md) | Prerequisites[(中文)](0-Prerequisites-CN.md) | [Installation →](1-Installation-EN.md)
+[← Home](../../README.md) | Prerequisites[(中文)](../zh/0-Prerequisites.md) | [Installation →](1-Installation.md)
 
 [composer]: https://getcomposer.org
 [cURL]: http://php.net/manual/en/book.curl.php

docs/1-Installation-EN.md → docs/en/1-Installation.md

@@ -1,4 +1,4 @@
-[← Prerequisites](0-Prerequisites-EN.md) | Installation[(中文)](1-Installation-CN.md) | [Client →](2-Client-EN.md)
+[← Prerequisites](0-Prerequisites.md) | Installation[(中文)](../zh/1-Installation.md) | [Client →](2-Client.md)
 ***
 
 # Installation
@@ -7,7 +7,7 @@ There are ways to install Alibaba Cloud Client for PHP:
 - [As a dependency via Composer](#as-a-dependency-via-composer)
 - [Installing by Using the ZIP file](#installing-by-using-the-zip-file)
 
-Before you install ensure your environment is using PHP version 5.5 or later. Learn more about [environment requirements and recommendations](0-Prerequisites-EN.md).
+Before you install ensure your environment is using PHP version 5.5 or later. Learn more about [environment requirements and recommendations](0-Prerequisites.md).
 
 ## As a dependency via Composer
 Composer is the recommended way to install. Composer is a tool for PHP that manages and installs the dependencies of your project. For more information on how to install Composer, configure autoloading, and follow other best practices for defining dependencies, see [getcomposer.org](https://getcomposer.org).
@@ -50,4 +50,4 @@ require __DIR__ . '/vendor/autoload.php';
 ```
 
 ***
-[← Prerequisites](0-Prerequisites-EN.md) | Installation[(中文)](1-Installation-CN.md) | [Client →](2-Client-EN.md)
+[← Prerequisites](0-Prerequisites.md) | Installation[(中文)](../zh/1-Installation.md) | [Client →](2-Client.md)

docs/10-Test-EN.md → docs/en/10-Test.md

@@ -1,4 +1,4 @@
-[← Log](9-Log-EN.md) | Test[(中文)](10-Test-CN.md) | [Home →](../README.md)
+[← Log](9-Log.md) | Test[(中文)](../zh/10-Test.md) | [Home →](../../README.md)
 ***
 
 # Test
@@ -67,4 +67,4 @@ AlibabaCloud::cancelMock();
 ```
 
 ***
-[← Log](9-Log-EN.md) | Test[(中文)](10-Test-CN.md) | [Home →](../README.md)
+[← Log](9-Log.md) | Test[(中文)](../zh/10-Test.md) | [Home →](../../README.md)

docs/2-Client-EN.md → docs/en/2-Client.md

@@ -1,4 +1,4 @@
-[← Installation](1-Installation-EN.md) | Client[(中文)](2-Client-CN.md) | [Request →](3-Request-EN.md)
+[← Installation](1-Installation.md) | Client[(中文)](../zh/2-Client.md) | [Request →](3-Request.md)
 ***
 
 # Client
@@ -213,7 +213,7 @@ AlibabaCloud::get('client1')->getSessionCredential();
 ```
 
 ***
-[← Installation](1-Installation-EN.md) | Client[(中文)](2-Client-CN.md) | [Request →](3-Request-EN.md)
+[← Installation](1-Installation.md) | Client[(中文)](../zh/2-Client.md) | [Request →](3-Request.md)
 
 [ak]: https://usercenter.console.aliyun.com/#/manage/ak
 [ram]: https://ram.console.aliyun.com/users

docs/3-Request-EN.md → docs/en/3-Request.md

@@ -1,4 +1,4 @@
-[← Client](2-Client-EN.md) | Request[(中文)](3-Request-CN.md) | [Result →](4-Result-EN.md)
+[← Client](2-Client.md) | Request[(中文)](../zh/3-Request.md) | [Result →](4-Result.md)
 ***
 
 # Request
@@ -180,7 +180,7 @@ AlibabaCloud::rpc()
 
 
 ***
-[← Client](2-Client-EN.md) | Request[(中文)](3-Request-CN.md) | [Result →](4-Result-EN.md)
+[← Client](2-Client.md) | Request[(中文)](../zh/3-Request.md) | [Result →](4-Result.md)
 
 [SDK]: https://github.com/aliyun/openapi-sdk-php
 [guzzle-docs]: http://docs.guzzlephp.org/en/stable/request-options.html

docs/4-Result-EN.md → docs/en/4-Result.md

@@ -1,4 +1,4 @@
-[← Request](3-Request-EN.md) | Result[(中文)](4-Result-CN.md) | [Region →](5-Region-EN.md)
+[← Request](3-Request.md) | Result[(中文)](../zh/4-Result.md) | [Region →](5-Region.md)
 ***
 
 # Result
@@ -52,4 +52,4 @@ $result->getRequest();
 ```
 
 ***
-[← Request](3-Request-EN.md) | Result[(中文)](4-Result-CN.md) | [Region →](5-Region-EN.md)
+[← Request](3-Request.md) | Result[(中文)](../zh/4-Result.md) | [Region →](5-Region.md)

docs/5-Region-EN.md → docs/en/5-Region.md

@@ -1,4 +1,4 @@
-[← Result](4-Result-EN.md) | Region[(中文)](5-Region-CN.md) | [Host →](6-Host-EN.md)
+[← Result](4-Result.md) | Region[(中文)](../zh/5-Region.md) | [Host →](6-Host.md)
 ***
 
 # Region
@@ -48,6 +48,6 @@ AlibabaCloud::getDefaultRegionId();
 ```
 
 ***
-[← Result](4-Result-EN.md) | Region[(中文)](5-Region-CN.md) | [Host →](6-Host-EN.md)
+[← Result](4-Result.md) | Region[(中文)](../zh/5-Region.md) | [Host →](6-Host.md)
 
 [regions]: https://www.alibabacloud.com/help/doc-detail/40654.html

docs/6-Host-EN.md → docs/en/6-Host.md

@@ -1,4 +1,4 @@
-[← Region](5-Region-EN.md) | Host[(中文)](6-Host-CN.md) | [SSL Verify →](7-Verify-EN.md)
+[← Region](5-Region.md) | Host[(中文)](../zh/6-Host.md) | [SSL Verify →](7-Verify.md)
 ***
 
 # Host
@@ -35,6 +35,6 @@ AlibabaCloud::addHost('product', 'product.aliyuncs.com');
 ```
 
 ***
-[← Region](5-Region-EN.md) | Host[(中文)](6-Host-CN.md) | [SSL Verify →](7-Verify-EN.md)
+[← Region](5-Region.md) | Host[(中文)](../zh/6-Host.md) | [SSL Verify →](7-Verify.md)
 
 [endpoints]: https://developer.aliyun.com/endpoints

docs/7-Verify-EN.md → docs/en/7-Verify.md

@@ -1,4 +1,4 @@
-[← Host](6-Host-EN.md) | SSL Verify[(中文)](7-Verify-CN.md) | [Debug →](8-Debug-EN.md)
+[← Host](6-Host.md) | SSL Verify[(中文)](../zh/7-Verify.md) | [Debug →](8-Debug.md)
 ***
 
 # SSL Verify
@@ -65,4 +65,4 @@ AlibabaCloud::accessKeyClient('foo', 'bar')
 
 
 ***
-[← Host](6-Host-EN.md) | SSL Verify[(中文)](7-Verify-CN.md) | [Debug →](8-Debug-EN.md)
+[← Host](6-Host.md) | SSL Verify[(中文)](../zh/7-Verify.md) | [Debug →](8-Debug.md)

docs/en/8-Debug.md

@@ -0,0 +1,8 @@
+[← SSL Verify](7-Verify.md) | Debug[(中文)](../zh/8-Debug.md) | [Log →](9-Log.md)
+***
+
+# Debugging
+If there is an environment variable `DEBUG=sdk` , all requests will enable debug mode.
+
+***
+[← SSL Verify](7-Verify.md) | Debug[(中文)](../zh/8-Debug.md) | [Log →](9-Log.md)

docs/9-Log-EN.md → docs/en/9-Log.md

@@ -1,4 +1,4 @@
-[← Debug](8-Debug-EN.md) | Log[(中文)](9-Log-CN.md) | [Test →](10-Test-EN.md)
+[← Debug](8-Debug.md) | Log[(中文)](../zh/9-Log.md) | [Test →](10-Test.md)
 ***
 
 # Log
@@ -68,4 +68,4 @@ The following variable substitutions are supported:
 | {start_time}     | Start Time |
 
 ***
-[← Debug](8-Debug-EN.md) | Log[(中文)](9-Log-CN.md) | [Test →](10-Test-EN.md)
+[← Debug](8-Debug.md) | Log[(中文)](../zh/9-Log.md) | [Test →](10-Test.md)

docs/0-Prerequisites-CN.md → docs/zh/0-Prerequisites.md

@@ -1,4 +1,4 @@
-[← 首页](../README-CN.md) | 先决条件[(English)](0-Prerequisites-EN.md) | [安装 →](1-Installation-CN.md)
+[← 首页](../../README-CN.md) | 先决条件[(English)](../en/0-Prerequisites.md) | [安装 →](1-Installation.md)
 ***
 
 # 要求和建议
@@ -16,7 +16,7 @@
 - 生产环境中不要使用 [Xdebug][xdebug]
 
 ***
-[← 首页](../README-CN.md) | 先决条件[(English)](0-Prerequisites-EN.md) | [安装 →](1-Installation-CN.md)
+[← 首页](../../README-CN.md) | 先决条件[(English)](../en/0-Prerequisites.md) | [安装 →](1-Installation.md)
 
 [composer]: https://getcomposer.org
 [cURL]: http://php.net/manual/zh/book.curl.php

docs/1-Installation-CN.md → docs/zh/1-Installation.md

@@ -1,4 +1,4 @@
-[← 先决条件](0-Prerequisites-CN.md) | 安装[(English)](1-Installation-EN.md) | [客户端 →](2-Client-CN.md)
+[← 先决条件](0-Prerequisites.md) | 安装[(English)](../en/1-Installation.md) | [客户端 →](2-Client.md)
 ***
 
 # 安装
@@ -7,7 +7,7 @@
 - [通过 Composer 安装依赖](#%E9%80%9A%E8%BF%87-composer-%E5%AE%89%E8%A3%85%E4%BE%9D%E8%B5%96)
 - [下载使用 ZIP 文件](#%E4%B8%8B%E8%BD%BD%E4%BD%BF%E7%94%A8-zip-%E6%96%87%E4%BB%B6)
 
-在安装之前，请确保您的环境使用的是 PHP 5.5 或更高版本。了解有关[环境要求和建议的更多信息](0-Prerequisites-CN.md)。
+在安装之前，请确保您的环境使用的是 PHP 5.5 或更高版本。了解有关[环境要求和建议的更多信息](0-Prerequisites.md)。
 
 ## 通过 Composer 安装依赖
 通过 Composer 安装是推荐方式。Composer 是一款 PHP 工具，用于管理和安装项目的依赖项。有关如何安装 Composer、配置自动加载并遵循定义依赖关系的其他最佳实践的更多信息，请参阅 [getcomposer.org](https://getcomposer.org)。
@@ -50,4 +50,4 @@ require __DIR__ . '/vendor/autoload.php';
 ```
 
 ***
-[← 先决条件](0-Prerequisites-CN.md)  | 安装[(English)](1-Installation-EN.md) | [客户端 →](2-Client-CN.md)
+[← 先决条件](0-Prerequisites.md)  | 安装[(English)](../en/1-Installation.md) | [客户端 →](2-Client.md)

docs/10-Test-CN.md → docs/zh/10-Test.md

@@ -1,4 +1,4 @@
-[← 日志](9-Log-CN.md) | 测试[(English)](10-Test-EN.md) | [首页 →](../README-CN.md)
+[← 日志](9-Log.md) | 测试[(English)](../en/10-Test.md) | [首页 →](../../README-CN.md)
 ***
 
 # 测试
@@ -68,4 +68,4 @@ AlibabaCloud::cancelMock();
 
 
 ***
-[← 日志](9-Log-CN.md) | 测试[(English)](10-Test-EN.md) | [首页 →](../README-CN.md)
+[← 日志](9-Log.md) | 测试[(English)](../en/10-Test.md) | [首页 →](../../README-CN.md)

docs/2-Client-CN.md → docs/zh/2-Client.md

@@ -1,4 +1,4 @@
-[← 安装](1-Installation-CN.md) | 客户端[(English)](2-Client-EN.md) | [请求 →](3-Request-CN.md)
+[← 安装](1-Installation.md) | 客户端[(English)](../en/2-Client.md) | [请求 →](3-Request.md)
 ***
 
 # 客户端
@@ -212,7 +212,7 @@ AlibabaCloud::get('client1')->getSessionCredential();
 ```
 
 ***
-[← 安装](1-Installation-CN.md) | 客户端[(English)](2-Client-EN.md) | [请求 →](3-Request-CN.md)
+[← 安装](1-Installation.md) | 客户端[(English)](../en/2-Client.md) | [请求 →](3-Request.md)
 
 [ak]: https://usercenter.console.aliyun.com/#/manage/ak
 [ram]: https://ram.console.aliyun.com/users

docs/3-Request-CN.md → docs/zh/3-Request.md

@@ -1,4 +1,4 @@
-[← 客户端](2-Client-CN.md) | 请求[(English)](3-Request-EN.md) | [结果 →](4-Result-CN.md)
+[← 客户端](2-Client.md) | 请求[(English)](../en/3-Request.md) | [结果 →](4-Result.md)
 ***
 
 # 请求
@@ -179,7 +179,7 @@ AlibabaCloud::rpc()
 ```
 
 ***
-[← 客户端](2-Client-CN.md) | 请求[(English)](3-Request-EN.md) | [结果 →](4-Result-CN.md)
+[← 客户端](2-Client.md) | 请求[(English)](../en/3-Request.md) | [结果 →](4-Result.md)
 
 [SDK]: https://github.com/aliyun/openapi-sdk-php/blob/master/README-CN.md
 [guzzle-docs]: https://guzzle-cn.readthedocs.io/zh_CN/latest/request-options.html

docs/4-Result-CN.md → docs/zh/4-Result.md

@@ -1,4 +1,4 @@
-[← 请求](3-Request-CN.md) | 结果[(English)](4-Result-EN.md) | [区域 →](5-Region-CN.md)
+[← 请求](3-Request.md) | 结果[(English)](../en/4-Result.md) | [区域 →](5-Region.md)
 ***
 
 # 结果
@@ -52,4 +52,4 @@ $result->getRequest();
 ```
 
 ***
-[← 请求](3-Request-CN.md) | 结果[(English)](4-Result-EN.md) | [区域 →](5-Region-CN.md)
+[← 请求](3-Request.md) | 结果[(English)](../en/4-Result.md) | [区域 →](5-Region.md)

docs/5-Region-CN.md → docs/zh/5-Region.md

@@ -1,4 +1,4 @@
-[← 结果](4-Result-CN.md) | 区域[(English)](5-Region-EN.md) | [域名 →](6-Host-CN.md)
+[← 结果](4-Result.md) | 区域[(English)](../en/5-Region.md) | [域名 →](6-Host.md)
 ***
 
 # 区域
@@ -48,6 +48,6 @@ AlibabaCloud::getDefaultRegionId();
 ```
 
 ***
-[← 结果](4-Result-CN.md) | 区域[(English)](5-Region-EN.md) | [域名 →](6-Host-CN.md)
+[← 结果](4-Result.md) | 区域[(English)](../en/5-Region.md) | [域名 →](6-Host.md)
 
 [regions]: https://help.aliyun.com/document_detail/40654.html

docs/6-Host-CN.md → docs/zh/6-Host.md

@@ -1,4 +1,4 @@
-[← 区域](5-Region-CN.md) | 域名[(English)](6-Host-EN.md) | [SSL 验证 →](7-Verify-CN.md)
+[← 区域](5-Region.md) | 域名[(English)](../en/6-Host.md) | [SSL 验证 →](7-Verify.md)
 ***
 
 # 域名
@@ -36,6 +36,6 @@ AlibabaCloud::addHost('product', 'product.aliyuncs.com');
 ```
 
 ***
-[← 区域](5-Region-CN.md) | 域名[(English)](6-Host-EN.md) | [SSL 验证 →](7-Verify-CN.md)
+[← 区域](5-Region.md) | 域名[(English)](../en/6-Host.md) | [SSL 验证 →](7-Verify.md)
 
 [endpoints]: https://developer.aliyun.com/endpoints

docs/7-Verify-CN.md → docs/zh/7-Verify.md

@@ -1,4 +1,4 @@
-[← 域名](6-Host-CN.md) | SSL 验证[(English)](7-Verify-EN.md) | [调试 →](8-Debug-CN.md)
+[← 域名](6-Host.md) | SSL 验证[(English)](../en/7-Verify.md) | [调试 →](8-Debug.md)
 ***
 
 # SSL 验证
@@ -64,4 +64,4 @@ AlibabaCloud::accessKeyClient('foo', 'bar')
 
 
 ***
-[← 域名](6-Host-CN.md) | SSL 验证[(English)](7-Verify-EN.md) | [调试 →](8-Debug-CN.md)
+[← 域名](6-Host.md) | SSL 验证[(English)](../en/7-Verify.md) | [调试 →](8-Debug.md)