Details

    • Type: Task
    • Status: Closed
    • Priority: High
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: databroker, documentation
    • Labels:
      None

      Description

      Please create: docs folder with an index.rst file
      In docs/index.rst add a title called "Data Broker".

      order of files in index  should be:

      • release-notes
      • developer-guide
      • user-guide
      • tutorials/index – this is optional; if tutorials has no content or is missing, omit

      note that the file names may not always match what I've listed above

       

      create: Data Broker Developer Guide
       the document title should be "Data Broker Developer Guide"
       name the file: developer-guide.rst

      If your component needs to be configured by an end user, please create a User Guide.
       The title would be "Data Broker User Guide" and filename would be user-guide.rst

      Create release-notes.rst
      the document title should be "Data Broker Release Notes"
       name the file: release-notes.rst

      Update the index.rst file to reflect these changes

      Guidelines for writing content:
      https://wiki.acumos.org/display/DOCS/Content+Guide

      add the license/copyright to the top of all rst files; see https://wiki.acumos.org/display/AC/License+Templates

      If applicable, create a docs/images and/or docs/tutorials folder

      For more information see: https://wiki.acumos.org/display/DOCS/DocsReview

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            • Assignee:
              aimeeu Aimee Ukasick
              Reporter:
              lorraineawelch Lorraine Welch
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: