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

Document existing Kogito Addons

    XMLWordPrintable

Details

    • False
    • False
    • Documentation (Ref Guide, User Guide, etc.)
    • Undefined
    • 2021 Week 25-27 (from Jun 21), 2021 Week 28-30 (from Jul 12), 2021 Week 31-33 (from Aug 2), 2021 Week 34-36 (from Aug 23), 2021 Week 37-39 (from Sep 13), 2021 Week 40-42 (from Oct 4), 2021 Week 43-45 (from Oct 25), 2021 Week 46-48 (from Nov 15)

    Description

      One thing that contributes to making things harder to understand the addons is the lack of documentation in the repository. Each addon should have its own "README.md" file with a short description and an example of usage. Or even (preferred) a link to the official documentation.

      From this doc: https://docs.google.com/document/d/1Oj9ihhWdOZsErGJzGIRss6KgVeFZ927us1hebhdJl7U

      We must add at least a short documentation about each addon in our code base to make it easier for users to understand the addons usage.

      Attachments

        Issue Links

          is blocked by

          Enhancement - An enhancement to or refactoring of existing functionality that is not configurable by an end user (typically a change made by an internal team that affects users) KOGITO-5356 Move all runtime addons to their respective Runtime modules

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Resolved
          relates to

          Enhancement - An enhancement to or refactoring of existing functionality that is not configurable by an end user (typically a change made by an internal team that affects users) KOGITO-5299 Refactor Addons Modules structure

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Resolved
          There are no Sub-Tasks for this issue.

          Activity

            People

              rhn-support-zanini Ricardo Zanini Fernandes
              rhn-support-zanini Ricardo Zanini Fernandes
              Marian Macik Marian Macik
              Marian Macik Marian Macik
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: