Uploaded image for project: 'VOLTHA'
  1. VOLTHA
  2. VOL-1425

Transition of documentation to gitbook

    XMLWordPrintable

    Details

    • Story Points:
      3

      Description

      Discuss and consider using gitbook to document VOLTHA.

      Issues to discuss:

      • Where will documentation be located?
        • Aggregation of documents in multiple repos into a single site
      • Documentation workflow
        • Generation of images/diagrams
        • How to update documentation on released versions/branches
      • Is there existing documentation in the wiki that should be converted?
      • Publishing and QA pipeline for docs
        • Verification of docs: markdown lint (ruby) and linkchecker (python)
        • Building with gitbook (npm)
        • Publishing on a website (need to create this, like guide.opencord.org - maybe voltha.opencord.org ?)

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              zdw Zack Williams
              Reporter:
              zdw Zack Williams
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes