-
Notifications
You must be signed in to change notification settings - Fork 525
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
[Proposal]Standardize project output documents and simplify the way of making install #715
Comments
I recommend turning the project into a directory structure like this
what do you think ? @juzhiyuan @justinmclean @membphis @moonming |
We don’t need the build dir, this repo only has source codes
kv <notifications@github.com>于2020年11月7日 周六下午9:29写道:
I recommend turning the project into a directory structure like this
apisix-dashboard
├── .action
├── .github
├── README.md
├── api
│ └── makefile
├── build
│ ├── rpms
│ └── tars
├── dashboard
│ └── makefile
├── docs
└── makefile
1. The root directory only contains:
2. The root directory only contains:
file type desc
README.md file Project Introduction
makefile file The makefile in the root directory standardizes the overall
packaging process, and the makefile in the subproject is called
api dir the logic of manager-api
dashboard dir the logic of dashboard UI
build dir Compilation results, such as a tar package that can be
decompressed and run
1. There are respective makefiles in the api and dashboard, which are
responsible for their respective construction work.
what do you think ? @juzhiyuan <https://github.com/juzhiyuan>
@justinmclean <https://github.com/justinmclean> @membphis
<https://github.com/membphis> @moonming <https://github.com/moonming>
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#715 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AGJZBK4FL5BGRYW4PQOO4GDSOVDTVANCNFSM4TNMVSAQ>
.
--
Thanks,
Ming Wen
Twitter: _WenMing
|
ok, we can create dir |
Do not. Why are installation and build mixed together? |
my mistake , there is no installation, just build. |
Build tar package with Makefile, and the running mode will be described in readme |
Why are there three Makefile? I think one in root dir is enough. |
There are two considerations
|
I just remove the dir |
|
|
|
one $ make help
Makefile rules:
help: Show Makefile rules
deps: Installation dependencies
utils: Installation tools
lint: Lint Lua source code
init: Initialize the runtime environment
run: Start the apisix server
stop: Stop the apisix server
verify: Verify the configuration of apisix server
clean: Remove generated files
reload: Reload the apisix server
install: Install the apisix (only for luarocks)
test: Run the test case
license-check: Check Lua source code for Apache License |
my opinion of root folder:
@gxthrj please pay more attention to the folder of |
there is a questions, We have designed two |
@juzhiyuan please give a suggest for renaming |
We have reached a consensus before that there is only one dockerfile |
I don't want the dashboard and API to be built independently. For users, they can choose only API, or dashboard + API, nothing else. Within a single Dockfile, use parameters as conditions. |
Nop, the Dockerfile under the |
Just like workflows, actions are under the .github directory, just renamed it to
|
@membphis |
for now , the content of |
So why there will have multiple Dockerfile files? This doesn't make sense and it's unacceptable for me! If you want to only build the manager api, just passed some arguments when building the image by using the root dockerfile. Right? @membphis |
Also, as far as know, the dockerfile under the api folder is used to do test, it seems that you don't have enough commuting with chen. |
yes, that is the right way I prefer. |
just see the code of dockerfile, it is for building image |
let us update it. the current way is not good. |
done? |
ping @gxthrj |
I think we can close this issue now, feel free to reopen if have any problems. |
The text was updated successfully, but these errors were encountered: