slow-groovin commented on code in PR #12242: URL: https://github.com/apache/apisix/pull/12242#discussion_r2110886795
########## docs/en/latest/plugin-develop.md: ########## @@ -24,84 +24,58 @@ title: Plugin Develop This documentation is about developing plugin in Lua. For other languages, see [external plugin](./external-plugin.md). -## where to put your plugins +## Where to put your plugins -There are two ways to add new features based on APISIX. +Setup the `extra_lua_path` in `conf/config.yaml` to load your own code (or `extra_lua_cpath` for compiled .so or .dll file). -1. modify the source of APISIX and redistribute it (not so recommended) -1. setup the `extra_lua_path` and `extra_lua_cpath` in `conf/config.yaml` to load your own code. Your own code will be loaded instead of the builtin one with the same name, so you can use this way to override the builtin behavior if needed. +For example, you can create a directory `/path/to/example`: -For example, you can create a directory structure like this: +```yaml +apisix: + ... + extra_lua_path: "/path/to/example/?.lua" +``` + +The structure of the `example` directory should look like this: ``` ├── example -│ └── apisix -│ ├── plugins -│ │ └── 3rd-party.lua -│ └── stream Review Comment: I know nothing about the stream folder, please revise this section yourself. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
