<!-- Liberty plugin -->
<plugin>
<groupId>io.openliberty.tools</groupId>
<artifactId>liberty-maven-plugin</artifactId>
<version>3.4</version>
</plugin>
- [x] Check that there are 4 spaces per indent for proper formatting
- [x] Ensure that the guide is using the latest version of the `liberty-maven-plugin` or `liberty-gradle-plugin` where applicable
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, Java EE, Security, Cloud`. Only these tags are visible on the website. Latest list [here](https://github.com/OpenLiberty/guides-common/blob/master/guide_tags.json).
- [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 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 URL on all browsers, ie, FF, Chrome, Safari
- [x] Consider testing the `curl` command for URL visits
- [x] Make sure the index.html information is correct by visiting the root, e.g. `http://localhost:9080`
- [ ] Consider building with both Maven and Gradle build tools
- [ ] Testing with different IDEs, ie, Atom, Eclipse (Optional: VS.code, IntelliJ, Microclimate)
- [ ] Run Acrolinx Checker on draft (above 70 score approximately)
- [x] Consider SEO title and description for the guides
- [x] Ensure automated tests with GitHub Actions are enabled
- [ ] Run `diff -r start/ finish/` and there's no differences
- [x] Ensure that the automation tests are able to run when PR is created
- [x] Check the appearance of the guide on test site for the following items:
- [ ] Table of contents
- [ ] Headings
- [ ] Paragraphs
- [ ] code snippets
- [ ] outputs
- [ ] links
- [ ] hotspots
- [x] Test the guide end-to-end with working instruction and sample code
- [x] Perform all the defined test cases
Peer Review conducted on 3 platforms: Mac, Windows & Linux
Peer Review: review to be done by a peer member.
Functionality
curl
command where applicableFormatting & Presentation
README.adoc
checks:$(cmd)
format and not`cmd`
[INFO]
tabpom.xml
checks (if files are present):pom.xml
files: