-
Notifications
You must be signed in to change notification settings - Fork 99
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
Add documentation for using DataConnectionService [SUP-523] #1361
base: main
Are you sure you want to change the base?
Add documentation for using DataConnectionService [SUP-523] #1361
Conversation
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@oliverhowell @amandalindsay Before jumping on this one, it might be worth waiting to have devs/QE to review it first - I am not 100 % sure it's all understandable. |
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
If you want to share the data connection configuration, but use a different instance of the underlying resource, | ||
set the `DataConnectionConfig#setShared` to false. | ||
|
||
== Typical Usage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd move that at the beginning
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
|=== | ||
|Prerequisites|Useful resources | ||
|
||
|Java !! current java version !! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can add a variable to antora.yml
and use it here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Tomasz Gawęda <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These look like well-structured procedures with prerequisites, numbered steps etc. There are a handful of bugs and inconsistencies, and a few bits I'd like to see fleshed out for improved usability.
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/data-connection-service.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/how-to-map-loader-data-connection.adoc
Show resolved
Hide resolved
docs/modules/data-connections/pages/how-to-pipeline-service-data-connection.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/how-to-pipeline-service-data-connection.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/how-to-pipeline-service-data-connection.adoc
Outdated
Show resolved
Hide resolved
docs/modules/data-connections/pages/how-to-pipeline-service-data-connection.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking much better, just a couple of outstanding issues. Most important is to reference the new files in nav.adoc. It would be nice to have a validation rule for this @oliverhowell!
Related platform PR https://github.com/hazelcast/hazelcast-mono/pull/3533