Uploaded image for project: 'Build'
  1. Build
  2. BUILD-24

Improvements/cleanup of readme files

    XMLWordPrintable

Details

    Description

      From BUILD-19:

      Current build-tools' README depend a lot on the artifact type to determine what information to put in the README files etc. One of the most visible flaws is that is the artifact is of type pom, the README will say this bundle includes Tomcat, which is not always desirable (i.e STK is not bundled with Tomcat).
      We could introduce a bundleType property to circumvent this; or have these bundle projects specify extra bundled artifacts (not necessarily visible to the project model, like with our tomcat bundles, specifically)

      Another possible improvement would be to remove the "If an INSTALL.txt [...]" bit conditionally. Probably not possible without a lot of work to print it only if the file exists, but we could remove it if the docu url is provided. And... do we use this at all?

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                gjoseph Magnolia International
                gjoseph Magnolia International
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: