Peer review and testing checklist

[evelinec]

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. 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:

• 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 with continuous daily builds

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

[evelinec]

@NimG98 can you do the following. I think it makes sense for you to do them. Thanks.

• 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 with continuous daily builds

[evelinec]

Talked to @NimG98, she will do the testing on Windows platform as she has the laptop. Thanks.

[evelinec]

Tested on Linux with centralus location and it's working.

[NimG98]

Tested on Windows successfully, with centralus location.

[NimG98]

@evelinec I changed the titles and descriptions for the guide and SEO to include "Microsoft" instead of being just "Azure", it's now "Microsoft Azure". Can you look at the changes to see if it's okay?

[evelinec]

Verified one successful run of the daily build test for this draft guide. Verified the SEO changes. Looks good. Completed and closed.