Uploaded image for project: 'WildFly'
  1. WildFly
  2. WFLY-13458

Issues in readme for microprofile-health QS

XMLWordPrintable

      (1) The order of the steps at the beginning is confusing:
      1. Solution section says to start EAP and deploy the QS
      2. Start the JBoss EAP XP Standalone Server section says start EAP and access the endpoints.
      Please consider using standard sections "Build and Deploy the Quickstart" and "Access the Application" instead.

      (2) Consider adding standard sections - see other (non-MP - because these were not yet tested)

      • Use of the EAP_HOME and QUICKSTART_HOME Variables
      • Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

      (3) Running the health check section says "The checks array is empty as we have not specified any health check procedure yet so let's define some." However, there are already the checks "Simple health check" and "Health check with data". It's because the endpoints are accessed after deploying the complete example, not during the step-by-step procedure.

      (5) WildFly used instead of EAP twice in:

      <!-- Import the MicroProfile Health API, we use provided scope as the API is included in WildFly -->
      <!-- Import the MicroProfile Config API, we use provided scope as the API is included in WildFly -->
      

      (6) The quickstart contains arquillian tests but readme does not mention them.

      (7) Missing section on how to undeploy the QS. Standard section Undeploy the Quickstart can be used.

              mstefank Martin Stefanko
              mstefank Martin Stefanko
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: