Skip to content

Commit

Permalink
docs:README.md and upgrade.md (ali-sdk#532)
Browse files Browse the repository at this point in the history
* chore: modify issue_template

* chore: add english description for issue_template

* docs: repair UPGRADING.md

* docs: add lower browers solution link
  • Loading branch information
luozhang002 authored and binghaiwang committed Oct 19, 2018
1 parent f9d7e28 commit 9e46894
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
Thank you for reporting an issue.
1. It's RECOMMENDED to submit PR for typo or tiny bug fix.
3. If this's a BUG, please provide: course repetition, network error log and configuration. Fill in as much of the template below as you're able.
4. It will be nice to use example project to provide a mini GitHub repository which can reproduce the issue.
2. If this's a BUG, please provide: course repetition, network error log and configuration. Fill in as much of the template below as you're able.
3. It will be nice to use example project to provide a mini GitHub repository which can reproduce the issue.
4. please try user newest ali-oss version.
感谢您向我们反馈问题。
1. 我们推荐如果是小问题(错别字修改,小的 bug fix)直接提交 PR。
2. 如果是一个 BUG,请提供:复现步骤,错误请求和响应日志以及相关配置,并尽量填写下面的模板中的条目(请网络响应中x-oss-request-id字段值)。
5. 如果可以,请使用项目中 example工程提供一个最小可复现的代码仓库,方便我们排查问题。
6. 扩展阅读:[如何向开源项目提交无法解答的问题](https://zhuanlan.zhihu.com/p/25795393)
3. 如果可以,请使用项目中 example工程提供一个最小可复现的代码仓库,方便我们排查问题。
4. 尽量使用最新版本的SDK方便我们维护跟踪
5. 扩展阅读:[如何向开源项目提交无法解答的问题](https://zhuanlan.zhihu.com/p/25795393)
-->

* **Browser Version or Node Version**:
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Node.js >= 8.0.0 required. You can use 4.x in Node.js < 8.
- Major versions of Chrome/Firefox/Safari
- Major versions of Android/iOS/WP

`Note`: For Lower browsers you can refer to [PostObject](https://help.aliyun.com/document_detail/31988.html), if you want to see more practices ,please refer to [Web Post](https://help.aliyun.com/document_detail/31923.html)

## License

[MIT](LICENSE)
Expand Down
6 changes: 3 additions & 3 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

# Upgrading Notes (5.x to 6.x)

No matter how it changes, our api name will never change. In order to give developers a better experience, we just change the way that the client use.the This document captures breaking changes from 5.x versions to the first
No matter how it changes, the api will never change. In order to give developers a better experience, we just change the way that the client use. This document captures breaking changes from 5.x versions to the first
stable 6.x (non-RC) release of the Aliyun SDK for JavaScript.

## 1. Remove Region Param fo All Bucket Operations
## 1. Remove Region Param for All Bucket Operations

For all the bucket operation ,including putBucket、deleteBucket、getBucketInfo、 getBucketLoaction、
putBucketACL、gitBucketACL、 putBucketLogging、 getBucketLogging、 deleteBucketLogging、 putBucketWebsite、
Expand Down Expand Up @@ -39,7 +39,7 @@ it can optimize our code to maintain and provide with a better development exper

## 3. Dropped `OSS.Wrapper` When Init Client

Before in async opearion we use `OSS.Wrapper` ,but now we just use `new OSS()` ,it will return Promise like `OSS.Wrapper`,please remmove `Wrapper`.
Before in async opearion we use `OSS.Wrapper` ,but now we just use `new OSS()` ,it will return Promise like `OSS.Wrapper`,please remove `Wrapper`.

Upgrading example

Expand Down

0 comments on commit 9e46894

Please sign in to comment.