search

apache / camel-quarkus

Apache Camel Quarkus
https://camel.apache.org
Apache License 2.0
256 stars 189 forks source link

Improve the Avro extension page #3194

Closed ppalaga closed 2 years ago

ppalaga commented 2 years ago

On https://camel.apache.org/camel-quarkus/latest/reference/extensions/avro.html#_additional_camel_quarkus_configuration the docs says

Beyond standard usages known from vanilla Camel, Camel Quarkus adds the possibility to parse the Avro schema at build time both in JVM and Native mode via the @BuildTimeAvroDataFormat annotation.

@BuildTimeAvroDataFormat is also used in a code snippet.

We should fully qualify the class name either in both occurences or at least in the snippet.

ppalaga commented 2 years ago

There are also some fomatting issues on the page. @BuildTimeAvroDataFormat and all file paths/globs should be monospaced.

ppalaga commented 2 years ago

Maybe the page should explain "The build time class generation approach from quarkus-avro is preferred." in more detail. Esp. we should document that quarkus-maven-plugin:generate-code is needed: https://github.com/apache/camel-quarkus/blob/main/integration-tests/avro/pom.xml#L97

jamesnetherton commented 2 years ago

Do we even need to mention BuildTimeAvroDataFormat in the docs? It's deprecated. At a minimum we should give precedence to the quarkus-maven-plugin code generation.

ppalaga commented 2 years ago

Do we even need to mention BuildTimeAvroDataFormat in the docs? It's deprecated. At a minimum we should give precedence to the quarkus-maven-plugin code generation.

Yeah, I have put the preferred approach with quarkus-maven-plugin at the top. @BuildTimeAvroDataFormat is still there. I hope it is fine like that for now, isn't it?

jamesnetherton commented 2 years ago

I hope it is fine like that for now, isn't it?

Yeah, looks fine 👍