You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@maven.apache.org by Hervé BOUTEMY <he...@free.fr> on 2011/06/25 23:40:59 UTC

Re: svn commit: r1131500 - in /maven/pom/trunk/asf: pom.xml src/ src/site/ src/site/apt/ src/site/apt/index.apt src/site/site.xml

such a documentation was already added some time ago [1], with a quite 
complete result [2], but removed [3]

I searched mail archives to get exact discussions about this and found the 
thread that lead to removal [4]

But it seems that the target CMS for this page wasn't defined after, and the 
documentation was lost...


Now the question is: where do we put ASF pom documentation?

Regards,

Hervé


[1] 
http://svn.apache.org/viewvc/maven/pom/trunk/asf/src/site/apt/index.apt?view=log&pathrev=1069580

[2] http://maven.apache.org/asf-pom/index.html

[3] http://svn.apache.org/viewvc?view=revision&revision=1069581

[4] http://mail-archives.apache.org/mod_mbox/maven-
dev/201102.mbox/%3CAANLkTi=iKpQd_K63P0ga6oY6comBXuWd1JtG5G5e+h54@mail.gmail.com%3E

Le dimanche 5 juin 2011, bimargulies@apache.org a écrit :
> Author: bimargulies
> Date: Sat Jun  4 22:24:04 2011
> New Revision: 1131500
> 
> URL: http://svn.apache.org/viewvc?rev=1131500&view=rev
> Log:
> [MPOM-7]: first whack at documentation in here
> 
> Added:
>     maven/pom/trunk/asf/src/
>     maven/pom/trunk/asf/src/site/
>     maven/pom/trunk/asf/src/site/apt/
>     maven/pom/trunk/asf/src/site/apt/index.apt   (with props)
>     maven/pom/trunk/asf/src/site/site.xml   (with props)
> Modified:
>     maven/pom/trunk/asf/pom.xml
> 
> Modified: maven/pom/trunk/asf/pom.xml
> URL:
> http://svn.apache.org/viewvc/maven/pom/trunk/asf/pom.xml?rev=1131500&r1=11
> 31499&r2=1131500&view=diff
> ==========================================================================
> ==== --- maven/pom/trunk/asf/pom.xml (original)
> +++ maven/pom/trunk/asf/pom.xml Sat Jun  4 22:24:04 2011
> @@ -81,9 +81,15 @@ under the License.
>     
> <developerConnection>scm:svn:https://svn.apache.org/repos/asf/maven/pom/tr
> unk/asf</developerConnection>
> <url>http://svn.apache.org/viewvc/maven/pom/trunk/asf</url>
>    </scm>
> +  <issueManagement>
> +    <system>jira</system>
> +   
> <url>http://issues.apache.org/jira/browse/MPOM/component/12314370</url> + 
> </issueManagement>
> 
>    <distributionManagement>
>      <!-- Site omitted - each project must provide their own -->
> +    <!-- this project *has* a site, but it gets deployed manually
> +         to avoid unwanted inheritance. -->
>      <repository>
>        <id>apache.releases.https</id>
>        <name>Apache Release Distribution Repository</name>
> 
> Added: maven/pom/trunk/asf/src/site/apt/index.apt
> URL:
> http://svn.apache.org/viewvc/maven/pom/trunk/asf/src/site/apt/index.apt?re
> v=1131500&view=auto
> ==========================================================================
> ==== --- maven/pom/trunk/asf/src/site/apt/index.apt (added)
> +++ maven/pom/trunk/asf/src/site/apt/index.apt Sat Jun  4 22:24:04 2011
> @@ -0,0 +1,20 @@
> +    --------------------------
> +    ASF Shared Parent POM
> +    --------------------------
> +    Modified 4 June 2011
> +    --------------------------
> +
> +Introduction
> +
> +    This project provides a shared parent POM for anything built
> +    with Maven at the Apache Software Foundation.
> +
> +    It defines the standard repositories, selects current versions
> +    of commonly-used plugins, and defines a configuration for the
> +    release plugin that is consistent with ASF requirements and
> +    conventions.
> +
> +    Note, in particular, that it enables a profile named <apache-release>
> +    in all goals of the <maven-release-plugin>. This profile enables
> +    gpg signing, source packaging, and other defaults.
> +
> 
> Propchange: maven/pom/trunk/asf/src/site/apt/index.apt
> ---------------------------------------------------------------------------
> --- svn:eol-style = native
> 
> Propchange: maven/pom/trunk/asf/src/site/apt/index.apt
> ---------------------------------------------------------------------------
> --- svn:mime-type = text/plain
> 
> Added: maven/pom/trunk/asf/src/site/site.xml
> URL:
> http://svn.apache.org/viewvc/maven/pom/trunk/asf/src/site/site.xml?rev=113
> 1500&view=auto
> ==========================================================================
> ==== --- maven/pom/trunk/asf/src/site/site.xml (added)
> +++ maven/pom/trunk/asf/src/site/site.xml Sat Jun  4 22:24:04 2011
> @@ -0,0 +1,71 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +
> +<!--
> +Licensed to the Apache Software Foundation (ASF) under one
> +or more contributor license agreements.  See the NOTICE file
> +distributed with this work for additional information
> +regarding copyright ownership.  The ASF licenses this file
> +to you under the Apache License, Version 2.0 (the
> +"License"); you may not use this file except in compliance
> +with the License.  You may obtain a copy of the License at
> +
> +  http://www.apache.org/licenses/LICENSE-2.0
> +
> +Unless required by applicable law or agreed to in writing,
> +software distributed under the License is distributed on an
> +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
> +KIND, either express or implied.  See the License for the
> +specific language governing permissions and limitations
> +under the License.
> +-->
> +
> +<project>
> +  <bannerLeft>
> +    <name>${project.name}</name>
> +    <src>http://maven.apache.org/images/apache-maven-project-2.png</src>
> +    <href>http://maven.apache.org/</href>
> +  </bannerLeft>
> +  <bannerRight>
> +    <src>http://maven.apache.org/images/maven-logo-2.gif</src>
> +  </bannerRight>
> +
> +  <skin>
> +    <groupId>org.apache.maven.skins</groupId>
> +    <artifactId>maven-stylus-skin</artifactId>
> +    <version>1.3</version>
> +  </skin>
> +
> +  <publishDate format="yyyy-MM-dd" position="right" />
> +  <version position="right" />
> +
> +  <body>
> +    <head>
> +      <script src="http://www.google-analytics.com/urchin.js"
> type="text/javascript"> +      </script>
> +      <script type="text/javascript">
> +        _uacct = "UA-140879-1";
> +        urchinTracker();
> +      </script>
> +    </head>
> +
> +    <!-- Breadcrumbs that every project will inherit -->
> +    <breadcrumbs>
> +      <item name="Apache" href="http://www.apache.org/" />
> +      <!-- NOTE: This only works with stylus-skin-1.3,
> +           remove again if reverting to 1.2
> +      -->
> +      <item name="Maven"  href="http://maven.apache.org/index.html" />
> +    </breadcrumbs>
> +
> +    <!-- Menus that every project will inherit -->
> +    <menu ref="reports" inherit="bottom" />
> +
> +    <menu name="ASF">
> +      <item name="How Apache Works"
> href="http://www.apache.org/foundation/how-it-works.html"/> +      <item
> name="Foundation" href="http://www.apache.org/foundation/"/> +      <item
> name="Sponsoring Apache"
> href="http://www.apache.org/foundation/sponsorship.html"/> +      <item
> name="Thanks" href="http://www.apache.org/foundation/thanks.html"/> +   
> </menu>
> +
> +  </body>
> +</project>
> 
> Propchange: maven/pom/trunk/asf/src/site/site.xml
> ---------------------------------------------------------------------------
> --- svn:eol-style = native
> 
> Propchange: maven/pom/trunk/asf/src/site/site.xml
> ---------------------------------------------------------------------------
> --- svn:mime-type = text/plain


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: svn commit: r1131500 - in /maven/pom/trunk/asf: pom.xml src/ src/site/ src/site/apt/ src/site/apt/index.apt src/site/site.xml

