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: remove the make install in how to build Apache APISIX doc #6559

Closed
guoqqqi opened this issue Mar 9, 2022 · 8 comments · Fixed by #6627
Closed

docs: remove the make install in how to build Apache APISIX doc #6559

guoqqqi opened this issue Mar 9, 2022 · 8 comments · Fixed by #6627
Labels
doc Documentation things

Comments

@guoqqqi
Copy link
Member

guoqqqi commented Mar 9, 2022

Improved or typo fixed.

image

Since make install is not an installation dependency and may cause some misunderstanding to the user, we should add some extra comments to it or remove make install

Solution

remove the make install or add some extra notes such as: Install the apisix (only for luarocks)

Any better suggestions?

@guoqqqi guoqqqi added the doc Documentation things label Mar 9, 2022
@juzhiyuan
Copy link
Member

juzhiyuan commented Mar 9, 2022

Could you please describe the reason why we need to remove this? and what misunderstanding? 🤗

@guitu168
Copy link
Contributor

guitu168 commented Mar 9, 2022

I think we should add some extra comments to it, because someone needs it.

@tzssangglass
Copy link
Member

The original discussion is here: #5136 (comment)

Maybe we still need to remove the make install cc @spacewander

@moonming
Copy link
Member

moonming commented Mar 10, 2022

Is make install a misleading name? How about changing to make luarocks-init?
In fact, Apache APISIX does not need to install after downloading the source code, it can be run directly after make deps.

@guoqqqi
Copy link
Member Author

guoqqqi commented Mar 10, 2022

How about changing to make luarocks-init?
Apache APISIX does not need to install after downloading the source code, it can be run directly after make deps.

+1 If changing the command would be tricky, We can start by adding some comments to it.

@spacewander
Copy link
Member

Yes. Since the make install is designed by luarocks, would be better to create a new name.

@bin-ya
Copy link
Contributor

bin-ya commented Mar 11, 2022

Remove make install or change the comment to Install the apisix (only for luarocks)?

@tzssangglass
Copy link
Member

I think it would be better to remove make install (in that context).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants