maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject svn commit: r1525300 - in /maven/site/trunk/content: apt/developers/website/deploy-maven-website.apt apt/developers/website/website-overview.odg resources/developers/website/ resources/developers/website/website-overview.png
Date Sat, 21 Sep 2013 23:31:50 GMT
Author: hboutemy
Date: Sat Sep 21 23:31:50 2013
New Revision: 1525300

URL: http://svn.apache.org/r1525300
Log:
complete explanations of CMS + svnpubsub, for Maven website and components reference documentation

Added:
    maven/site/trunk/content/apt/developers/website/website-overview.odg   (with props)
    maven/site/trunk/content/resources/developers/website/
    maven/site/trunk/content/resources/developers/website/website-overview.png   (with props)
Modified:
    maven/site/trunk/content/apt/developers/website/deploy-maven-website.apt

Modified: maven/site/trunk/content/apt/developers/website/deploy-maven-website.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/website/deploy-maven-website.apt?rev=1525300&r1=1525299&r2=1525300&view=diff
==============================================================================
--- maven/site/trunk/content/apt/developers/website/deploy-maven-website.apt (original)
+++ maven/site/trunk/content/apt/developers/website/deploy-maven-website.apt Sat Sep 21 23:31:50
2013
@@ -2,8 +2,9 @@
  Deploy Maven Website
  ------
  Barrie Treloar
+ Hervé Boutemy
  ------
- 2012-12-11
+ 2013-09-22
  ------
 
 ~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,69 +29,111 @@
 
 Introduction
 