Posted by Hervé BOUTEMY <he...@free.fr>.

done [1]
site deployed [2]

any comments appreciated to continue to improve the documentation

Regards,

Hervé

[1] http://svn.apache.org/viewvc/maven/pom/trunk/asf/pom.xml?view=markup

[2] http://maven.apache.org/pom/asf/


Le mardi 28 juin 2011, sebb a écrit :
> May I make a plea for the ASF POM to include a link to the
> documentation in the comments?
> 
> Also, maybe someone can fix the very long comment line starting with:
> 
> "As of Version 6, "
> 
> The description could be wrapped as well.
> 
> On 27 June 2011 21:42, Benson Margulies <bi...@gmail.com> wrote:
> > It occurs to me that the main pom could include a profile to run the
> > site pom via the invoker.
> > 
> > On Mon, Jun 27, 2011 at 4:36 PM, Hervé BOUTEMY <he...@free.fr> 
wrote:
> >> option 1 seems to be controversial
> >> 
> >> option 2, with site-pom.xml as suggested by Jörg, with specific
> >> siteDirectory site plugin configuration (to avoid site.xml problem like
> >> pom.xml), seems pretty good
> >> 
> >> option 3, [1], doesn't seem accessible in the short term
> >> 
> >> any objection to go with option 2?
> >> 
> >> Regards,
> >> 
> >> Hervé
> >> 
> >> 
> >> [1] http://mail-archives.apache.org/mod_mbox/maven-
> >> dev/201106.mbox/%3CBANLkTim7idTDmg=_Kx3H1Bsmdnqbxk4vSg@mail.gmail.com%3E
> >> 
> >> Le lundi 27 juin 2011, Benson Margulies a écrit :
> >>> Option 1: go ahead and put a full configuration in this POM, and then
> >>> make sure that all of the things that use it really do over-ride it.
> >>> 
> >>> Option 2: Give it a parent or child: create a project with a site just
> >>> to document and aggregate this, with enough SEO to catch googles.
> >>> 
> >>> Option 3: take up my elaborate suggestion in the mixin thread.
> >>> 
> >>> On Sun, Jun 26, 2011 at 4:02 AM, Hervé BOUTEMY <he...@free.fr>
> >> 
> >> wrote:
> >>> >> Now the question is: where do we put ASF pom documentation?
> >>> > 
> >>> > sharing a few thoughts:
> >>> > 1. in the project itself? need to find a way to get its publication
> >>> > done without tainting the pom
> >>> > 
> >>> > 2. in the Maven site [1], in a dedicated directory
> >>> > 
> >>> > 3. at the top of pom svn [2]: the main difference I see from Maven
> >>> > site is that we can configure project information specifically
> >>> > (issue tracking especially), create dedicated menu
> >>> > 
> >>> > any thought?
> >>> > 
> >>> > Regards,
> >>> > 
> >>> > Hervé
> >>> > 
> >>> > [1] http://svn.apache.org/viewvc/maven/site/trunk/
> >>> > 
> >>> > [2] http://svn.apache.org/viewvc/maven/pom/trunk/
> >>> > 
> >>> > ---------------------------------------------------------------------
> >>> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>> > For additional commands, e-mail: dev-help@maven.apache.org
> >>> 
> >>> ---------------------------------------------------------------------
> >>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >>> For additional commands, e-mail: dev-help@maven.apache.org
> >> 
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >> For additional commands, e-mail: dev-help@maven.apache.org
> > 
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org