Git Product home page Git Product logo

hazelcast-reference-manual's Introduction

DEPRECATED: This repository has been deprecated. Please continue to https://github.com/hazelcast/imdg-docs

Hazelcast IMDG Reference Manual

Building the Documentation

Following command is used to build the document in the repo’s root folder.

./gradlew build

Where Are the Generated Documents

The resulting documents can be found in build/asciidoc/.

How to Produce Different Output Formats

In the file build.gradle, you will see the "backends" tag:

backends = [ 'html5', /*'pdf',*/ /* 'multipage_html5',*/ /*'epub3'*/ ]

In this line, you can comment out (using /* and */) the formats that you do not want the generator to produce.

How to Add a New Chapter

In the file build.gradle, you will see the "sources" tag:

sources {
    include 'index.adoc'
}

The file index.adoc is the one which includes the chapters in the given order and also some parameters. It is located in the folder src/docs/asciidocs/.

When you want to add a new chapter, just create a text file (the extension of the file must be adoc) in the folder src/docs/asciidocs/ and add the name of the file to index.adoc.

How to Add Tabbed Source Code Block

Here is an example 2-tabbed block; XML and Java:

[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.XML
----
<XML code here>
----

[source,java,indent=0,subs="verbatim,attributes",role="secondary"]
.Java
----
<Java code here>
----

You can add more tabs simply by adding the "secondary" role snippet as much as you want.

AsciiDoc?

You can refer to https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ when writing content in AsciiDoc language.

hazelcast-reference-manual's People

Contributors

ahmetmircik avatar alparslanavci avatar bilalyasar avatar blazember avatar david-strom-hazelcast avatar dbrimley avatar devopshazelcast avatar devozerov avatar donnerbart avatar eminn avatar emrahkocaman avatar enesakar avatar fuadm avatar gregrluck avatar ihsandemir avatar jerrinot avatar kwart avatar mdogan avatar meganbishmoore avatar metanet avatar mustafaiman avatar noctarius avatar pivovarit avatar pveentjer avatar serdaro avatar serkan-ozal avatar taburet avatar vbekiaris avatar viliam-durina avatar wildnez avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

hazelcast-reference-manual's Issues

Please add an explicit license file to the repo

Could you please add an explicit LICENSE file to the repo so that it's clear under what terms the content is provided, and under what terms user contributions are licensed?

Per GitHub docs on licensing:

Generally speaking, the absence of a license means that the default copyright laws apply. This means that you retain all rights to your source code and that nobody else may reproduce, distribute, or create derivative works from your work. This might not be what you intend.

For example, Creative Commons Attribution 4.0 International (aka CC BY 4.0), could be a good choice here since the content is text, not code.

Thanks!

Mention of GroupProperty in the manual

I found a single mention of GroupProperty in the manual, which should be removed. That class is part of the internal API. Also the actual text is wrong :)

Map-Persistence.md

You can set per node maximum capacity with GroupProperty#MAP_WRITE_BEHIND_QUEUE_CAPACITY

The correct code would be GroupProperties#PROP_MAP_WRITE_BEHIND_QUEUE_CAPACITY, but please replace this with a link to the system properties section or the property name hazelcast.map.write.behind.queue.capacity.

Spread the sections of Hazelcast Configuration chapter into the manual

This is needed to:

  • get rid of the duplicated configuration explanations
  • give the user the experience to find all configuration related information in the respective module/feature section.

After this work, Hazelcast Configuration chapter will be renamed as Configuration Overview to include only the configuration functionalities like composing XML configurations, using variables, using wildcards, etc.

Needed improvements in WAN Chapter.

  • Whole chapter should be marked as Enterprise Only.
  • We should state WAN replication is supported not only for Map but also for Cache (and give an example configuration on this).
  • "Starting from 3.6, Enterprise WAN replication backups its WAN replication event queues to other nodes to prevent event loss in case of node failure scenarios. Enterprise WAN replication's backup mechanism depends on the related data structures' backup operations. (WAN replication is only supported for Map and Cache) That means, as far as you set a backup count for your data structure, wan replication events generated by this data structure is also replicated."...What does this mean?
  • We should state that a separate queue is used for each operation when replicating.

Executing a simulator tests

There are some isuses with this content:

  • HZ Reference Manual: provisioner logging is for 0.3
  • there is a reference to run.sh; but it is totally unclear what the content should be.

