Peer Review for Linux

[gkwan-ibm]

Review and test this guide by a peer member with the following prespectives

• by Firefox

README

• Ensure that command substitutions use the $(cmd) format and not `cmd`
• Ensure that the console output of the integrated tests do not include the [INFO] tab
• Check the quality and presentation of guide according to Structure and Style Guideline
• Check the appearance of the guide:
  • Table of contents
  • Headings
  • Paragraphs
  • code snippets
  • outputs
  • links (shoud open a new tab)
  • hotspots (should highlight the code correctly)
• Check that the pom.xml, server.xml, and java files etc files are clean on the right code pane
  • Remove any dependencies and features that are not required
  • Ensure that the parent pom.xml files do not contain any dependencies, and all dependencies are specified in the children pom.xml files
  • lines are not too long and wrapped
  • lines are aligned nicely
• Examples with the right outcomes are provided
• Examples with the wrong outcomes, if any, are provided
• Run Acrolinx Checker (above 70 score approximately)

pom.xml

• Check that the file follows the template found here: https://github.com/OpenLiberty/draft-guides-template/blob/draft/finish/pom.xml
• Check that the dependencies and plugins are latest in all of the pom.xml files:
  • jakarta.jakartaee-api
  • microprofile
  • liberty-maven-plugin
  • etc.
• Check that there are 4 spaces per indent for proper formatting
• Check that no tab characters are used

Overall checks:

• Check the consistency of guide with the template and other guides
• Check the quality of code according to the best coding practices
• Check that all licensing statements are properly stated in all files, with the correct year (Should be present in all Java files + the index.html)
• Check that the directories are properly structured
• Check that some of these page-tags are used in a guide: MicroProfile, Maven, Docker, Kubernetes, Gradle, Jakarta EE, Security, Cloud. Only these tags are visible on the website. Latest list here.
• Check the attribution statement is accurate for the guide
• Verify the GitHub Actions scripts, if any, are accurate and consistent with other guides

Additional tests:

• tests where applicable:
  • Define test coverage and review with team (including guide contributor, if available)
  • Define detail test cases
  • Consider corner cases targeting the specific guide
  • Consider corner cases UI tests
  • Consider testing the curl command for localhost URLs
  • Make sure the index.html information is correct by visiting the root, e.g. http://localhost:9080
• Testing with different IDEs, ie, Atom, Eclipse (Optional: VS.code, IntelliJ, Microclimate)
  • import the finish directory and see any complication error, unused import packages, etc
• Consider SEO title and description for the guides
• Ensure automated tests with GitHub Actions are enabled
• Run diff -r start/ finish/ and there is no differences expect tag and end comments
• Ensure that the automation tests are able to run when PR is created
• Test the guide end-to-end with working instruction and sample code with either of the following Java
  • Java 11
  • Java 17
• Perform all the defined test cases

[AndrewSasmito]

Suggestion 1:

I think you should specify the blue button is the "Run query" button

Suggestion 2:
"Open the RED Metrics (classic histogram) dashboard to get an overview of the HTTP request performance." -> "Navigate back to the dashboard and open the RED Metrics (classic histogram) dashboard to get an overview of the HTTP request performance."

Suggestion 3:

Warnings appear when running the tests for system.

Suggestion 4:
No tags appear on the draft site:

[AndrewSasmito]

#26

PR to fix pom formatting

[AndrewSasmito]

I think you should show what the correct output is.

[AndrewSasmito]

Update the maven dependency: jakarta.platform:jakarta.jakartaee-api .............. 10.0.0 -> 11.0.0

[AndrewSasmito]

The line is slightly too long in SystemClient.java, causing the code to wrap around : "

[shin19991207]

Suggestion 3:

The startup health check in the SystemStartupCheck class can report DOWN if CPU usage is high, which is common on virtual machines with limited resources; this does not impact application functionality and can be safely ignored.

Suggestion 4:

Tags will appear in prod site.

Update the maven dependency: jakarta.platform:jakarta.jakartaee-api .............. 10.0.0 -> 11.0.0

Open Liberty does not yet offer full support for Jakarta EE 11.