Peer Review for Windows

[gkwan-ibm]

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

• by Chrome

  README

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

• [x] Run Acrolinx Checker (above 70 score approximately)

  pom.xml

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

• [x] Check that no tab characters are used

  Overall checks:

• [x] Check the consistency of guide with the template and other guides
• [x] Check the quality of code according to the best coding practices
• [x] 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)
• [x] Check that the directories are properly structured
• [x] 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.
• [x] Check the attribution statement is accurate for the guide

• [x] Verify the GitHub Actions scripts, if any, are accurate and consistent with other guides

  Additional tests:

• [x] tests where applicable:
  • [x] Define test coverage and review with team (including guide contributor, if available)
  • [x] Define detail test cases
  • [x] Consider corner cases targeting the specific guide
  • [x] Consider corner cases UI tests
  • [x] Consider testing the curl command for localhost URLs
  • [x] Make sure the index.html information is correct by visiting the root, e.g. http://localhost:9080
• [x] 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
• [x] Consider SEO title and description for the guides
• [x] Ensure automated tests with GitHub Actions are enabled
• [x] Run diff -r start/ finish/ and there is no differences expect tag and end comments
• [x] Ensure that the automation tests are able to run when PR is created
• [x] Test the guide end-to-end with working instruction and sample code with either of the following Java
  • [x] Java 11
  • [x] Java 17
• [x] Perform all the defined test cases

[gkwan-ibm]

better add instruction "press r to restart dev mode to pick up the change", like the end of this section https://openliberty.io/guides/jms-intro.html#creating-the-message-producer-in-the-system-service