quarkiverse / quarkus-cxf

Quarkus CXF Extension to support SOAP based web services.
Apache License 2.0
76 stars 60 forks source link

Remove the doc link from the logging extension metadata #1241

Closed holly-cummins closed 6 months ago

holly-cummins commented 6 months ago

The io.quarkiverse.cxf:quarkus-cxf-rt-features-logging extension references https://docs.quarkiverse.io/quarkus-cxf/dev/reference/extensions/quarkus-cxf-rt-features-logging.html in its extension metadata. That docs page doesn't seem to exist anymore.

ppalaga commented 6 months ago

Yes, that's correct. Citing from our upcoming 3.8 announcement

Logging extension removed from the documentation and code.quarkus.io io.quarkiverse.cxf:quarkus-cxf-rt-features-logging is deprecated since Quarkus CXF 2.7.0, when all its functionality including configuration properties moved to io.quarkiverse.cxf:quarkus-cxf. In 3.8.0, we stopped mentioning it in the documentation and we removed it from code.quarkus.io. To keep backwards compatibility, a dummy io.quarkiverse.cxf:quarkus-cxf-rt-features-logging artifact still exists doing nothing else, but outputting a warning. You should remove the extension from your projects.

Is there anything else I can do?

holly-cummins commented 6 months ago

Is there anything else I can do?

The dummy io.quarkiverse.cxf:quarkus-cxf-rt-features-logging extension should either be marked deprecated, or have the link to the documentation removed in its extension metadata. We're less strict for deprecated extensions, and don't expect the links on those pages to be valid.

https://github.com/quarkiverse/quarkus-cxf/blob/ec77f4cec29dddf76bff615bc53b37a7f30cd042/extensions/features-logging/runtime/src/main/resources/META-INF/quarkus-extension.yaml shows the status as 'stable'. (Camel pioneered adding 'deprecated' to the actual status, so I've updated things to use it.)

It also looks like even if the extension metadata had a deprecated status, it wouldn't have made it into a release yet. As well as the changes above, ideally we wouldn't remove docs pages until the latest release no longer refers to them, but I know keeping docs and code in sync is tricky when there's two distinct release cycles involved.

ppalaga commented 6 months ago

Camel pioneered adding 'deprecated'

Would it be separated by space from the actual status, like status: stable deprecated ?

holly-cummins commented 6 months ago

It's usually done as an array, for example (taken from https://github.com/apache/camel-quarkus/blob/main/extensions/joor/runtime/src/main/resources/META-INF/quarkus-extension.yaml)

  status:
  - "stable"
  - "deprecated"

The Camel extensions may also do something extra with the deprecated status, because I can see it gets carried across into a [generated metadata file](https://github.com/apache/camel-quarkus/blob/55759dbcd7bc4cc907d8fa4894b296a95530cd5f/docs/modules/ROOT/examples/languages/joor.yml#L7], but I don't know what it gets used for after that!

ppalaga commented 6 months ago

docs/modules/ROOT/examples/languages/joor.yml is IIRC a data file for generating some antora pages.

OK, let me set the deprecated status and remove the guide link.

ppalaga commented 6 months ago

I plan to release 3.8.1 within a couple of days, once CXF 4.0.4 is out.