Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Feedback for CDC Connector #1345

Closed
pmcgleenon opened this issue Oct 24, 2024 · 4 comments · May be fixed by #1365
Closed

Docs: Feedback for CDC Connector #1345

pmcgleenon opened this issue Oct 24, 2024 · 4 comments · May be fixed by #1365
Assignees

Comments

@pmcgleenon
Copy link
Contributor

Hi, I have some feedback about this page

Both of these pages describe using the User Code Deployment feature, which is deprecated

https://docs.hazelcast.com/hazelcast/5.5/integrate/cdc-connectors
https://docs.hazelcast.com/hazelcast/5.5/pipelines/cdc-join#7-start-hazelcast-jet

They should be migrated to use UCN

@amandalindsay amandalindsay self-assigned this Nov 6, 2024
@amandalindsay
Copy link
Contributor

amandalindsay commented Nov 6, 2024

Hi @pmcgleenon Patrick,

Regarding this issue, I understand this topic included cross-refs to 2 topics which refer to the deprecated feature, User Code Deployment.

To fix this issue, is it simply a case of updating the 'Notes' as follows:

1st note:
NOTE: This page refers to Hazelcast's {enterprise-product-name} CDC connectors. For more information on {open-source-product-name} CDC connectors, see xref:integrate:legacy-cdc-connectors.adoc[].

Question – should this be changed to xref the non-legacy CDC topic?

NOTE: This page refers to Hazelcast's {enterprise-product-name} CDC connectors. For more information on {open-source-product-name} CDC connectors, see xref:integrate: cdc-connectors.adoc[].

2nd note:
If user code has to be used, then the problem can be solved with the help of the User Code Deployment feature. Example configs for that can be seen in our xref:pipelines:cdc-join.adoc#7-start-hazelcast-jet[CDC Join tutorial].

Question – should this be changed to:

If user code must be used, you can use the User Code Namespaces feature. For more information, see xref:clusters:user-code-namespaces.adoc[User Code Namespaces].

Or does it need more than this?

@pmcgleenon
Copy link
Contributor Author

Hi @amandalindsay

On your first note, I think it makes sense to reference the non-legacy topic

Reading some of the other docs, it looks like Jet doesn't support UCN yet so User Code Deployment must be used.
Maybe adding a note like this would be helpful

Although User Code Deployment has been deprecated, the replacement User Code Namespaces feature does not yet support Jet jobs or pipelines. For now, continue to use the User Code Deployment solution in this scenario.

@TomaszGaweda what do you think?

@TomaszGaweda
Copy link
Contributor

1st note:
NOTE: This page refers to Hazelcast's {enterprise-product-name} CDC connectors. For more information on {open-source-product-name} CDC connectors, see xref:integrate:legacy-cdc-connectors.adoc[].

Question – should this be changed to xref the non-legacy CDC topic?

No, OSS connector is the legacy CDC connector, so xref to legacy connector is correct here.

Maybe adding a note like this would be helpful

That's a good idea. IIRC There was some job on UCN with Jet, but it was not yet released, so for now the note is the best way to tell users that "hey, we know it should be different, but cannot be yet"

@amandalindsay
Copy link
Contributor

Thank you @TomaszGaweda and @pmcgleenon for your prompt replies. I have added the note as suggested and will close the issue

@amandalindsay amandalindsay linked a pull request Nov 6, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants