Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
camac committed Sep 21, 2017
1 parent 1f03360 commit 3ca0ea9
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/Index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Ant has access to many commonly used steps such as manipluation of files in the

This project also includes a Plugin for Domino Designer which is used by the ANT task for building an NSF.

See the <<TasksLibrary,Documentation of the BuildXPages ANT Library>> that is provided later is this user guide for more information.
See the <<TasksLibrary,Documentation of the Headless Designer Plugin>> that is provided later is this user guide for more information.

The Plugin is basically an extension of the existing 'Headless Designer' system that was provided by IBM. The IBM Headless Designer system was a great start but could have used a little bit more love. There were a few annoyances, it was hard to tell when the build was finished, it was hard to tell that the build even started properly. There were some minor annoyances regarding project names and locations.
The mechanism also involved writing a text 'command file', which was fed in when starting designer. This means each build would always have to start designer, build and then shut it down. If designer did not shut down, then you couldn't start it up again and weird things like that.
Expand Down
5 changes: 5 additions & 0 deletions doc/tutorial_deployplugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,11 @@ BuildXPages provides 2 tasks that help to do all this for you. They are both uti
configureDynamicPlugins:: will edit the *platform.xml* to allow this dynamic loading of plugins. It will also create a backup copy of platform.xml
initDesignerSite:: will set up the link file to point to the update site that we want to load during startup of designer

[WARNING]
====
Use this deployment style at your own risk. Everything should be fine but just be aware you may need to do it again if you upgrade notes and a new platform.xml is created, or sometimes if you install other plugins using the IBM Notes User interface, it can reset the platform.xml file.
====

[source,xml]
----
include::../demo/deployplugins/build.xml[tag=configuredesigner]
Expand Down
18 changes: 16 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -858,7 +858,7 @@ <h4 id="_headless_domino_designer_plugin">Headless Domino Designer Plugin</h4>
<p>This project also includes a Plugin for Domino Designer which is used by the ANT task for building an NSF.</p>
</div>
<div class="paragraph">
<p>See the <a href="#TasksLibrary">Documentation of the BuildXPages ANT Library</a> that is provided later is this user guide for more information.</p>
<p>See the <a href="#TasksLibrary">Documentation of the Headless Designer Plugin</a> that is provided later is this user guide for more information.</p>
</div>
<div class="paragraph">
<p>The Plugin is basically an extension of the existing 'Headless Designer' system that was provided by IBM. The IBM Headless Designer system was a great start but could have used a little bit more love. There were a few annoyances, it was hard to tell when the build was finished, it was hard to tell that the build even started properly. There were some minor annoyances regarding project names and locations.
Expand Down Expand Up @@ -4037,6 +4037,20 @@ <h5 id="_deploying_to_dropins_style_designer_plugins_directory">Deploying to 'dr
</dd>
</dl>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">
<div class="paragraph">
<p>Use this deployment style at your own risk. Everything should be fine but just be aware you may need to do it again if you upgrade notes and a new platform.xml is created, or sometimes if you install other plugins using the IBM Notes User interface, it can reset the platform.xml file.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml"> &lt;target name="configuredesigner"&gt;
Expand Down Expand Up @@ -4114,7 +4128,7 @@ <h4 id="_conclusion_5">Conclusion</h4>
<div id="footer">
<div id="footer-text">
Version 1.0.0<br>
Last updated 2017-09-21 21:42:33 AEST
Last updated 2017-09-21 21:56:55 AEST
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css">
Expand Down
Binary file modified docs/index.pdf
Binary file not shown.
16 changes: 15 additions & 1 deletion docs/tutorial_deployplugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -1136,6 +1136,20 @@ <h4 id="_deploying_to_dropins_style_designer_plugins_directory">Deploying to 'dr
</dd>
</dl>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">
<div class="paragraph">
<p>Use this deployment style at your own risk. Everything should be fine but just be aware you may need to do it again if you upgrade notes and a new platform.xml is created, or sometimes if you install other plugins using the IBM Notes User interface, it can reset the platform.xml file.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml"> &lt;target name="configuredesigner"&gt;
Expand Down Expand Up @@ -1212,7 +1226,7 @@ <h3 id="_conclusion">Conclusion</h3>
<div id="footer">
<div id="footer-text">
Version 1.0.0<br>
Last updated 2017-09-20 21:10:34 AEST
Last updated 2017-09-21 22:04:26 AEST
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/styles/github.min.css">
Expand Down
14 changes: 14 additions & 0 deletions docs/tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -2088,6 +2088,20 @@ <h5 id="_deploying_to_dropins_style_designer_plugins_directory">Deploying to 'dr
</dd>
</dl>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">
<div class="paragraph">
<p>Use this deployment style at your own risk. Everything should be fine but just be aware you may need to do it again if you upgrade notes and a new platform.xml is created, or sometimes if you install other plugins using the IBM Notes User interface, it can reset the platform.xml file.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml"> &lt;target name="configuredesigner"&gt;
Expand Down

0 comments on commit 3ca0ea9

Please sign in to comment.