OpenLiberty/guide-microprofile-rest-client

Peer Review: New 1.2/1.3 features

salmad3 opened this issue · 4 comments

salmad3 commented

Peer Review: review to be done by a peer member.

  • Check that the guide has working instruction and sample code
  • Check the quality of code according to the best coding practices
  • Check the quality and presentation of guide according to Structure and Style Guideline
  • Check the consistency of guide with template and other guides
  • Examples with the right outcomes are provided
  • Example with the wrong outcomes, if any, are provided
  • Check that all licensing statements are properly stated in all files
  • Check that the pom.xml, server.xml, etc files are clean
  • Check that the directories are properly structured
  • Test the guide on 3 platforms: Mac, Win, Linux
  • If any URL visits, try them on different browsers: Firefox, Chrome, Safari
  • If any URL visits, try curl command where applicable
  • Ensure that the guide is using the latest version of the liberty-maven-plugin or liberty-gradle-plugin where applicable
  • Check that some of these page-tags are used in a guide: MicroProfile, Maven, Docker, Kubernetes, Gradle, Java EE, Security, Cloud. Only these tags are visible on the website. Latest list here.
  • Check the attribution statement is accurate for the guide

Peer Testing: tests to be done by a peer member.

Guide’s contributor’s (if available, otherwise peer tester’s) responsibility:

  • Define test coverage and review with team (including guide contributor, if available)
  • Define detail test cases
  • Consider corner cases targeting the specific guide
  • Consider different platform tests, ie, Mac, Windows, Linux
  • Consider corner cases UI tests
  • Consider testing URL on all browsers, ie, FF, Chrome, Safari
  • Consider testing the curl command for URL visits
  • Consider Consider building with both Maven and Gradle build tools
  • Testing with different IDEs, ie, Atom, VS.code, Eclipse, IntelliJ, Microclimate
  • Run Acrolinx Checker on draft (above 70 score approximately)
  • Consider SEO title and description for the guides
  • Ensure automated test is enable, set up with Travis CI, and able to schedule tests
  • Run diff -r start/ finish/ and there's no differences
  • Ensure that the automation tests are able to run when PR is created

Peer Tester’s responsibility:

  • Check the appearance of the guide on test site for the following items:
  • Table of contents
  • Headings
  • Paragraphs
  • code snippets
  • outputs
  • links
  • hotspots
  • Test the guide end-to-end with working instruction and sample code
  • Perform all the defined test cases
salmad3 commented

Enhancements

What you'll learn

  • Might be a good idea to have a link regarding Context and Dependency Injection (CDI) and RestClientBuilder for user reference.

image

Writing the RESTful client interface

  • Arrowhead does not highlight code panel properly

image

salmad3 commented

Overall changes and additions are good

evelinec commented

Added a link to CDI doc as the online doc is very good. Also added a link to the intro blog post for RestClientBuilder. Hope these help.

Also fixed the hotspot issue.

  • 👍1
evelinec commented

Addressed in 38f1cdb. @DannyS03 can you review?