Uploaded image for project: 'Cloud Enablement'
  1. Cloud Enablement
  2. CLOUD-2172

[DOCS] Update docs to reflect cct_module refactoring

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • Documentation
    • Documentation (Ref Guide, User Guide, etc.)

      We have started the process of consolidating maven installation across all images into a single location, the maven module ( https://issues.jboss.org/browse/CLOUD-2139 ) . All of the labels, env vars, and packages specific to maven will be removed from the descriptor files of all images and then placed into the maven module. Now, the images using maven must instantiate the maven module in their respective image descriptor files.

      The maven module is just the first attempt at refactoring cct_module scripts (https://github.com/jboss-openshift/cct_module ) and other modules will be addressed in the near future. Therefore, the documentation should probably reflect this code restructuring. We could do this by dedicating an area of our documentation to modules and dividing it into sections based on functionality. For starters, we can create a generic file explaining module inheritance and how to instantiate a module from an image descriptor file, then have a separate page describing the maven module(e.g. what its used for and list maven specific env vars)

      This will allow for easier reference and maintenance of our code

            Unassigned Unassigned
            kliberti Kyle Liberti
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: