Skip to content

Update Java and CORS template docs - #362

Merged
alexellis merged 3 commits into
openfaas:masterfrom
welteki:update-java-template-docs
Sep 29, 2026
Merged

Update Java and CORS template docs#362
alexellis merged 3 commits into
openfaas:masterfrom
welteki:update-java-template-docs

Update Java homepage handler example

889a4ee
Select commit
Loading
Failed to load commit list.
reviewfn / AI Code Review succeeded Sep 28, 2026 in 1m 24s

AI Code Review Results

AI Pull Request Overview

Disclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification.

Summary

  • Documentation-only PR updating Java OpenJDK 11 tutorial content, Java landing-page sample code, and CORS template names.
  • The Java examples mostly align with the newer handler base class and java11-vert-x naming.
  • The CORS template list is refreshed to current template names.
  • One Java tutorial dependency snippet still uses the removed Gradle compile configuration, which undercuts the stated migration goal.

Approval rating (1-10)

7/10. The scope is useful, but the Java tutorial still contains a dependency syntax regression that can break readers following the updated steps.

Summary per file

Summary per file
File path Summary
_includes/landing-page/code-examples/java.html Updates Java sample to extend AbstractHandler.
_posts/2020-01-30-get-started-with-java-openjdk11.md Refreshes Java tutorial images, APIs, commands, examples, and links.
_posts/2020-04-08-function-cors.md Updates CORS-compatible template names.

Overall Assessment

The PR moves stale documentation in the right direction and fixes several outdated references. However, the updated Java tutorial still tells readers to add OkHttp dependencies with Gradle's removed compile configuration, while the PR's purpose is explicitly to replace that syntax. That is a concrete reproducibility issue for the primary tutorial path and should be fixed before merge.

Detailed Review

Detailed Review

Content review

Medium: Java tutorial still uses removed Gradle compile configuration for OkHttp dependencies

In _posts/2020-01-30-get-started-with-java-openjdk11.md lines 152-159, the tutorial says to keep the template dependencies and add:

compile 'com.squareup.okhttp3:okhttp:3.10.0'
compile 'com.squareup.okio:okio:1.14.1'

This is the same removed Gradle configuration the PR description says it is replacing. The later Vert.x dependency snippet was updated to implementation, so readers following Example 1 can still hit a Gradle configuration failure or copy outdated syntax into the refreshed Java 11 template. Use implementation for both OkHttp dependencies:

implementation 'com.squareup.okhttp3:okhttp:3.10.0'
implementation 'com.squareup.okio:okio:1.14.1'

The title and excerpt still match the article's scope: getting started with Java 11 and Vert.x on OpenFaaS. The opening clearly explains the image and dependency-source changes. The Example 1 flow is otherwise coherent after switching from QuoteGarden to DummyJSON, and the CORS article's changed section is concise and limited to template-name maintenance.

AI agent details.

Agent processing time: 1m9.829s
Environment preparation time: 5.891s
Total time from webhook: 1m29.867s
View more details on reviewfn