- This document gives step-by-step instructions for deploying the Maven {{{http://maven.apache.org}http://maven.apache.org}}
- and Doxia {{{http://maven.apache.org/doxia}http://maven.apache.org/doxia}} websites.
+ This document gives step-by-step instructions for deploying the Maven {{{http://maven.apache.org}http://maven.apache.org}}
website.
 
- Since 10th December 2012, the main website use CMS mechanism: see {{{https://cms.apache.org/maven/}https://cms.apache.org/maven/}}
- and {{{https://cms.apache.org/maven-doxia/}https://cms.apache.org/maven-doxia/}}.
+Overview
 
- You can edit source trees ({{{https://svn.apache.org/repos/asf/maven/site/trunk/content/}Maven}}
and
- {{{https://svn.apache.org/repos/asf/maven/doxia/site/trunk/content/}Doxia}}) in two ways:
+ Since 10th December 2012, the main website use Apache CMS + svnpubsub mechanisms:
 
- * use the CMS UI,
+[website-overview.png] Website mechanisms overview
 
- * checkout the content locally, modify locally and check-in.
+How website publication works
+
+ Maven website ({{http://maven.apache.org}}) is generated with {{{/plugins/maven-site-plugin}maven-site-plugin}}
from a source tree stored in svn: {{https://svn.apache.org/repos/asf/maven/site/trunk}}.
+
+ [[1]] edit source content in one of the following ways:
+
+   [[a]] use the CMS UI through your web browser: {{{https://cms.apache.org/maven/}https://cms.apache.org/maven/}}:
+
+     * Go to {{https://cms.apache.org/maven/}}.
+
+     * Click link "Get Maven Working Copy".
+
+     * Navigate to the content you want to modify.
+
+     * Once you have modified the content, commit with the button "Submit".
+
+     []
+
+   [[b]] checkout the source content locally, modify it with your favorite text editor, eventually
test the result (<<<mvn site>>>), then check-in source modifications.
+
+   []
+
+ [[2]] after source tree is modified in svn, a Buildbot job is triggered: {{http://ci.apache.org/builders/maven-site-staging}}:
+
+   [[1]] it builds the HTML site using Maven site plugin: <<<mvn site>>>,
+
+   [[2]] it publishes generated content to staging svn area: {{https://svn.apache.org/repos/infra/websites/staging/maven/trunk/content/}}.
+
+   [[3]] svnpubsub mecanism transfers svn staging content to live staging site: {{http://maven.staging.apache.org}},
+
+   []
+
+ [[3]] if everything is good, publish modifications using CMS publish: {{https://cms.apache.org/maven/publish}}
+
+   [[1]] CMS copies staging svn area content to production svn area: {{https://svn.apache.org/repos/infra/websites/production/maven/trunk/content/}},
+
+   [[2]] as previous operation will delete content not built from website source, CMS re-adds
content identified in {{{http://maven.apache.org/extpaths.txt}<<<extpaths.txt>>>}},
+
+   [[3]] svnpubsub mecanism transfers svn production content to live production site: {{http://maven.apache.org}}.
 
  []
 
-How it works
+ Notice Doxia uses the exact same mecanisms:
+
+ * svn source tree: {{https://svn.apache.org/repos/asf/maven/doxia/site/trunk}}
 
-  At least how a user understands that.
+ * CMS UI: {{https://cms.apache.org/maven-doxia/}}
 
-  All the HTML content is located in svn ({{{https://svn.apache.org/repos/infra/websites/production/maven/content/}Maven}}
-  and {{{https://svn.apache.org/repos/infra/websites/production/maven-doxia/content/}Doxia}})
then synced to lives machines.
+ * Buildbot job: {{http://ci.apache.org/builders/maven-doxia-site-staging}}
 
-  When the content source tree is modified in svn (either locally or with CMS UI), two buildbot
jobs build the content,
-  using Maven site plugin:
+ * staging svn area: {{https://svn.apache.org/repos/infra/websites/staging/maven-doxia/trunk/content/}}
 
-  * {{{http://ci.apache.org/builders/maven-site-staging}http://ci.apache.org/builders/maven-site-staging}}
+ * live staging site: {{http://maven-doxia.staging.apache.org}}
 
-  * {{{http://ci.apache.org/builders/maven-doxia-site-staging}http://ci.apache.org/builders/maven-doxia-site-staging}}
+ * CMS publish: {{https://cms.apache.org/maven-doxia/publish}}
 
-  []
+ * production svn area: {{https://svn.apache.org/repos/infra/websites/production/maven-doxia/trunk/content/}}
 
-  As CMS will delete non build content, they must be ignored with adding paths in extpaths.txt
file (located in site and doxia-site in path content/resources)
+ * live production site: {{http://maven.apache.org/doxia}}
 
-* Modify Maven Website with CMS UI
+ []
 
-  * Go to {{{https://cms.apache.org/maven/}https://cms.apache.org/maven/}}.
 
-  * Click link "Get maven Working Copy".
+How components reference documentation publication works
 
-  * Now navigate to the content you want to modify.
+ Components don't use CMS: components reference documentation are generated from full sources,
with both handwritten content (like Maven site)
+ and generated content from sources (javadoc, test results, ...).
 
-  * Once you have modified the content, you can commit with the button "Submit".
+ To publish component reference documentation:
 
-  []
+ [[1]] build the component:
 
-* Modify Maven Website with a local copy
++----------+
+mvn -Prun-its install
++----------+
 
- Do a fresh check out of the Maven site, for example:
+ [[2]] build the reference documentation:
 
-+-----+
-$ svn checkout https://svn.apache.org/repos/asf/maven/site site
-+-----+
++----------+
+mvn -Preporting site
++----------+
 
- Once you have modified the content, you can commit with <<<svn ci>>>.
+ [[3]] if the component has multiple modules, locally stage the site:
 
- You can generate the site to verify the documentation before committing:
++----------+
+mvn site:stage
++----------+
 
-+-----+
-mvn site 
-+-----+
+ [[4]] stage the reference documentation to website production svn area: (TODO: explanations
on configuration in pom to xxx-LATEST)
 
-Publish content
++----------+
+mvn scm-publish:publish-scm
++----------+
 
-  * Verify that the staging content has been build with buildbot job ({{http://ci.apache.org/builders/maven-site-staging}})
to {{http://maven.staging.apache.org}} 
+ svnpubsub mecanism transfers svn production content to live production site
+
+   []
+ []
 
-  * If everything is good, publish modifications using {{https://cms.apache.org/maven/publish}}
+ When doing a release, previous xxx-LATEST content needs to be archived to versioned directory
and replace current content (TODO: explanations).

Added: maven/site/trunk/content/apt/developers/website/website-overview.odg
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/developers/website/website-overview.odg?rev=1525300&view=auto
==============================================================================
Binary file - no diff available.

Propchange: maven/site/trunk/content/apt/developers/website/website-overview.odg
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: maven/site/trunk/content/resources/developers/website/website-overview.png
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/resources/developers/website/website-overview.png?rev=1525300&view=auto
==============================================================================
Binary file - no diff available.

Propchange: maven/site/trunk/content/resources/developers/website/website-overview.png
------------------------------------------------------------------------------
    svn:mime-type = image/png



Mime
View raw message