Documentation needs to be followed step by step and fixed at every point where a user can run into a problem.

By @pveentjer via hazelcast/hazelcast-simulator#659.

Prepare an all-included Release Notes and place it to "docs" part of the website.

There will be a link from the "downloads" part in the .org website to reach the related release section in the big release notes document. Required works are:

  • Gather the release notes for the latest builds of 3.0, 3.1, 3.2, 3.3, 3.4, 3.5 and 3.6 into one document.
  • Change the headings so that when the document is generated, the anchors fit Ben's linking mechanism.
  • Change all links (links to related reference manual sections and github issues) in the current release notes documents.

Links to JavaDocs in Reference Manual.

There are a couple of links in the Reference Manual which are targeted to the JavaDocs in hazelcast.org/documentation. They should be replaced with the links to GitHub (master) code pages.

Create a sample Reference Manual with GitBook using AsciiDoc

A part of the Reference Manual must be created with GitBook using AsciiDoc language. It will be then presented to the Hazelcast team and feedback will be requested. If accepted and most importantly majority of the current documentation problems are solved, Reference Manual will be migrated to GitBook with AsciiDoc with another GitHub issue.

Distributed Events missing registration examples in documentation

Within the current documentation we have a few missing code samples for distributed events.

http://docs.hazelcast.org/docs/latest/manual/html-single/hazelcast-documentation.html#distributed-events

For example, MembershipListener docs show an interface implementation but there is no sample code of where or how to register this listener, there is no mention of this at all. The same is true for MigrationListener, PartitionLostListener, LifecycleListener and also MessageListener.

Misleading property default

In the "System Properties" section, the default for hazelcast.operation.backup.timeout.millis is 5, which is misleading. Should be 5000, since the unit is millis.

There is no documentation for JMX

Hello,

In the Hazelcast section, there is no documentation for how to use JMX from custom clients. Also there must be a section that explains how to enable JMX agent via configuration. i.e.:

Config config = new Config();
config.setProperty(GroupProperties.PROP_ENABLE_JMX, "true");

Also, people can't know how we name the JMX Beans. I'd be happy to help. Because this is not enough: http://docs.hazelcast.org/docs/3.5/manual/html-single/hazelcast-documentation.html#monitoring-with-jmx

Reliable Topic documentation problems

I have found problems with Reliable Topic related documentation.

  1. http://docs.hazelcast.org/docs/3.6-EA3/manual/html-single/index.html#hazelcast-clients-feature-comparison
    Here in the table, java client should change to yes.

  2. Programmatic configuration also is not correct

Config config = new Config();
ReliableTopicConfig rtConfig = config.getReliableTopicConfig();
rtConfig.setTopicOverloadPolicy( TopicOverloadPolicy.BLOCK )  <== Not string but over TopicOverloadPolicy
        .setReadBatchSize( 10 )
        .setStatisticsEnabled( true );                <==== without quotes
  1. http://docs.hazelcast.org/docs/latest-dev/manual/html-single/index.html#sample-reliable-itopic-code
    The explanation that comes after the code is not straightforward. There is relation between RingBuffer and ReliableTopic. One needs to configure RingBuffer to use some features of ReliableTopic. I think this one needs one more code in reference manual, or in code-samples.

  2. As far as I understand, when using the ReliableTopic from client, user needs to configure RingBuffer one server side. This also needs more explanation.

  3. There are slight changes on client side configuration. setStatisticsEnabled is not available on client side. And config class name is different. => ClientReliableTopicConfig

I am not sure if I understand the whole RingBuffer & ReliableTopic relation. And if there might be more differences between server and client config.

@pveentjer can help more here to update the reference-manual properly.

"Versions" section should be more clear

"Portable Serialization - Versions" section should be improved since it is not clear how to use it. Is portable version configured globally and not per factory? what will happen if two clients use different versions? Perhaps a use-case would help.

Eliminate "all.html" from the build process and review the build.sh.

When reference manual is built, 3 files are created which are exactly the same: all.html, hazelcast-documentation.html and index.html. When we navigate the manual for the first time after the build/upload, the manual is re-loaded from the scratch again, which causes a first-time-navigation-delay. Also the TOC goes to its inital view when a TOC item is clicked for the first time after the build/upload (afterwards, it is okay).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.