Uploaded image for project: 'Fabric'
  1. Fabric
  2. FAB-16865

Create a program that generates example configuration documents from annotated source

    XMLWordPrintable

Details

    • Story
    • Status: Backlog
    • Medium
    • Resolution: Unresolved
    • v2.0.0
    • Future
    • fabric-common
    • None

    Description

      Using the configuration model, create a program that will generate a valid yaml document that contains the example and/or default configuration for a structure.

      The program should be provided the name of the package containing the root structure and the name of the root structure type.

      The doc comments for each field should be used to comment each of the configuration elements. Where the field name is used in the godoc, it is replaced with the name of the configuration key. The documentation should properly flow to an appropriate line width while still preserving blank lines from the godoc.

      Attachments

        Activity

          People

            Unassigned Unassigned
            sykesm Matthew Sykes
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: