Web-based documentation should be automatically updated

Create issue
Issue #1039 new
Ian Hinder created an issue

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.

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.

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.

Keyword: Documentation

Comments (2)

  1. Frank Löffler
    • removed comment

    We could always point people to the repositories itself, as long as we keep the pdfs in there and the uploader did actually build a new version (which I hope they did, as they should test what they upload). The downside is that you might often get conflicts on the pdfs. On the other hand, they are very easy to solve.

  2. Frank Löffler
    • removed comment

    Ian - please let me know if the login-info I've sent you works. For others: there is now an account that can be used to automatically push to the ET website.

  3. Log in to comment