Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Manual.md #433

Merged
merged 3 commits into from
Oct 30, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1097,7 +1097,7 @@ Support SMS notification with multiple SMS service providers

- [Twilio](https://www.twilio.com/sms)
- [Vonage(Nexmo)](https://developer.vonage.com/messaging/sms/overview)
- [YunPian](https://www.yunpian.com/doc/en/domestic/list.html)
- [YunPian](https://www.yunpian.com/official/document/sms/en/domestic_list)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for you contribution. I think it would be better to put both English and Chinese doc here. Could you please add it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, but I think it's not that necessary.

According to YunPian's doc website, it renders default in Chinese. If we want an English version, we can add a 'lang=en' pramameter in the url or hover the LANGUAGE DROPDOWN LIST at the top-right screen and select the language we want.

https://www.yunpian.com/official/document/sms/en/domestic_list?lang=en

Just like the above links of Twilio and Vonage, they render default in English and could be changed by selecting the specific language at the top-right screen too.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then maybe use english version of doc?

The Manual.md is written in english. So I am afraid this Chinese doc may be confused for some users who don't know about Chinese. Consider you open a website, and it is written all by Finnish language, it actually hard for you to find the position to switch language back to Chinese.

Since YunPian provides english doc, and this manual is written in english. I think maybe the english version of doc is a little bit better here. https://www.yunpian.com/doc/en/domestic/list.html the previous link is english version too.
I am sure Chinese users who can read this manual can also read the english version of doc. I believe in long term, link english version of doc may bring some foreign users for YunPian too!

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got you, will update it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also updated the link in README.md this time. @suchen-sci


The plugin supports the following parameters:
- `name`: A unique name for this notification endpoint
Expand Down