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

Add documentation for using DataConnectionService [SUP-523] #1361

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

frant-hartm
Copy link
Contributor

@frant-hartm frant-hartm commented Nov 4, 2024

Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit 245266b
🔍 Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/674993e91323ac00081e7e2d
😎 Deploy Preview https://deploy-preview-1361--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@frant-hartm
Copy link
Contributor Author

@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.

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
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

|===
|Prerequisites|Useful resources

|Java !! current java version !!
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@Rob-Hazelcast Rob-Hazelcast left a 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.

Copy link
Contributor

@Rob-Hazelcast Rob-Hazelcast left a 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!

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 this pull request may close these issues.

3 participants