yaooqinn commented on PR #3179:
URL: 
https://github.com/apache/incubator-kyuubi/pull/3179#issuecomment-1219232928

   A good example to follow 
https://kyuubi.readthedocs.io/en/latest/extensions/server/authentication.html
   
   1. reference the built-in implementations for a better understanding of what 
the plugin is and whether a user really needs a custom one.
   2. All developer APIs are elaborated with rich java doc
   
   
   A bad example to avoid (you just followed it)
   https://kyuubi.readthedocs.io/en/latest/extensions/server/configuration.html
   
   The doc hierarchy goes
   
   ```
   H1 What is it?
     
     *introduction about this feature and related APIS*
    
     H2 the way to develop
        *develop guide*
     H2 the way to activate
        *usage guide*
   ```


-- 
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]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to