Hi Community,

I start migrate plugins docbook for ofbiz-plugins and I have a question about
How to manage plugins documentation, in the structure of user-documentation and 
developper-manual ?

I see 3 possible solutions
1) Current solution: one document per plugin, and link to its in the correct 
chapter
   example: plugins ldap, doc SingleSignOn : it is generated as
https://ci.apache.org/projects/ofbiz/site/trunk/pluginsdoc/ldap/html5/SingleSignOn.html
            in developper-manual, put a link to this doc in the Deployment 
chapter

2) add a "include::" in the correct chapter (created a dependency between 
framework and plugins)
   example: currently in Deployment chapter there is the "11.2. OFBiz Single 
Sign On using CAS and LDAP" as sub-chapter

3) add a "include::" to a doc/asciidoc/plugins-user-documentation in 
user-ddocumentation
          and one to doc/asciidoc/plugins-developper-manual in developper-manual
   In each file there will be all the include to tha appropriate plugins.

Reply via email to