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.

Sign up for GitHub

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

Jump to bottom

docs: upadate Chinese installation docs #7002

Merged
merged 5 commits into from
May 9, 2022
Merged

docs: upadate Chinese installation docs #7002

merged 5 commits into from
May 9, 2022

Conversation

guitu168
Copy link
Contributor

@guitu168 guitu168 commented May 7, 2022 •
edited
Loading

Description

Updated Chinese installation documentation.
This PR is only responsible for the internationalization and synchronization of English changes from #6964.

Fixes # (issue)

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@juzhiyuan juzhiyuan requested review from Baoyuantop and guoqqqi May 7, 2022 05:15
moonming
moonming requested changes May 7, 2022
View reviewed changes
Copy link
Member

@moonming moonming left a comment

Choose a reason for hiding this comment

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

I think the previous directory structure is correct, according to different installation methods such as docker, RPM, and source code.

moonming
moonming reviewed May 7, 2022
View reviewed changes
Copy link
Member

@moonming moonming left a comment

Choose a reason for hiding this comment

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

the file name is "how to build", which is means build from source code, not how to install.
And I think we can add doc for how to install.

@guitu168
Copy link
Contributor Author

guitu168 commented May 7, 2022

the file name is "how to build", which is means build from source code, not how to install. And I think we can add doc for how to install.

@moonming

  1. The file name of how-to-build has not been changed because it is currently referenced in some documents, so it has not been changed for the time being. I will investigate and solve this problem later.
  2. For the directory structure, it will be better to use the advanced features of Docusaurus to present the way, which allows the user to see the installation method he wants more intuitively.
  3. For the way to build from source. We can probably move it to the GitHub repo as users installing from source would likely be checking on GitHub.
    If you have other suggestions, welcome to discuss.

@juzhiyuan
Copy link
Member

juzhiyuan commented May 7, 2022 •
edited
Loading

the file name is "how to build", which is means build from source code, not how to install. And I think we can add doc for how to install.

@moonming

  1. The file name of how-to-build has not been changed because it is currently referenced in some documents, so it has not been changed for the time being. I will investigate and solve this problem later.
  2. For the directory structure, it will be better to use the advanced features of Docusaurus to present the way, which allows the user to see the installation method he wants more intuitively.
  3. For the way to build from source. We can probably move it to the GitHub repo as users installing from source would likely be checking on GitHub.
    If you have other suggestions, welcome to discuss.

@moonming

  1. The inconsistency between the filename and the sidebar label was a long time ago. This PR is only responsible for the internationalization and synchronization of English changes from docs: update "Installation" guide #6964;
  2. The problem of inconsistency between the file name and the title should be corrected in the new PR. As for the historical link reference problem, @SkyeYoung could help to redirect the client to the document site to solve it. The file name can be modified to installation.md;
  3. Building from source can be explained in a separate document (e.g., README, separate documentation for installation from source, adding a new Tab in current page to provide "How to build from source code").

image

cc @hf400159 @navendu-pottekkat @kwanhur @spacewander @SylviaBABY @yzeng25 @membphis

@moonming
Copy link
Member

moonming commented May 7, 2022

  • For the directory structure, it will be better to use the advanced features of Docusaurus to present the way, which allows the user to see the installation method he wants more intuitively.

You didn't get my point. I mean, the user installs either via docker or via rpm, only one way. Therefore, the first-level directory must be the installation method.

@moonming
Copy link
Member

moonming commented May 7, 2022

  • The inconsistency between the filename and the sidebar label was a long time ago. This PR is only responsible for the internationalization and synchronization of English changes from docs: update "Installation" guide #6964;

please create a issue for this, thx

@moonming
Copy link
Member

moonming commented May 7, 2022

  1. This PR is only responsible for the internationalization and synchronization of English changes from docs: update "Installation" guide #6964;

Got it. @hf400159 please add this desc in this PR, Otherwise others do not know

@moonming
Copy link
Member

moonming commented May 7, 2022

the file name is "how to build", which is means build from source code, not how to install. And I think we can add doc for how to install.

@moonming

  1. The file name of how-to-build has not been changed because it is currently referenced in some documents, so it has not been changed for the time being. I will investigate and solve this problem later.
  2. For the directory structure, it will be better to use the advanced features of Docusaurus to present the way, which allows the user to see the installation method he wants more intuitively.
  3. For the way to build from source. We can probably move it to the GitHub repo as users installing from source would likely be checking on GitHub.
    If you have other suggestions, welcome to discuss.

@moonming

  1. The inconsistency between the filename and the sidebar label was a long time ago. This PR is only responsible for the internationalization and synchronization of English changes from docs: update "Installation" guide #6964;
  2. The problem of inconsistency between the file name and the title should be corrected in the new PR. As for the historical link reference problem, @SkyeYoung could help to redirect the client to the document site to solve it. The file name can be modified to installation.md;
  3. Building from source can be explained in a separate document (e.g., README, separate documentation for installation from source, adding a new Tab in current page to provide "How to build from source code").

image

cc @hf400159 @navendu-pottekkat @kwanhur @spacewander @SylviaBABY @yzeng25 @membphis

image
I mean we don't need to install etcd if install from docker.

@guitu168
Copy link
Contributor Author

guitu168 commented May 7, 2022

@juzhiyuan Since the documentation for building from source has not yet been created, there is no building from source tag added to this documentation. We will update this document later, not now.

@moonming I will modify the content of the document so that the first level directory is the installation method.

@guitu168 guitu168 requested review from moonming and SylviaBABY May 7, 2022 13:50
@moonming
Copy link
Member

moonming commented May 8, 2022

is there a preview link for docs？

@SkyeYoung
Copy link
Member

SkyeYoung commented May 8, 2022 •
edited
Loading

@hf400159 Hi, we can use https://surge.sh/ to publish a preview quickly. 😊 (follow README Guide, build, then use surge publish)

@guitu168
Copy link
Contributor Author

guitu168 commented May 9, 2022

preview
@moonming I have no way to upload to suger because of my network issues. You can take a look at this screenshot.

@moonming
Copy link
Member

moonming commented May 9, 2022

@hf400159 Hi, we can use https://surge.sh/ to publish a preview quickly. 😊 (follow README Guide, build, then use surge publish)

please create issue for this

@spacewander spacewander merged commit d74319c into apache:master May 9, 2022
@guitu168 guitu168 deleted the hfinstallation branch May 9, 2022 08:02
@guitu168
Copy link
Contributor Author

guitu168 commented May 10, 2022 •
edited
Loading

@hf400159 Hi, we can use https://surge.sh/ to publish a preview quickly. 😊 (follow README Guide, build, then use surge publish)

please create issue for this

cc @moonming issue link 1076

Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request May 20, 2022
@guitu168 @Liu-Junlin
docs: upadate Chinese installation docs (apache#7002)
c7f8663
@guitu168 guitu168 mentioned this pull request Jun 17, 2022
Closed
5 tasks
spacewander pushed a commit that referenced this pull request Jun 30, 2022
@guitu168 @spacewander
docs: upadate Chinese installation docs (#7002)
49a9f75
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SylviaBABY SylviaBABY SylviaBABY approved these changes

@yzeng25 yzeng25 yzeng25 approved these changes

@Baoyuantop Baoyuantop Baoyuantop approved these changes

@moonming moonming moonming approved these changes

@guoqqqi guoqqqi Awaiting requested review from guoqqqi

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@guitu168 @juzhiyuan @moonming @SkyeYoung @Baoyuantop @yzeng25 @SylviaBABY @spacewander