JOSDK v5: Documentation improvements

[ebma16]

Hey,

I'm currently updating in my project josdk to the 5.0.0-beta1. So I am currently reading through the documentation in order to update the registration of the EventSources in my reconcilers.

I have thought about the following topics/suggestions:

1. I came across the following examples while updating:

• java-operator-sdk/docs/content/en/docs/features/_index.md

  Line 476 in 9911a63

  InformerConfiguration.from(Tomcat.class, context)

• java-operator-sdk/docs/content/en/docs/features/_index.md

  Line 675 in 9911a63

  new InformerEventSource<>(InformerConfiguration.from(ConfigMap.class)

From what I can see, the “InformerConfiguration” class does not provide a “from” method anymore (changed with v5). In the example, this should rather be the class “InformerEventSourceConfiguration”, can that be?

2. The examples in the documentation (such as the one mentioned above) show a simple configuration of an ES using the “InformerEventSourceConfiguration” class and refer to an example in an integration test. Some configurations are now also carried out via the “InformerConfiguration” class (e.g. setting onUpdateFilter), it would perhaps also be helpful to integrate an example of this into the documentation, or to refer to an integration test that contains such a config, such as this one.

3. The Migration Guide mentions the prepareEventSources method, but does not describe what needs to be adapted there. Perhaps it would be helpful to refer to the documentation for an example.

4. This link in the Migration Guide is not accessible and should be adjusted.

5. This example in the documentation is outdated. It should be updated to context. managedWorkflowAndDependentResourceContext(), right?

What do you think about these topics?

Best regards
Martin

[csviri]

thank you very much @ebma16 !

I came across the following examples while updating:

I fixed the outdated docs from this section

The Migration Guide mentions the prepareEventSources method, but does not describe what needs to be adapted there. Perhaps it would be helpful to refer to the documentation for an example.

This section was removed, the migration guide simply points to the blog.

This link in the Migration Guide is not accessible and should be adjusted.

fixed it.

This example in the documentation is outdated. It should be updated to context. managedWorkflowAndDependentResourceContext(), right?

fixed