Uploaded image for project: 'Kogito'
  1. Kogito
  2. KOGITO-7701

Auto generate config guide for Serverless Workflow

    XMLWordPrintable

Details

    • False
    • None
    • False
    • ---
    • ---

    Description

      SInce our properties are added to Config beans from Quarkus, we should be able to auto-generate the contents of https://github.com/kiegroup/kogito-docs/blob/main/serverlessworkflow/modules/ROOT/pages/core/configuration-properties.adoc

      See code for:

      It should be a similar process for what Quarkus already does for its page https://quarkus.io/guides/all-config

      Implementation ideas:

      1. Fetch all configuration properties from quarkus/addon and quarkus/extension. Every field or method with ConfigItem annotation is a configuration property from Kogito.
      2. Read all the properties from the property: name, default value, type, and description (this last one from the Java Doc). If a property doesn't have a Java Doc, fail the build.
      3. With this input, generate the AsciiDoc table for the kogito-docs, configuration guide. This step must be a Maven Build parameterized step. So we won't generate this file every time we do a build. For example mvn clean install -DgenerateConfigDocs
      4. In the Kogito Docs repo, create a GH Action to fetch kogito-runtimes, run the generate config docs steps and compare with the current main. This action must run every day.
      5. If there's a difference between the tables, open a PR to replace it.

      Attachments

        Activity

          People

            rhn-support-zanini Ricardo Zanini Fernandes
            cnicolai@redhat.com Cristiano Nicolai
            Gonzalo Muñoz Fernández Gonzalo Muñoz Fernández
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: