[jira] [Commented] (FELIX-5900) Donating a tool able to generate markdown documentation for SCR and Metatype

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FELIX-5900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16570169#comment-16570169 ] 

ASF GitHub Bot commented on FELIX-5900:
---------------------------------------

GitHub user simonetripodi opened a pull request:

    https://github.com/apache/felix/pull/149

    FELIX-5900 - Donating a tool able to generate markdown documentation for SCR and Metatype

    

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/simonetripodi/felix trunk

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/felix/pull/149.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #149
    
----
commit 40fb087538ede72274271085a879d05315dc3870
Author: Simo Tripodi <st...@...>
Date:   2018-08-06T08:55:31Z

    [PROPOSAL] add new MOJOs able to generate the Markdown documentation
    from metatypes and SCR XML representation

----


> Donating a tool able to generate markdown documentation for SCR and Metatype
> ----------------------------------------------------------------------------
>
>                 Key: FELIX-5900
>                 URL: https://issues.apache.org/jira/browse/FELIX-5900
>             Project: Felix
>          Issue Type: New Feature
>            Reporter: Simone Tripodi
>            Priority: Major
>
> after collected a series of feedbacks from  dev@sling.a.o , 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



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)