docs: update the Getting Started guide in Chinese #3980
Conversation
|
Thanks for your contribution! |
|
BTW, I see there have some lint errors:
Would you like to fix them first? |
|
@juzhiyuan |
|
GitHub commits suggestion is too hard to use.. maybe it doesn't work for many suggestions case |
|
|
||
| ```bash | ||
| curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' | ||
| $ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' |
There was a problem hiding this comment.
Actually I think it would be a good idea to remove all the $, so users could directly use the copy button on the website to get the 'runnable' command. cc @juzhiyuan
Another reason could be, the dollar sign is often used when trying to separate commands and outputs. Since in this doc, we only list the command, so there seems no need to use $
There was a problem hiding this comment.
it's reasonable though I would prefer adding $ 😂 what do you think? @spacewander
There was a problem hiding this comment.
Found some examples:
- Kubernetes: do not have
$(https://kubernetes.io/docs/tutorials/hello-minikube/) - Envoy: have
$but the copy button does not fetch it (https://www.envoyproxy.io/docs/envoy/latest/start/quick-start/run-envoy) - Istio: same with envoy (https://istio.io/latest/docs/setup/getting-started/)
So it seems the copy button could be customized
There was a problem hiding this comment.
😂 wow, that button could omit $
There was a problem hiding this comment.
We can omit the $. $ is not part of the bash script.
spacewander
changed the title
docs/zh/latest/getting-started.md
Outdated
|
|
||
| - 本指南使用 docker 和 docker compose 来安装 Apache APISIX。 但是， 如果您已经以其他方式安装了 Apache APISIX ，您只需跳到 [第二步](getting-started.md#第二步:-在-APISIX-中设置路由) 。 | ||
| - Curl：指南使用 Curl 命令进行 API 测试，但是您也可以使用您选择的任何其他工具（ 例如 Postman ）。 | ||
| > 如果您已经安装了 Apache APISIX，请直接阅读[第二步](#step-2-create-a-route) |
There was a problem hiding this comment.
We should change the anchor?
docs/zh/latest/getting-started.md
Outdated
| ``` | ||
|
|
||
| - Upstream 信息： | ||
| 这条路由配置是指：当入站请求满足下述规则时，请求将被转发到 `httpbin.org:80` 上游： |
docs/zh/latest/getting-started.md
Outdated
| "uri": "/samplePrefix/get", | ||
| "plugins": { | ||
| "proxy-rewrite": { | ||
| "scheme": "https", |
Co-authored-by: 琚致远 <juzhiyuan@apache.org>
4 participants
What this PR does / why we need it:
improve Getting Started in Chinese
Pre-submission checklist: