[incubator-apisix] branch master updated: doc: added additional information and refactoring sentences. (#1078)

[me...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

membphis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 5736a03  doc: added additional information and refactoring sentences. (#1078)
5736a03 is described below

commit 5736a0327220ca1bbbb7fadc9a18cff33dfb7cbe
Author: Nirojan Selvanathan <ss...@gmail.com>
AuthorDate: Sat Jan 18 19:04:23 2020 +0530

    doc: added additional information and refactoring sentences. (#1078)
---
 doc/plugin-develop.md | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)

diff --git a/doc/plugin-develop.md b/doc/plugin-develop.md
index 72f7816..fc22f50 100644
--- a/doc/plugin-develop.md
+++ b/doc/plugin-develop.md
@@ -121,7 +121,7 @@ at its schema description :
    }
 ```
 
-at the same time, we need to implement the __check_schema(conf)__ method to complete the specification verification .
+At the same time, we need to implement the __check_schema(conf)__ method to complete the specification verification .
 
 ```lua
    function _M.check_schema(conf)
@@ -134,21 +134,29 @@ verification .
 
 ## choose phase to run
 
-determine which phase to run , generally access or rewrite . if you don't know the Openresty life cycle , it's
-recommended to know it in advance . key-auth is an authentication plugin , as long as the authentication is completed
-before the business response after the request comes in . The plugin can be executed in the rewrite and access phases ,
-in the project, the authentication logic is implemented in the rewrite phase . Generally, IP access and interface
+Determine which phase to run , generally access or rewrite . If you don't know the [Openresty life cycle](https://openresty-reference.readthedocs.io/en/latest/Directives/) , it's
+recommended to know it in advance . For example key-auth is an authentication plugin , thus the authentication should be completed
+before forwarding the request to any upstream service. Therefore, the plugin can be executed in the rewrite and access phases.
+In APISIX, the authentication logic is implemented in the rewrite phase . Generally, IP access and interface
 permission are completed in the access phase .
 
+The following code snippet shows how to implement any logic relevant to the plugin in the Openresty log phase.
+
+```lua
+function _M.log(conf)
+-- Implement logic here
+end
+```
+
 ## implement the logic
 
 Write the logic of the plugin in the corresponding phase .
 
 ## write test case
 
-for functions , write and improve the test cases of various dimensions , do a comprehensive test for your plugin ! The
-test cases of plugins are all in the "__t/plugin__" directory. You can go ahead to find out . the test framework
-[****test-nginx****](https://github.com/openresty/test-nginx)  adopted by the project. a test case, .t file is usually
+For functions , write and improve the test cases of various dimensions , do a comprehensive test for your plugin ! The
+test cases of plugins are all in the "__t/plugin__" directory. You can go ahead to find out. APISIX uses
+[****test-nginx****](https://github.com/openresty/test-nginx) as the test framework. A test case, .t file is usually
 divided into prologue and data parts by \__data\__ . Here we will briefly introduce the data part, that is, the part
 of the real test case . For example, the key-auth plugin :
 
@@ -174,14 +182,17 @@ done
 [error]
 ```
 
-a test case consists of three parts :
+A test case consists of three parts :
 - __Program code__ : configuration content of Nginx location
 - __Input__ : http request information
 - __Output check__ : status, header, body, error log check
 
-when we request __/t__ , which config in the configuration file , the Nginx will call "__content_by_lua_block__" instruction to
+When we request __/t__ , which config in the configuration file , the Nginx will call "__content_by_lua_block__" instruction to
  complete the Lua script, and finally return. The assertion of the use case is response_body return "done",
-"__no_error_log__" means to check the "__error.log__" of Nginx. There must be no ERROR level record .
+"__no_error_log__" means to check the "__error.log__" of Nginx. There must be no ERROR level record. The log files for the unit test
+are located in the following folder: 't/servroot/logs'.
+
+Refer the following [document](how-to-build.md#test) to setup the testing framework.
 
 ### Attach the test-nginx execution process: