-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
docs: update CN and EN getting-started documents #4546
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Chinese LGTM, and do we need to update the English version in the same PR?
cc @spacewander
Yeah sure. |
Yes, change EN doc at the same time can avoid content mismatch. |
OK, will deliver. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's not appropriate to call it "后端服务" since there is no "前端". Maybe call it "上游" is more accurate
Ok, I will fix them in both languages. |
@Yiyiyimu @spacewander @juzhiyuan @tao12345666333 guys, please kindly give me some review opinions/comments on English 'Getting Started' document when you are available, thanks! |
If we decide to use the term "上游",then we may use it everywhere of our documentations. By the way, a glossary might be required. |
Yes, this PR uses "Upstream" everywhere in 'Getting-Started' document, except 2-3ish places where it needs to explain what is an "Upstream", or give a synonym of "Upstream". The current situation is that "Upstream", "后端服务" and other words are referencing to the same thing with different names (Maybe they do have some tiny differences after all). Thus, it creates confusion for me to read, identify and understand this document. This then brings up more abstracted problems:
Hope this clarifies your concerns. |
Hi, AFAIK, Upstream is used in Apache APISIX (as an Entity) and Kong (as an Upstream Object), it's more technical but not easy to understand, as a Getting Started guide, Backend Server/Target Node would be more clear and easy to know what it is. Maybe we could have a table including some description for internal words? |
what do you think? @KishaniKandasamy @iamayushdas |
Table is a good option but what do you think , where will you be placing that table, IMO we could place them in "general" |
Hi I think the reason we call it "upstream" is mainly because nginx is calling it this way |
Cool, good to know that. It seems like a good choice to follow their pattern. |
Yes It is a much better way to understand internal words |
Hi all, after this morning's discussion, we decided to use the term "Upstream service" and "上游服务" in our documents. PR is ready for review,. |
What this PR does / why we need it:
This change fixes the problems on 'getting-started' page both in Chinese and in English:
Pre-submission checklist: