@@ -62,7 +62,9 @@ starting point. It contains the proper file structures, configuration files,
6262and CI setup to get up and running quickly. This repository seamlessly
6363integrates with [ Pongo] ( https://github.com/Kong/kong-pongo ) .
6464
65- ## Build and Install from source
65+ ## General guide for development
66+
67+ ### Prepare development dependencies and build from source
6668
6769This is the hard way to build a development environment, and also a good start
6870for beginners to understand how everything fits together.
@@ -72,7 +74,7 @@ requires some additional third-party dependencies, some of which are compiled
7274with tweaked options, and kong runs on a modified version of OpenResty with
7375patches.
7476
75- To install from the source, first, we clone the repository:
77+ To build from the source, first, we clone the repository:
7678
7779``` shell
7880git clone https://github.com/Kong/kong
@@ -180,8 +182,8 @@ git config --local url.'ssh://
[email protected] /'.insteadOf 'https://github.com/'
180182Finally, we start the build process:
181183
182184```
183- # Setup virtual environment, download dependencies and install Kong from source
184- make install
185+ # Setup virtual environment, download dependencies and build Kong from source
186+ make dev
185187```
186188
187189[ The build guide] ( https://github.com/Kong/kong/blob/master/build/README.md ) contains a troubleshooting section if
@@ -219,8 +221,6 @@ kong stop
219221deactivate
220222```
221223
222- ### Install Development Dependencies
223-
224224#### Running for development
225225
226226By default, the development environment adds current directory to Lua files search path.
@@ -230,17 +230,14 @@ and [`lua_package_cpath`](https://github.com/openresty/lua-nginx-module#lua_pack
230230directives will allow Kong to find your custom plugin's source code wherever it
231231might be in your system.
232232
233- #### Tests
233+ ### Tests
234234
235- Install the development dependencies ([ busted] ( https://lunarmodules.github.io/busted/ ) ,
236- [ luacheck] ( https://github.com/mpeterv/luacheck ) ) with:
235+ Before running any tests, please ensure the development dependencies are installed via
237236
238237``` shell
239238make dev
240239```
241240
242- If Rust/Cargo doesn't work, try setting ` export KONG_TEST_USER_CARGO_DISABLED=1 ` first.
243-
244241Kong relies on three test suites using the [ busted] ( https://lunarmodules.github.io/busted/ ) testing library:
245242
246243* Unit tests
@@ -355,7 +352,7 @@ are available in both versions (i.e. from helpers.lua). The module
355352the new version into the container of the old version and it can be
356353used to make new library functionality available to migration tests.
357354
358- #### Makefile
355+ ### Makefile
359356
360357When developing, you can use the ` Makefile ` for doing the following operations:
361358
0 commit comments