Hi all, after collected a series of feedbacks from [email protected] , I am here to propose a couple of new Maven MOJOs to be included in the Felix codebase, able to generate final-user markdown documentation from SCR and Metatype medata descriptors.
Advantages of producing such documentation, are: * for an internal use, having such catalogue could reduce the development efforts, maybe there are services already available for certain operations that don’t need to be re-implemented; moreover, it can improve/simplify heterogeneous teams integration work. * from customers point of view, it would be good to know what solutions are already offered, to develop their needs on top of our solutions; moreover, under a security PoV, admins can have an overall view to identify which are potential entry-points that can be attacked. If you want to have a look at the output, I tested the MOJOs against a couple of Apache Sling projects and collected all of them under a private public GitHub repo[1], it should be easy enough understanding how traverse rendered data. How it works: it is a couple of plain-old Maven3 MOJOs which can be configured directly in the POM, I packaged already all the sources in order to be donated to the ASF, I just would like to start the discussion in order to understand if the community is interested on that tool and which steps are required in order to have it accepted. I identified the osgicheck-maven-plugin[2] as the best candidate in order to host the new codebase. [1] https://github.com/simonetripodi/mddoc-samples [2] https://github.com/apache/felix/tree/trunk/tools/osgicheck-maven-plugin Any feedback/suggestion/hint/... will be much more than appreciated, many thanks in advance! All the best, ~Simo http://people.apache.org/~simonetripodi/ http://www.99soft.org/ On Thu, Aug 2, 2018 at 9:57 AM Konrad Windszus <[email protected]> wrote: > Hi Simone, > this looks great. Just some comments: > > > > How it works: it is a plain Java8 annotations processor, able to generate > > documentations for: > > > > * SlingServlet annotated components; > > * (Deprecated) Felix SCR annotations (we still have lot of components in > > the repo which use such annotations, i.e. Apache Sling Distribution Core) > > * OSGi Component/Metatype annotations > > What about instead acting on top of the generated component definitions or > metatype resources? That way you would be independent of how they have been > generated? > Konrad
