bamaer commented on PR #9241:
URL: https://github.com/apache/hop/pull/9241#issuecomment-6624754119

   Thanks @Adalennis for this PR, and for the two outdated passages fixed along 
the way.
   
   Checked against `main`: the five values match the poms (`target.jdk.version` 
21, `apache-beam.version` 2.74.0, `spark.version` 3.5.8 in the Beam engine and 
4.1.3 in the native Spark engine, `beam-runners-flink-1.19`). No page defines 
an attribute with the same name, and the hop-website playbooks set no 
conflicting attributes. The blocks that now have `subs="attributes+"` contain 
no other `{…}` text.
   
   **Should fix**
   
   1. Nothing tells a contributor to update these attributes. 
`creating-a-release.adoc` ("Change documentation version in release branch") 
still only mentions the documentation version and `prerelease` / 
`display_version`. These versions also change when a Beam, Spark or JDK upgrade 
is merged, not only at release time, so `main` (published as `next`) would show 
the old value after such a bump. Suggested:
      - list the attributes and when to use them in 
`writing-documentation.adoc`;
      - add a comment next to `apache-beam.version` / `target.jdk.version` in 
the root pom and `spark.version` in both engine poms: "also update 
`docs/*/antora.yml`";
      - optionally add a check to the release step.
   
   **Nits / optional**
   
   2. The dev manual `antora.yml` defines all five attributes, but its pages 
only use `java-version`. Keeping only `java-version` there means fewer values 
to keep in sync.
   3. `cluster-mapping-walkthrough.adoc` now shows 
`SPARK_VERSION={spark-version}`, but that sentence describes the compose file, 
which pins `${SPARK_VERSION:-4.1.3}` itself 
(`docker/integration-tests/integration-tests-spark-native-cluster.yaml`). 
Either keep `4.1.3` hard-coded there, or add the compose file to the places to 
update.
   4. Same coupling, lower risk: `docker-build.adoc` and 
`docker-container.adoc` describe `docker/Dockerfile`, which installs 
`openjdk21-jre` by name.
   5. Hop Web page: "Hop 2.x is built with Java {java-version}" would read 
wrong after the next JDK bump. Suggested: "This version of Hop is built with 
Java {java-version}".
   6. `beamdebeziuminput.adoc:119` ("The Beam plugin distributes 
`beam-sdks-java-io-debezium` 2.74.0") is a current-version statement like the 
Snowflake and Splunk lines that were changed. Leaving it is defensible since 
the Debezium and Kafka versions in the same sentence are not attributes.
   7. `'21'` and `'1.19'` are quoted in YAML, the other three are not. Quoting 
all five avoids a future unquoted `1.20` being read as `1.2`.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to