You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ol...@apache.org on 2013/01/17 00:39:51 UTC
svn commit: r1434496 - /commons/cms-site/trunk/content/xdoc/site-publish.xml
Author: olamy
Date: Wed Jan 16 23:39:51 2013
New Revision: 1434496
URL: http://svn.apache.org/viewvc?rev=1434496&view=rev
Log:
start documentation for site publication
Added:
commons/cms-site/trunk/content/xdoc/site-publish.xml (with props)
Added: commons/cms-site/trunk/content/xdoc/site-publish.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/site-publish.xml?rev=1434496&view=auto
==============================================================================
--- commons/cms-site/trunk/content/xdoc/site-publish.xml (added)
+++ commons/cms-site/trunk/content/xdoc/site-publish.xml Wed Jan 16 23:39:51 2013
@@ -0,0 +1,100 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+
+<document>
+
+ <properties>
+ <title>Publish Sites</title>
+ <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+ <section name='Introduction'>
+ <p>
+ Due to svnpubsub migration, procedure to publish sites has been changes.
+ Commons sites use a solution based on both <a href="http://apache.org/dev/cmsref.html">Apache cms</a> (for main site)
+ and svnpubsub publication based on <a href="http://maven.apache.org/plugins/maven-scm-publish-plugin/">maven-scm-publish-plugin</a>.
+ </p>
+
+ </section>
+ <section name="Main site">
+ <p>Apache CMS UI can be used to modify and publish main web site: <a href="https://cms.apache.org/commons/">https://cms.apache.org/commons/</a>.
+ Documentation is available <a href="http://apache.org/dev/cmsref.html">here</a>
+
+ </p>
+ </section>
+ <section name="Components">
+ <p>
+ Components use maven-scm-publish-plugin. The maven generated site is checkin to:
+ <ul>
+ <li>propers: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/</li>
+ <li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/</li>
+ <li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/</li>
+ </ul>
+ </p>
+ <p>
+ Components need to use parent 28 (sandbox parent: 10).
+ </p>
+ <subsection name="Publishing mono module projects">
+ <p>
+ Simply using:
+ <code>mvn clean site-deploy</code>
+ </p>
+ </subsection>
+ <subsection name="Publishing multi modules projects">
+ <p>
+ Simply using:
+ <code>clean site site:stage scm-publish:publish-scm</code>
+ </p>
+ </subsection>
+ <subsection name="Configuration">
+ <p>
+ Default deployment targets are:
+ <ul>
+ <li>propers: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/${project.artifactId}</li>
+ <li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/${project.artifactId}</li>
+ <li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/${project.artifactId}</li>
+ </ul>
+ </p>
+ <p>
+ maven-scm-publish-plugin will delete content not generated by Maven site plugin.
+ To avoid delete of previous apis javadocs, the pom need some configuration:
+ <pre>
+ <![CDATA[
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-publish-plugin</artifactId>
+ <configuration>
+ <ignorePathsToDelete>
+ <ignorePathToDelete>javadocs</ignorePathToDelete>
+ <!-- other paths to ignore -->
+ </ignorePathsToDelete>
+ </configuration>
+ </plugin>
+ ]]>
+ </pre>
+ All paths declared won't be deleted from svn
+ </p>
+ <p>
+ <b>NOTE:</b> this old content need to be imported manually.
+ </p>
+ </subsection>
+ </section>
+
+ </body>
+</document>
Propchange: commons/cms-site/trunk/content/xdoc/site-publish.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: commons/cms-site/trunk/content/xdoc/site-publish.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision