Uploaded image for project: 'CAS Server'
  1. CAS-974

Maintain CAS User Manual with Source

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.4.8
    • Fix Version/s: 4.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      As part of the push to improve documentation, managing the CAS user manual (and other essential documentation) as part of the CAS source would increase the coupling between source and documentation. While that is beneficial in general, a specific outcome is version-specific documentation. I have prototyped a Docbook-based manual that could easily fulfill this requirement. While the use of Docbook isn't required, it demonstrates the feasibility of the approach.

      On a related note, it would be desirable to automate the publishing of documentation upon release. The maven site plugin is one possible approach.

        Attachments

          Activity

            People

            • Assignee:
              serac Marvin Addison
              Reporter:
              serac Marvin Addison
            • Votes:
              2 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: