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

docs: update CN and EN how-to-build document #4577

Merged
merged 2 commits into from
Jul 14, 2021

Conversation

yzeng25
Copy link
Contributor

@yzeng25 yzeng25 commented Jul 9, 2021

What this PR does / why we need it:

This PR provides updates on the 'how-to-build' document in Chinese and English:

  1. Changed the order of installation methods listed in ”2. 安装 Apache APISIX“, because the order was not the same as what were listed in the description, it should be in this order: 1. "通过源码包安装" --> 2. "通过RPM 包安装" --> 3. "通过Docker安装"--> 4. "通过Helm Chart安装". In addition, it seems like the other method "Luarocks" is missing.
  2. Refactored steps in"通过源码包安装", the steps were blended in two code blocks, they could be split to 5 steps and be clearer.
  3. Wrapped up hyperlinks for Docker installation ("通过 Docker 安装") and Helm Chart installation sections(("通过 Helm Chart 安装") for better user experience.
  4. Refactored "管理(启动、关闭等)APISIX 服务". Described the difference between make quit and make stop, and suggested to use make quit rather than make stop.
  5. Replaced 'APISIX' with 'Apache APISIX'.
  6. Fixed a spacing problem and in-page jumping problem introduced in previous PR docs: update CN and EN getting-started documents #4546, related issue: docs: in-page jumping failed on CN and EN getting-started page #4554.
  7. Other minor mistakes fixes: removals of $ sign in the beginning of each code block, changes of '```shell' in the beginning of each code block.

TODO:

  1. Update CN how-to-build document based on review comments. (Done)
  2. Update EN how-to-build document based CN how-to-build document. (Done)
  3. Update EN how-to-build document based on review comments again. (Done)

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@yzeng25 yzeng25 marked this pull request as ready for review July 9, 2021 08:08
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Show resolved Hide resolved
docs/zh/latest/how-to-build.md Show resolved Hide resolved
@juzhiyuan juzhiyuan requested a review from tao12345666333 July 12, 2021 02:54
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
@yzeng25 yzeng25 force-pushed the 0708_01 branch 2 times, most recently from 2e216b8 to 6be2875 Compare July 12, 2021 04:46
@yzeng25 yzeng25 requested review from juzhiyuan and Yiyiyimu July 12, 2021 06:09
@juzhiyuan
Copy link
Member

👍

docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
@yzeng25 yzeng25 requested a review from tao12345666333 July 13, 2021 06:37
Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

Approved.

left one comment.

docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
@yzeng25 yzeng25 marked this pull request as draft July 13, 2021 08:31
@yzeng25
Copy link
Contributor Author

yzeng25 commented Jul 13, 2021

I will convert it back once EN document is ready. Thanks guys!

@yzeng25 yzeng25 marked this pull request as ready for review July 13, 2021 09:42
@yzeng25 yzeng25 changed the title docs: update CN how-to-build document docs: update CN and EN how-to-build document Jul 13, 2021
@yzeng25
Copy link
Contributor Author

yzeng25 commented Jul 13, 2021

PR is ready for re-review.

docs/zh/latest/how-to-build.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants