hazelcast / hazelcast-release-notes

Hazelcast Release Notes Repository

Hazelcast IMDG Release Notes

Build The Documentation:

./gradlew build

The resulting document can be found in build/asciidoc/html5.

hazelcast-release-notes's Issues

Add Clients' release notes

Hazelcast Release Notes document should include the notes for Hazelcast clients.

Update the Upgrading Hazelcast sections in Release Notes.

Add information come from Jaromir:

• some predicates were moved from inner class into a top-level class. see jerrinot/hazelcast@f1e26fa.
  they were never meant to be instantiate directly by users. our documentation shows the Predicates factory class. so there should be no impact. however if some smart-ass was directly calling new Predicate.AndPredicate() then it will not work anymore.
  as the supported way is Predicate p = Predicates.and(inner1, inner2)
• (deprecated) method getId() was removed from DistributedObject interface. Use getName() instead
  the method had been deprecated for quite some time

Rephrase wording for Fixed Issues sections.

Automation of EE release notes.

Currently, EE release notes is built and uploaded manually. Its path has been ../files/hazelcast-docs/enterprise-release-notes on the Doc server.

Please see the below explanations and requests.

Repo:

• To put the EE release notes build into the Hazelcast release cycle, a new repo is needed, i.e., "hazelcast-enterprise-release-notes". Or, we can create two folders in the "hazelcast-release-notes" repo as "OS" and "EE" (whichever option is suitable for you).

Path:

• I prepared the EE release notes document in its new layout and uploaded it to a new folder on the Doc server. Path of this new folder is ../files/hazelcast-docs/ern.
• I wrote the redirection script for the EE release notes document and put it into the current EE release notes folder on the Doc server. Now the users see the new layout up to the latest release, which is 3.8.2.
• Starting with 3.8.3, or 3.9 (whichever is suitable for you), it will be nice to change the path for the EE release notes document in the release script. The new path is ../files/hazelcast-docs/ern.
• When this is done, I will notify Benjamin so the EE release notes links will point to this new path.

Build:

• So far, EE release notes document has been built by the bfdocs ............. command on my local.
• The document with the new layout requires only the command daux on its repo. Please see the above Repo: section.

Changes in OS Release Notes build and folder.

Currently, on the Doc server, the path for OS release notes document is ../files/hazelcast-docs/release-notes and it is built using the bfdocs command.

Please see the below explanations and requests.

Path:

• I prepared the OS release notes document in its new layout and uploaded it to a new folder on the Doc server. Path of this new folder is ../files/hazelcast-docs/rn.
• I wrote the redirection script for the OS release notes document and put it into the current OS release notes folder on the Doc server. Now the users see the new layout up to the latest release, which is 3.8.2.
• Starting with 3.8.3, or 3.9 (whichever is suitable for you), it will be nice to change the path for the OS release notes document in the release script. The new path is ../files/hazelcast-docs/rn.
• When this is done, I will notify Benjamin so the OS release notes links will point to this new path.

Build:

• So far, OS release notes document has been built by the bfdocs ............. command executed on the repo https://github.com/hazelcast/hazelcast-release-notes.
• The document with the new layout requires only the command daux on the same repo.
• New layout's documents are reside in the "daux" branch of the repo. Once the script is updated, I will move the content of "daux" branch to "master" branch.

3.12 Release Notes: Client Labels

"Client Attributes" were renamed as "Client Labels" during the development.

We should update the "Client Instance Names and Attributes" item of the release notes. We should replace all "attributes" with "labels".

Also, the link anchor provided in the release notes should be updated accordingly.

https://docs.hazelcast.org/docs/rn/

Standardize the issue numberings and fix unresolved links.

CLI

CLI should be removed from the 3.7 release notes. It is currently a private repo.