guide-rest-intro icon indicating copy to clipboard operation
guide-rest-intro copied to clipboard

Confusing paragraphs

Open yeekangc opened this issue 6 years ago • 0 comments

Configures the server to resolve the HTTP port numbers from variables, which are then specified in the Maven pom.xml file. This is specified in the <httpEndpoint/> element. Variables use the syntax ${variableName}.

The above can be improved. It's unclear whether the server configuration is what's in the POM file or it's the httpEndpoint element.

Should make it clear that the server configuration is done in the server.xml via the httpEndpoint for the HTTP ports. Then, the values are specified or fed in through the POM file as properties there.

Configures the server to run the produced Web application on a context root specified in the pom.xml file. This is specified in the <webApplication/> element.

Similarly, the above is confusing too. What is a "produced Web application"? It's hard to understand the hotspots together with what's written.

The variables being used in the server.xml file are provided by the properties set in the Maven pom.xml file. The properties must be formated as liberty.var.variableName.

It may be easier or clearer to state that the server configuration is parameterized or configured with variables. And, the values for these variables will be defined in and be picked up from the POM file.

The test code needs to know some information about the application in order to make requests. The server port and the application context root are key, and are dictated by the server configuration. While this information can be hardcoded, it is better to specify it in a single place like the Maven pom.xml file. Refer to the pom.xml file to see how the application information such as the default.http.port, default.https.port and app.context.root elements are provided in the file.

These Maven properties are then passed to the Java test program as the <systemPropertyVariables/> element in the pom.xml file.

Similar issues with the above. Looking at the history, what was there in the single pane version is much better: https://github.com/OpenLiberty/guide-rest-intro/tree/singlepane

yeekangc avatar Oct 10 '19 19:10 yeekangc