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

Document Vert.x integration [DEX-172] #1280

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

Conversation

frant-hartm
Copy link
Contributor

No description provided.

Copy link

netlify bot commented Sep 9, 2024

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit a121a33
🔍 Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/66fd358aaec24c0008286926
😎 Deploy Preview https://deploy-preview-1280--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.


See the Vert.x Hazelcast Cluster Manager site for reference documentation of the `vertx-hazelcast` module.

You can also follow our xref:vertx-step-by-step-buide.adoc[step-by-step guide].

Choose a reason for hiding this comment

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

Check if this link works because it states 'buide' not 'guide'

We will fix that by using a Hazelcast Cluster Manager. There are two modules that provide Hazelcast Cluster Manager:

- `io.vertx:vertx-hazelcast` - this module is maintained by the Vert.x team, with contributions from Hazelcast, and is built on top of open-source Hazelcast
- `com.hazelcast:vertx-hazelcast-enterprise` / this module is maintained by the Hazelcast team and is built on top of the `vertx-hazelcast` but uses Hazelcast Enterprise instead. You need an enterprise license to use Hazelcast Enterprise.

Choose a reason for hiding this comment

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

Should the / be a - (hyphen) instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, fixed in 62101ff

</dependency>
----

change the following part of the `start` method

Choose a reason for hiding this comment

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

where possible, add ":" (a colon) at the end of lines where information follows

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

@amandalindsay amandalindsay left a comment

Choose a reason for hiding this comment

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

Just a few 'tech-authory' type comments but looks good!

docs/modules/integrate/pages/vertx-step-by-step-buide.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like page needs renamed 'buide' to 'guide'

frant-hartm and others added 16 commits September 13, 2024 15:03
Copy link

@amandalindsay amandalindsay left a comment

Choose a reason for hiding this comment

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

Minor copyedit only, looks good


== Using Vert.x Hazelcast Cluster Manager

See the Vert.x Hazelcast Cluster Manager site for reference documentation of the `vertx-hazelcast` module.

Choose a reason for hiding this comment

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

Suggested change
See the Vert.x Hazelcast Cluster Manager site for reference documentation of the `vertx-hazelcast` module.
See the Vert.x Hazelcast Cluster Manager site for reference documentation for the `vertx-hazelcast` module.


See the Vert.x Hazelcast Cluster Manager site for reference documentation of the `vertx-hazelcast` module.

You can also follow our xref:vertx-step-by-step-guide.adoc[step-by-step guide].

Choose a reason for hiding this comment

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

Suggest changing the name of the guide to "Get started with Vert.x guide"

java -jar target/messages-1.0.0-SNAPSHOT-fat.jar
----

you should see an output similar to the following:

Choose a reason for hiding this comment

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

Suggested change
you should see an output similar to the following:
You should see output similar to the following:

INFO: Succeeded in deploying verticle
----

[NOTE]

Choose a reason for hiding this comment

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

Is the following 'ToDo' content hidden?


Go to the `MainVerticle.java` file and replace the contents of the start method with the following:

NOTE: This guide uses 2 space indentation, which is customary for Vertx projects due to the high number of nested callbacks.

Choose a reason for hiding this comment

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

Suggested change
NOTE: This guide uses 2 space indentation, which is customary for Vertx projects due to the high number of nested callbacks.
NOTE: This guide uses 2-space indentation, which is customary for Vertx projects due to the high number of nested callbacks.

</dependency>
----

change the following part of the `start` method:

Choose a reason for hiding this comment

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

Suggested change
change the following part of the `start` method:
Change the following part of the `start` method:

...
----

putting two messages into different instances while using the same cookie we see that the session is shared between the instances.

Choose a reason for hiding this comment

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

Suggested change
putting two messages into different instances while using the same cookie we see that the session is shared between the instances.
Putting two messages into different instances while using the same cookie, we see that the session is shared between the instances.

...
----

enable the CP subsystem, and in cluster.xml change the value of the `` property to `3`:

Choose a reason for hiding this comment

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

Suggested change
enable the CP subsystem, and in cluster.xml change the value of the `` property to `3`:
Enable the CP subsystem, and in cluster.xml change the value of the `` property to `3`:

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