Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-14995

[CAMEL-K] Not all traits pages are being generated

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.2.0
    • Fix Version/s: 3.3.0
    • Component/s: camel-k, website
    • Labels:
      None
    • Estimated Complexity:
      Unknown

      Description

      While working on https://issues.apache.org/jira/browse/CAMEL-14993 I noticed that these pages are not actually generated:

      delete mode 100755 docs/modules/ROOT/pages/traits/3scale.adoc
      delete mode 100755 docs/modules/ROOT/pages/traits/debug.adoc
      delete mode 100755 docs/modules/ROOT/pages/traits/master.adoc

      I also see:

      MacBook-Pro-2:camel-k david$ ./script/gen_doc.sh
      Generating traits documentation...
      W0430 09:59:35.227985 60469 parse.go:246] Ignoring child directory addons/master: unable to import "addons/master": package addons/master is not in GOROOT (/usr/local/Cellar/go/1.14.2_1/libexec/src/addons/master)
      W0430 09:59:35.329228 60469 parse.go:246] Ignoring child directory addons/threescale: unable to import "addons/threescale": package addons/threescale is not in GOROOT (/usr/local/Cellar/go/1.14.2_1/libexec/src/addons/threescale)

      I didn't see any instructions on how to generate the documentation, so I tried things until something happened.

      I think there are two problems:

      • some pages aren't getting generated
      • this isn't blindingly obvious.

      I suggest that to partly fix the second problem, the go doc generation for traits start by removing all the traits pages except the index page, traits.adoc. At least git status will then indicate a change. I don't know how to do this in go.

        Attachments

          Activity

            People

            • Assignee:
              djencks David Jencks
              Reporter:
              djencks David Jencks
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: