You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sling.apache.org by Stefan Seifert <ss...@pro-vision.de> on 2016/09/28 21:28:38 UTC

maven site documentation for sling maven plugins

discussed at the Sling Committer Round Table @ adaptTo() 2016

sling provides a couple of maven plugins, but does not provide a detailed documentation about their goals and properties at [1].

such a documentation can be generated easily by using the maven site for the plugin project. the only question is: how should it be published and integrated in the maven site?

it would be sufficient to link to it from the maven site, it does not necessarily have to be "fully integrated" in the layout of the sling docs pages.

the documentation for the different releases of maven plugins should be available in parallel.

one option would be to generate the site and include it in the sling site svn. this is not very elegant and will bloat the site svn, and it is bad practice to check in generated markup, but it would work. but it is a manually step one to execute on each release of a maven plugin.

next step would be creating a JIRA ticket for this.

stefan

[1] http://sling.apache.org/



Re: maven site documentation for sling maven plugins

Posted by Konrad Windszus <ko...@gmx.de>.
Some documentation on how this is done for maven-bundle-plugin is available at [1] leveraging the maven-scm-publish-plugin [3].
The pom.xml shows what needs to be configured[2].
In contrast to the Maven Bundle Plugin we should use dedicated URLs per version of each plugin.

Konrad

[1] - http://felix.apache.org/documentation/development/release-management-nexus.html#stage-the-generated-documentation
[2] - https://github.com/apache/felix/blob/trunk/tools/maven-bundle-plugin/pom.xml#L102
[3] - http://maven.apache.org/plugins/maven-scm-publish-plugin/


> Am 28.09.2016 um 23:28 schrieb Stefan Seifert <ss...@pro-vision.de>:
> 
> discussed at the Sling Committer Round Table @ adaptTo() 2016
> 
> sling provides a couple of maven plugins, but does not provide a detailed documentation about their goals and properties at [1].
> 
> such a documentation can be generated easily by using the maven site for the plugin project. the only question is: how should it be published and integrated in the maven site?
> 
> it would be sufficient to link to it from the maven site, it does not necessarily have to be "fully integrated" in the layout of the sling docs pages.
> 
> the documentation for the different releases of maven plugins should be available in parallel.
> 
> one option would be to generate the site and include it in the sling site svn. this is not very elegant and will bloat the site svn, and it is bad practice to check in generated markup, but it would work. but it is a manually step one to execute on each release of a maven plugin.
> 
> next step would be creating a JIRA ticket for this.
> 
> stefan
> 
> [1] http://sling.apache.org/
> 
> 


Re: maven site documentation for sling maven plugins

Posted by Konrad Windszus <ko...@gmx.de>.
Good point, would prefer that option as well. I asked INFRA about this option in https://issues.apache.org/jira/browse/INFRA-12701 <https://issues.apache.org/jira/browse/INFRA-12701>.
Konrad

> On 1 Oct 2016, at 21:19, Robert Munteanu <ro...@apache.org> wrote:
> 
> 
> On Wed, 2016-09-28 at 21:28 +0000, Stefan Seifert wrote:
>> discussed at the Sling Committer Round Table @ adaptTo() 2016
>> 
>> sling provides a couple of maven plugins, but does not provide a
>> detailed documentation about their goals and properties at [1].
>> 
>> such a documentation can be generated easily by using the maven site
>> for the plugin project. the only question is: how should it be
>> published and integrated in the maven site?
>> 
>> it would be sufficient to link to it from the maven site, it does not
>> necessarily have to be "fully integrated" in the layout of the sling
>> docs pages.
>> 
>> the documentation for the different releases of maven plugins should
>> be available in parallel.
>> 
>> one option would be to generate the site and include it in the sling
>> site svn. this is not very elegant and will bloat the site svn, and
>> it is bad practice to check in generated markup, but it would work.
>> but it is a manually step one to execute on each release of a maven
>> plugin.
> 
> I think that we can also deploy generated sites to Nexus, but I am not
> sure if we can link to repository.apache.org from public pages or
> whether it's OK to publish the sites on Maven central and serve them
> from there.
> 
>   https://books.sonatype.com/nexus-book/reference/_publishing_a_maven_s
> ite.html
> 
> Robert


Re: maven site documentation for sling maven plugins

Posted by Robert Munteanu <ro...@apache.org>.
On Wed, 2016-09-28 at 21:28 +0000, Stefan Seifert wrote:
> discussed at the Sling Committer Round Table @ adaptTo() 2016
> 
> sling provides a couple of maven plugins, but does not provide a
> detailed documentation about their goals and properties at [1].
> 
> such a documentation can be generated easily by using the maven site
> for the plugin project. the only question is: how should it be
> published and integrated in the maven site?
> 
> it would be sufficient to link to it from the maven site, it does not
> necessarily have to be "fully integrated" in the layout of the sling
> docs pages.
> 
> the documentation for the different releases of maven plugins should
> be available in parallel.
> 
> one option would be to generate the site and include it in the sling
> site svn. this is not very elegant and will bloat the site svn, and
> it is bad practice to check in generated markup, but it would work.
> but it is a manually step one to execute on each release of a maven
> plugin.

I think that we can also deploy generated sites to Nexus, but I am not
sure if we can link to repository.apache.org from public pages or
whether it's OK to publish the sites on Maven central and serve them
from there.

��https://books.sonatype.com/nexus-book/reference/_publishing_a_maven_s
ite.html

Robert