Uploaded image for project: 'Accumulo'
  1. Accumulo
  2. ACCUMULO-1490

Consolidate documentation

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 1.6.0
    • docs, monitor

    Description

      Documentation is everywhere, and part of the problem keeping it up-to-date is lack of a standard way of packaging and presenting it, I think.

      We have:

      1. User manual (pdf and html)
      2. Example READMEs (plaintext and converted to html)
      3. Html docs packaged with the monitor server (but can be published independently, though I'm not sure the links will work)
      4. Generated configuration documentation included with html docs on the monitor

      These should be consolidated to a standard place (I prefer the website).

      Attachments

        Issue Links

          relates to

          Improvement - An improvement or enhancement to an existing feature or task. ACCUMULO-3891 Add link to user guide from monitor page

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. ACCUMULO-2576 Documentation Consolidation (Round Two)

          • Major - Major loss of function.
          • Resolved
          There are no Sub-Tasks for this issue.

          Activity

            People

              ctubbsii Christopher Tubbs
              ctubbsii Christopher Tubbs
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: