| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd"> |
| |
| |
| <!-- ====================================================================== --> |
| <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> |
| <!-- ====================================================================== --> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> |
| <style type="text/css">@import "stylesheets/base.css";</style> |
| <meta name="author" value=" |
| Apache UIMA Documentation Team"> |
| <meta name="email" value="dev@uima.apache.org"> |
| |
| |
| |
| <title>Apache UIMA - Updating the Apache UIMA Website or Distribution-META file</title> |
| |
| <!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent --> |
| <!-- Commented out because implied consent is not compatible with GDPR --> |
| <!-- |
| <script type="text/javascript"> |
| window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"}; |
| </script> |
| |
| <script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script> |
| --> |
| <!-- End Cookie Consent plugin --> |
| |
| <!-- Begin Google Analytics --> |
| <!-- Commented out because GA requires consent according to GDPR --> |
| <!-- |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-70846351-1', 'auto'); |
| ga('set', 'anonymizeIp', true); |
| ga('send', 'pageview'); |
| |
| </script> |
| --> |
| <!-- End Google Analytics --> |
| </head> |
| |
| <body> |
| <div class="topLogos"> |
| <table border="0" width="100%" cellspacing="0"> |
| <!-- TOP IMAGE --> |
| <tr> |
| <td align='LEFT'> |
| <a href="index.html"> |
| <img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/> |
| </a> |
| </td> |
| <td align='CENTER'> |
| <div class="pageBanner">Updating the Apache UIMA Website or Distribution-META file</div> |
| </td> |
| <td align='RIGHT'> |
| <a href="https://www.apache.org"> |
| <img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/> |
| </a> |
| </td> |
| </tr> |
| </table> |
| <hr noshade="" size="1"/> |
| </div> |
| <table border="0" width="100%" cellspacing="4"> |
| <tr> |
| <td align='RIGHT' colspan="2"> |
| <form method="get" action="https://www.google.com/search"> |
| Search the site |
| <input type="text" name="q" size="25" maxlength="255" value="" /> |
| <input type="hidden" name="sitesearch" value="https://uima.apache.org/" /> |
| <input name="Search" value="Search Site" type="submit"/> |
| </form> |
| </td> |
| </tr> |
| <tr> <!-- LEFT SIDE NAVIGATION --> |
| <td width="20%" valign="top"> |
| |
| |
| |
| |
| |
| |
| <!-- regular menu --> |
| <div class="navBar"> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">General</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./index.html">Home</a> |
| </div> |
| <div class="navBarItem"> <a href="./downloads.cgi">Downloads</a> |
| </div> |
| <div class="navBarItem"> <a href="./documentation.html">Documentation</a> |
| </div> |
| <div class="navBarItem"> <a href="./news.html">News</a> |
| </div> |
| <div class="navBarItem"> <a href="./publications.html">Publications</a> |
| </div> |
| <br style="line-height: .5em"/> |
| <div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a> |
| </div> |
| <br style="line-height: .5em"/> |
| <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Community</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./get-involved.html">Get Involved</a> |
| </div> |
| <div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a> |
| </div> |
| <div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a> |
| </div> |
| <div class="navBarItem"> <a href="./faq.html">FAQ</a> |
| </div> |
| <div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Scaleout Frameworks</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./doc-uimaas-what.html">UIMA-AS</a> |
| </div> |
| <div class="navBarItem"> <a href="./doc-uimaducc-whatitam.html">UIMA-DUCC</a> |
| </div> |
| <div class="navBarItem"> <a href="./doc-uimaducc-demo.html">..Demo Page</a> |
| </div> |
| <div class="navBarItem"> <a href="http://uima-ducc-demo.apache.org:42133" target="_blank" rel="noopener">..Demo Live <img src="images/offsitelink.png"/></a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Components & Tools</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a> |
| </div> |
| <div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a> |
| </div> |
| <div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a> |
| </div> |
| <div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a> |
| </div> |
| <div class="navBarItem"> <a href="./uimafit.html">uimaFIT</a> |
| </div> |
| <div class="navBarItem"> <a href="./external-resources.html">External Resources</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Development</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a> |
| </div> |
| <div class="navBarItem"> <a href="./building-uima.html">Building from Source</a> |
| </div> |
| <div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a> |
| </div> |
| <div class="navBarItem"> <a href="./svn.html">Source Code</a> |
| </div> |
| <div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a> |
| </div> |
| <div class="navBarItem"> <a href="./git.html">GIT</a> |
| </div> |
| <div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a> |
| </div> |
| <div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a> |
| </div> |
| <div class="navBarItem"> <a href="./team-list.html">Project Team</a> |
| </div> |
| <div class="navBarItem"> <a href="./maven-design.html">Maven Use</a> |
| </div> |
| <div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="./coling14.html">COLING 2014</a> |
| </div> |
| <div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a> |
| </div> |
| <div class="navBarItem"> <a href="./iks09.html">IKS 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a> |
| </div> |
| <div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a> |
| </div> |
| <div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a> |
| </div> |
| </div> |
| <br/> |
| <div class="navBarItem"> <div class="navPartHeading">ASF</div> |
| </div> |
| <div class="navBar"> |
| <div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a> |
| </div> |
| <div class="navBarItem"> <a href="./security_report">Security</a> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td width="80%" align="left" valign="top"> |
| <div class="sectionTable"> |
| <table class="sectionTable"> |
| <tr><td> |
| <a name="Updating the Apache UIMA Website or Distribution-META file"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Updating the Apache UIMA Website or Distribution-META file</h1></a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="sectionBody"> |
| <p>The Apache UIMA™ website is updated by committers on the |
| project from time to time. Besides normal edits to various pages, |
| with every release the download page needs updating. There are |
| special procedures for effectively handling large generated documentation, |
| as well.</p> |
| <p>The release distribution META file is a special file used by the release checker |
| and is maintained by the PMC chairperson.</p> |
| <ul> |
| <li><a href='#Kinds of Web Content'> |
| Kinds of Web Content |
| |
| </a></li> |
| <li><a href='#How to SVN checkout the web-site'> |
| How to SVN checkout the web-site |
| |
| </a></li> |
| <li><a href='#How to Generate and Publish the web-site'> |
| How to Generate and Publish the web-site |
| |
| </a></li> |
| <li><a href='#Using the stylesheets'> |
| Using the stylesheets |
| |
| </a></li> |
| <li><a href='#Generated Content Management'> |
| Generated Content Management |
| |
| </a></li> |
| <li><a href='#Download CGI scripting'> |
| Download CGI scripting |
| |
| </a></li> |
| <li><a href='#IP-Clearance documentation'> |
| IP-Clearance documentation |
| |
| </a></li> |
| <li><a href='#Updating the release distribution META file'> |
| Updating the release distribution META file |
| |
| </a></li> |
| </ul> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Kinds of Web Content"> |
| <h2>Kinds of Web Content |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>There are many kinds of data in the uima-website component. Here's a summary: |
| <ul> |
| <li>Normal web pages. These are kept in source form in /xdocs/....xml, and converted |
| to published ....html form (formatting, adding required headers/footers, etc.) and kept |
| as identically named (except for the .html suffix) files under /docs/. |
| </li> |
| <li>Generated files. These are things like the current javadocs. These are often |
| large, with 1000's of files. These are kept in /docs/d/ directory. |
| </li> |
| <li>xdocs/stylesheets - this is a repository for the main formatting macros and data for the |
| website. It includes the project.xml, which has the left-hand menu details, and the release |
| details, and transformation macros. Note: we use anakia and "velocity" (vsl) macros, we do |
| not use XSLT transformation. The filel site.xsl is out of date, not maintained, etc.; see |
| the file site.vsl instead.</li> |
| <li>downloads - needs improvement. It has some old generated files (should be cleaned up - |
| deleted or moved to /docs/d/). There should also not be 2 copies both in docs/ and xdocs/. |
| A reasonable design would be for this to be only in the /docs/ directory, and to contain |
| non-generated files for download. Be careful in doing changes, in that external websites |
| could link to files here. |
| <p>This has generated docs for the sandbox projects, for old versions of UIMA while in |
| incubation (probably should be removed), and charts and PDFs for the UIMA track of |
| the 2007 GLDV conference.</p></li> |
| <li>ip-clearances - this should be moved from the /docs/ to a non-published directory. |
| This is an output directory that doesn't really need to be checked into SVN - its there |
| only to check ip-clearance documentation before committing it to the incubator web site |
| (see the Apache IP clearance process).</li> |
| <li>The DOAP file for UIMA. See <a target="_blank" rel="noopener" href="https://projects.apache.org/doap.html">https://projects.apache.org/doap.html</a>. |
| This file at this location is registered with the Apache infrastructure so do not |
| move it without updating that.</li> |
| </ul></p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="How to SVN checkout the web-site"> |
| <h2>How to SVN checkout the web-site |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>You can use this trick when checkout of the uima-website project, to reduce the |
| footprint of what's checked out. The basic idea is to do a full checkout, but then |
| discard from the working-copy, the /docs/d/ content (the generated Javadocs, etc.). |
| This can be done using the command: |
| <pre>cd to the top of the uima-website working copy, and then |
| svn update --set-depth exclude docs/d |
| svn update --set-depth exclude docs/downloads/gldv |
| svn update --set-depth exclude docs/downloads/releaseDocs</pre> |
| This will run for a while, but then the directories mentioned and their contents will be |
| deleted from your working copy; this will speed up various SVN operations that have |
| to scan the files for changes, etc. For more details, see |
| <a target="_blank" rel="noopener" href="https://svnbook.red-bean.com/en/1.6/svn.advanced.sparsedirs.html"> |
| https://svnbook.red-bean.com/en/1.6/svn.advanced.sparsedirs.html</a>. |
| If this doesn't work for you, check that your svn version is at least 1.6. |
| </p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="How to Generate and Publish the web-site"> |
| <h2>How to Generate and Publish the web-site |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>The SVN spot uima/site/trunk/uima-website has the current published version of the |
| website. The subtree starting at the <code>docs</code> directory is automatically |
| copied to the Apache webserver, whenever an SVN update is done. |
| </p> |
| <p>After updating any pages in xdocs/, you must run the build.xml ANT script to |
| convert these changes to corresponding pages in the docs/ directory. |
| The build.xml script uses the time stamp on the source files to determine which |
| files to run against, and only regenerates files which have changed (or been added). |
| </p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Using the stylesheets"> |
| <h2>Using the stylesheets |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>There are two kinds of stylesheets. One is in the /docs/stylesheets and is the |
| CSS styling of the website. Change this to tweak the look and feel of the website.</p> |
| <p>The other is the stylesheets directory in the xdocs/. Change the project.xml to update |
| the left-hand-side navigation menu, and to add details about new releases (these are used |
| to generate the bulk of the download page).</p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Generated Content Management"> |
| <h2>Generated Content Management |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>Generated content can be large, and can contain 1000's of files. It needs to be |
| somewhat carefully managed to conserve Apache infrastructure resources.</p> |
| <p>With the new style of web-site management, the only way to get information published |
| is to put it into SVN in our docs/ directory. By convention, generated information goes |
| under docs/d/.</p> |
| <p> |
| Since most generated information is associated with release versions, this can change |
| with each release. Our website often keeps links to the current, and maybe one previous |
| release. To make the consumption of SVN resources minimal, the following is suggested |
| as the way to update these. |
| </p> |
| <ul> |
| <li>Arrange to have files which don't change from release to release shared within the SVN.</li> |
| <li>Arrange to have files which change minimally, and which are "text", to take advantage of |
| SVN storage of differences between versions</li> |
| </ul> |
| <p>These two principles mean we should not just generate a new set of Javadocs, for instance, |
| and then commit them as xyz-version-2.4.0/ - this would add all these files as new ones. |
| Instead we need to do something like do an SVN copy (within SVN) of the previous files, |
| check that out, overwrite that with changes from the new generation, and check that back in.</p> |
| <p> |
| There is a webpage which details recommendations for how to do this: |
| <a target="_blank" rel="noopener" href="https://www.apache.org/dev/project-site.html#generated">https://www.apache.org/dev/project-site.html#generated</a>. |
| </p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Download CGI scripting"> |
| <h2>Download CGI scripting |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>The main download page, downloads.cgi in docs/ is specially crafted to interface with |
| Apache's mirror system for downloading. The actual download page is a "template" that the |
| cgi uses, substituting a randomly picked mirror site. Users which want to link to the |
| download page need to link to the .cgi version, to get a proper display of the webpage. |
| </p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="IP-Clearance documentation"> |
| <h2>IP-Clearance documentation |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p>We keep ip-clearance documentation for our project in /xdocs/ip-clearances, so they |
| can be iteratively developed.</p> |
| </blockquote> |
| </td></tr> |
| </table> |
| <table class="subsectionTable"> |
| <tr><td> |
| |
| |
| |
| <a name="Updating the release distribution META file"> |
| <h2>Updating the release distribution META file |
| </h2> |
| </a> |
| </td></tr> |
| <tr><td> |
| <blockquote class="subsectionBody"> |
| <p> |
| Apache runs a release checker, see <a target="_blank" rel="noopener" href="https://checker.apache.org/">https://checker.apache.org/</a>. |
| This requires that the Apache distribution SVN release spot has a META file, signed by the PMC chairperson. |
| The format of this file is described <a target="_blank" rel="noopener" href="https://checker.apache.org/doc/README.html#ch-meta">here</a>. |
| </p> |
| <p>Occasionally this file will need updating. To update this file, do the following: |
| <ul> |
| <li>"cd" to some spot to hold the svn checked-out of the META file</li> |
| <li>Checkout an empty dir: <code>svn co https://dist.apache.org/repos/dist/release/uima --depth empty</code></li> |
| <li>cd to the dir just checked out: cd uima</li> |
| <li>svn up META - should download the META file only</li> |
| <li>Edit the META file with any editor</li> |
| <li>regenerate the .asc signature file for the new META file: |
| <code>gpg -ba META</code>. The -b says to do a detached signature, the -a says to do ascii-armor version. |
| </li> |
| <li>commit the 2 changed files: |
| <ul><li><code>svn status</code> confirm that only the META and META.asc are changed</li> |
| <li><code>>svn commit -m "commit-message, say why changed"</code></li></ul> |
| </li> |
| </ul> |
| </p> |
| </blockquote> |
| </td></tr> |
| </table> |
| </blockquote> |
| </p> |
| </td></tr> |
| </table> |
| </td> |
| </tr> |
| <!-- FOOTER --> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| <tr><td colspan="2"> |
| <table class="pageFooter"> |
| <tr> |
| <td><a href="index.html">Home</a></td> |
| <td><a href="privacy-policy.html">Privacy Policy</a></td> |
| <td style="font-size:75%"> |
| Copyright © 2006-2013, The Apache Software Foundation.<br/> |
| Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/> |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </td> |
| <td><a href="mailto:dev@uima.apache.org">Contact us</a></td> |
| </tr> |
| </table> |
| </td></tr> |
| </table> |
| </body> |
| </html> |
| |
