Uploaded image for project: ' AGL Development'
  1. AGL Development
  2. SPEC-207

Automatic generation of online technical documentation website from Markdown

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Fixed
    • Icon: Major Major
    • Chinook
    • None
    • None
    • Markdown Based Tech Docs

      In order to simplify technical documentation maintenance, we propose to automate technical documentation webfile with an automatic extraction of Markdown files directly from gerrit, github,... repositories.

      The proposal is to leverage jekyll (https://jekyllrb.com) and scripts from cordova (http://cordova.apache.org/docs) to automate the process. An initial potential integration model is available at https://github.com/iotbzh/webdocs-tools. A companion dummy website is visible at http://docs.iot.bzh

      Next steps:

      • update templates to AGL
      • interface the system with Gerrit and revision process
      • automate the process and couple it with revisions mechanism
      • host everything on AGL

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

            fulup Fulup Ar Foll
            fulup Fulup Ar Foll
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: