Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing paragraphs #93

Open
yeekangc opened this issue Oct 10, 2019 · 0 comments
Open

Confusing paragraphs #93

yeekangc opened this issue Oct 10, 2019 · 0 comments

Comments

@yeekangc
Copy link
Member

yeekangc commented Oct 10, 2019

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 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 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 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 yeekangc changed the title Confusing paragraph Confusing paragraphs Oct 10, 2019
@salmad3 salmad3 self-assigned this Nov 22, 2019
@salmad3 salmad3 removed their assignment Feb 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants