<html>#1039: Web-based documentation should be automatically updated
<table style='border-spacing: 1ex 0pt; '>
<tr><td style='text-align:right'> Reporter:</td><td>Ian Hinder</td></tr>
<tr><td style='text-align:right'> Status:</td><td>new</td></tr>
<tr><td style='text-align:right'>Milestone:</td><td></td></tr>
<tr><td style='text-align:right'> Version:</td><td></td></tr>
<tr><td style='text-align:right'> Type:</td><td>enhancement</td></tr>
<tr><td style='text-align:right'> Priority:</td><td>minor</td></tr>
<tr><td style='text-align:right'>Component:</td><td>EinsteinToolkit website</td></tr>
</table>
<p>Changes (by Roland Haas):</p>
<p><table>
<tr><td>assignee:</td><td>Roland Haas (was )</td></tr>
<tr><td>responsible:</td><td>[] (was )</td></tr>
</table></p>
<p>We have documentation for Cactus and the ET on their respective websites. This should be updated automatically when the source is changed, so it is never out of date. There should be documentation for the current release as well as the current development version.</p>
<p>There is one technical problem standing in the way of this. The system should be automated, and it needs to have commit rights to a specific directory in the SVN repository hosting the files. SVN accounts for CCT machines tend to be the same as CCT login accounts, so we don't want to store the username and password. I think the best solution is to create an SVN account specifically for the documentation build system which is not tied to a CCT login account. This account would be given commit access to just the directories necessary.</p>
<p>The "checkout, build doc, commit" script should be kept in version control somewhere, and a machine should be chosen on which to run it. It could be run regularly, or just in response to commits.</p>
<p><strong>Keyword:</strong> Documentation</p>
<p>--<br/>
Ticket URL: <a href='https://bitbucket.org/einsteintoolkit/tickets/issues/1039/web-based-documentation-should-be'>https://bitbucket.org/einsteintoolkit/tickets/issues/1039/web-based-documentation-should-be</a></p>
</html>