svn commit: r1707141 - in /pdfbox/cmssite/trunk: content/siteupdate.md templates/skeleton.html

[ms...@apache.org]

Author: msahyoun
Date: Tue Oct  6 21:00:02 2015
New Revision: 1707141

URL: http://svn.apache.org/viewvc?rev=1707141&view=rev
Log:
PDFBOX-2340: document how to update the Javadoc

Added:
    pdfbox/cmssite/trunk/content/siteupdate.md
Modified:
    pdfbox/cmssite/trunk/templates/skeleton.html

Added: pdfbox/cmssite/trunk/content/siteupdate.md
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/siteupdate.md?rev=1707141&view=auto
==============================================================================
--- pdfbox/cmssite/trunk/content/siteupdate.md (added)
+++ pdfbox/cmssite/trunk/content/siteupdate.md Tue Oct  6 21:00:02 2015
@@ -0,0 +1,32 @@
+Title:     Updating the Website
+
+# Update the JavaDocs for PDFBOX 2.x
+
+## Contribute
+If you would like to submit a javadoc patch through Jira, please open a ticket at our [Issue Tracker](https://issues.apache.org/jira/browse/PDFBOX) an use 'Documentation' for the 'Component'.
+
+## Publish (for committers only)
+To publish the javadocs follow these steps:
+
+Add the following server configuration in your ~/.m2/settings.xml file
+
+```
+<server>
+  <id>pdfbox-site</id>
+  <username>** USERNAME **</username>
+  <password>** PASSWORD **</password>
+</server>
+```
+
+`pdfbox-site` is referenced from the PDFBox pom.xml file.
+
+Run
+
+```
+$ mvn clean javadoc:aggregate scm-publish:publish-scm
+
+```
+
+from the `<SVN_ROOT>/../pdfbox` directory.
+
+<p class="alert alert-info">As <code>mvn clean</code> will delete the javadoc files download from the Apache CMS it's advised to configure <code>${svn.scmJavadocCheckoutDirectory}</code> to a local directory not below <code>./target</code>.</p>
\ No newline at end of file

Modified: pdfbox/cmssite/trunk/templates/skeleton.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/templates/skeleton.html?rev=1707141&r1=1707140&r2=1707141&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/templates/skeleton.html (original)
+++ pdfbox/cmssite/trunk/templates/skeleton.html Tue Oct  6 21:00:02 2015
@@ -146,7 +146,8 @@
                     
                     <li class="sidebar-header">Development</li>
                     <li><a href="/building.html">Building from Source</a></li>
-                    <li><a href="/codingconventions.html">Coding Conventions</a></li>                    
+                    <li><a href="/codingconventions.html">Coding Conventions</a></li>
+                    <li><a href="/siteupdate.html">Update the Website</a></li>  
                     <li><a href="https://builds.apache.org/view/All/job/PDFBox-trunk/">Jenkins</a></li>
                     <li><a href="https://travis-ci.org/apache/pdfbox">Travis CI</a></li>
                     <li><a href="https://analysis.apache.org/dashboard/index/org.apache.pdfbox:pdfbox-reactor">SonarQube</a></li>