Uploaded image for project: 'Shindig'
  1. Shindig
  2. SHINDIG-283

Find a place to put documentation

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.1-BETA1
    • Component/s: Website
    • Labels:
      None

      Description

      Actually, the Shindig doc is mainly in README files, which is not very user friendly.
      So, we need to decide where to put Shindig documentation. I see the following options, each with pros and cons:

      • Maven project
      • Confluence
      • other ??

      The documentation should include:

      • user docs and FAQ on how to set Shindig in production, how to build it...
      • developer docs
      • project docs like ML, SVN...

      The documentation needs to be up to date so we need to release it often.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                vsiveton Vincent Siveton
                Reporter:
                vsiveton Vincent Siveton
              • Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: