You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2017/09/29 18:30:10 UTC
svn commit: r1810144 - in /uima/site/trunk/uima-website:
docs/dev-eclipse-plugin-archiving.html docs/eclipse-update-site.html
xdocs/dev-eclipse-plugin-archiving.xml xdocs/eclipse-update-site.xml
Author: schor
Date: Fri Sep 29 18:30:10 2017
New Revision: 1810144
URL: http://svn.apache.org/viewvc?rev=1810144&view=rev
Log:
[UIMA-5594]
Modified:
uima/site/trunk/uima-website/docs/dev-eclipse-plugin-archiving.html
uima/site/trunk/uima-website/docs/eclipse-update-site.html
uima/site/trunk/uima-website/xdocs/dev-eclipse-plugin-archiving.xml
uima/site/trunk/uima-website/xdocs/eclipse-update-site.xml
Modified: uima/site/trunk/uima-website/docs/dev-eclipse-plugin-archiving.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/dev-eclipse-plugin-archiving.html?rev=1810144&r1=1810143&r2=1810144&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/dev-eclipse-plugin-archiving.html (original)
+++ uima/site/trunk/uima-website/docs/dev-eclipse-plugin-archiving.html Fri Sep 29 18:30:10 2017
@@ -227,7 +227,8 @@
Each of those subsites typically has several versions of the plugins; a release process adds fresh versions of plugins to that site.
</p>
<p>At some point, there are too many versions, and it makes sense to archive these older ones.
- This requires updating metadata objects, which in turn requires running special tooling.
+ To do this you need to run Eclipse special tooling to keep the artifacts.jar and content.jar artifacts
+ in sync with the features and plugins.
</p>
</blockquote>
</p>
@@ -257,7 +258,30 @@
</td></tr>
<tr><td>
<blockquote class="sectionBody">
- <p />
+ <p>The basic strategy is to have multiple update sites:
+ <ul><li>A more-or-less current one, which has the most recent plugins, plus perhaps a few of the older releases</li>
+ <li>Older plugin site(s) (not too many) which contain ranges of plugins</li>
+ </ul>
+ </p>
+ <p>A typical imagined timeline would be
+ <ul>
+ <li>A subsite is started (e.g. ruta, or uimaj)</li>
+ <li>Releases occur, and plugins are added at some version level</li>
+ <li>After some number of releases, a decision is made that the repo is getting too big.
+ At that point, a small number (default, just the most recent) version is sliced off
+ into another repo.</li>
+ <li>The old repo is renamed with a suffix indicating the range of versions in it. For example,
+ the "uimaj" repo might have a name uimaj-2.3.1-2.10.0.</li>
+ <li>The new slice repo, with perhaps just one (the latest version) is then deployed.
+ A one-time update to the site
+ documentation is made to indicate where to find older eclipse plugins (the Apache archive site, following the
+ the naming conventions: uima/eclipse-update-site/---subsitename-x.x.x-y.y.y).</li>
+ <li>After confirming that the renamed old site is visible in Archive, then it is deleted on the main release site.</li>
+ </ul>
+ </p>
+ <p>A typical new slice would have just the latest version in it, and would then be added to over time, with additional
+ releases. When it gets too big, the same procedure is repeated, with a new named update site .../---subsitename.u.u.u-v.v.v
+ with another range set being created and archived.</p>
</blockquote>
</p>
</td></tr>
@@ -265,15 +289,25 @@
<div class="sectionTable">
<table class="sectionTable">
<tr><td>
- <a name="Tools for archiving"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Tools for archiving</h1></a>
+ <a name="Doing the slicing and updating the site"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Doing the slicing and updating the site</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
- <p>The only tool I've found for removing releases from a p2 repository (update subsite) is documented here:
+ <p>The eclipse ant tasks for maintaining update sites are documented here:
https://help.eclipse.org/neon/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fp2_repositorytasks.htm .
- It's an eclipse ant task. These need to be run using the special eclipse ant task runner. This is documented here:
- https://stackoverflow.com/questions/2327393/running-p2-ant-tasks-outside-eclipse.
- </p>
+ </p>
+ <p>This ant task is used in a Maven project, located in uima/build, named: uima-eclipse-update-site-slicing.
+ This does the slicing described above. To use, check out this project as a maven project (it's not a Java project), and
+ read the readme.txt, and follow the instructions.</p>
+ <p>When it runs, it reads the existing subsite directly from the dist.apache.org repository, and builds the request slice
+ in the project's target/eclipse-update-site/---subsite--- directory.</p>
+ <p>To complete the maintenance, do these steps in the dist.apache.org svn release eclipse-update-site:
+ <ol>
+ <li>Do a sanity test of the new subsite - try installing it into a fresh Eclipse install.</li>
+ <li>svn mv to rename the current subsite to the versioned name.</li>
+ <li>once it appears on the archive spot, do an svn delete to remove it </li>
+ <li>import the new (pruned) subsite to the release spot.</li>
+ </ol></p>
</blockquote>
</p>
</td></tr>
Modified: uima/site/trunk/uima-website/docs/eclipse-update-site.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/eclipse-update-site.html?rev=1810144&r1=1810143&r2=1810144&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/eclipse-update-site.html (original)
+++ uima/site/trunk/uima-website/docs/eclipse-update-site.html Fri Sep 29 18:30:10 2017
@@ -227,6 +227,10 @@
Introduction
</a></li>
+ <li><a href='#Information for developers'>
+ Information for developers
+
+ </a></li>
<li><a href='#P2'>
P2
@@ -279,13 +283,31 @@ and their plugins, at different "version
mechanisms to install whatever version a user might require.
</p>
<p>
-Because of this, the update site itself keeps "older" versions. Every
+Because of this, the update site itself may keep some of the "older" versions. Every
time a new release is made which includes one or more new versions of some
Eclipse features/plugins, the new artifacts are <em>added</em> to
the set of existing (and perhaps, older versions of) feature and plugins.
</p>
</blockquote>
</td></tr>
+ </table>
+ <table class="subsectionTable">
+ <tr><td>
+
+
+
+ <a name="Information for developers">
+ <h2>Information for developers
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>See these pages <a target="_blank" href="dev-eclipse-plugin-archiving">for information about archiving</a>
+ and <a target="_blank" href="dev-eclipse-plugin-signing">for information about plugin signing</a>.
+</p>
+ </blockquote>
+ </td></tr>
</table>
<table class="subsectionTable">
<tr><td>
Modified: uima/site/trunk/uima-website/xdocs/dev-eclipse-plugin-archiving.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/dev-eclipse-plugin-archiving.xml?rev=1810144&r1=1810143&r2=1810144&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/dev-eclipse-plugin-archiving.xml (original)
+++ uima/site/trunk/uima-website/xdocs/dev-eclipse-plugin-archiving.xml Fri Sep 29 18:30:10 2017
@@ -32,8 +32,10 @@ under the License.
</p>
<p>At some point, there are too many versions, and it makes sense to archive these older ones.
- This requires updating metadata objects, which in turn requires running special tooling.
+ To do this you need to run Eclipse special tooling to keep the artifacts.jar and content.jar artifacts
+ in sync with the features and plugins.
</p>
+
</section>
<section name="Goals for archiving">
@@ -46,15 +48,54 @@ under the License.
</section>
<section name="Strategy for archiving">
- <p></p>
+ <p>The basic strategy is to have multiple update sites:
+ <ul><li>A more-or-less current one, which has the most recent plugins, plus perhaps a few of the older releases</li>
+ <li>Older plugin site(s) (not too many) which contain ranges of plugins</li>
+ </ul>
+ </p>
+
+ <p>A typical imagined timeline would be
+ <ul>
+ <li>A subsite is started (e.g. ruta, or uimaj)</li>
+ <li>Releases occur, and plugins are added at some version level</li>
+ <li>After some number of releases, a decision is made that the repo is getting too big.
+ At that point, a small number (default, just the most recent) version is sliced off
+ into another repo.</li>
+ <li>The old repo is renamed with a suffix indicating the range of versions in it. For example,
+ the "uimaj" repo might have a name uimaj-2.3.1-2.10.0.</li>
+ <li>The new slice repo, with perhaps just one (the latest version) is then deployed.
+ A one-time update to the site
+ documentation is made to indicate where to find older eclipse plugins (the Apache archive site, following the
+ the naming conventions: uima/eclipse-update-site/---subsitename-x.x.x-y.y.y).</li>
+ <li>After confirming that the renamed old site is visible in Archive, then it is deleted on the main release site.</li>
+ </ul>
+ </p>
+
+ <p>A typical new slice would have just the latest version in it, and would then be added to over time, with additional
+ releases. When it gets too big, the same procedure is repeated, with a new named update site .../---subsitename.u.u.u-v.v.v
+ with another range set being created and archived.</p>
+
</section>
-<section name="Tools for archiving">
- <p>The only tool I've found for removing releases from a p2 repository (update subsite) is documented here:
+<section name="Doing the slicing and updating the site">
+ <p>The eclipse ant tasks for maintaining update sites are documented here:
https://help.eclipse.org/neon/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fp2_repositorytasks.htm .
- It's an eclipse ant task. These need to be run using the special eclipse ant task runner. This is documented here:
- https://stackoverflow.com/questions/2327393/running-p2-ant-tasks-outside-eclipse.
- </p>
+ </p>
+
+ <p>This ant task is used in a Maven project, located in uima/build, named: uima-eclipse-update-site-slicing.
+ This does the slicing described above. To use, check out this project as a maven project (it's not a Java project), and
+ read the readme.txt, and follow the instructions.</p>
+
+ <p>When it runs, it reads the existing subsite directly from the dist.apache.org repository, and builds the request slice
+ in the project's target/eclipse-update-site/---subsite--- directory.</p>
+
+ <p>To complete the maintenance, do these steps in the dist.apache.org svn release eclipse-update-site:
+ <ol>
+ <li>Do a sanity test of the new subsite - try installing it into a fresh Eclipse install.</li>
+ <li>svn mv to rename the current subsite to the versioned name.</li>
+ <li>once it appears on the archive spot, do an svn delete to remove it </li>
+ <li>import the new (pruned) subsite to the release spot.</li>
+ </ol></p>
</section>
</body>
Modified: uima/site/trunk/uima-website/xdocs/eclipse-update-site.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/eclipse-update-site.xml?rev=1810144&r1=1810143&r2=1810144&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/eclipse-update-site.xml (original)
+++ uima/site/trunk/uima-website/xdocs/eclipse-update-site.xml Fri Sep 29 18:30:10 2017
@@ -44,13 +44,20 @@ mechanisms to install whatever version a
</p>
<p>
-Because of this, the update site itself keeps "older" versions. Every
+Because of this, the update site itself may keep some of the "older" versions. Every
time a new release is made which includes one or more new versions of some
Eclipse features/plugins, the new artifacts are <em>added</em> to
the set of existing (and perhaps, older versions of) feature and plugins.
</p>
</subsection>
+<subsection name="Information for developers">
+ <p>See these pages <a target="_blank"
+ href="dev-eclipse-plugin-archiving">for information about archiving</a>
+ and <a target="_blank" href="dev-eclipse-plugin-signing">for information about plugin signing</a>.
+</p>
+</subsection>
+
<subsection name="P2">
<p>
At some point in the evolution of the Eclipse update site mechanisms,