Skip to content

Commit

Permalink
Minor Improvements for Reference Manual
Browse files Browse the repository at this point in the history
  • Loading branch information
Serdaro committed Apr 18, 2014
1 parent 0ccae22 commit 7201447
Show file tree
Hide file tree
Showing 22 changed files with 80 additions and 37 deletions.
8 changes: 6 additions & 2 deletions hazelcast-documentation/src/ConfiguringHazelcast.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
Besides declarative configuration, you can configure your cluster programmatically (Programmatic Configuration). Just instantiate a `Config` object and add/remove/modify properties.


**Related Information**
<br> </br>

Please refer to [Configuration](#configuration) chapter for more information.
<font color="red">
***Related Information***
</font>

*Please refer to [Configuration](#configuration) chapter for more information.*

Expand Down
1 change: 1 addition & 0 deletions hazelcast-documentation/src/ContinuousQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ You can listen map entry events providing a predicate and so, event will be fire
void addEntryListener(EntryListener<K, V> listener, Predicate<K, V> predicate, K key, boolean includeValue);
```

<br> </br>



Expand Down
2 changes: 1 addition & 1 deletion hazelcast-documentation/src/CustomSerialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ config.getSerializationConfig().addSerializerConfig(sc);
From now on, Hazelcast will use `FooXmlSerializer`
to serialize Foo objects. This way one can write an adapter (StreamSerializer) for any Serialization framework and plug it into Hazelcast.


<br> </br>
2 changes: 2 additions & 0 deletions hazelcast-documentation/src/DataAffinity.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,3 +157,5 @@ Benefits of doing the same operation with distributed `ExecutorService` based on
- Since lock/update/unlock cycle is done locally (local to the customer data), lock duration for the `Customer` entry is much less, so enabling higher concurrency.


<br> </br>

4 changes: 3 additions & 1 deletion hazelcast-documentation/src/DistributedEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,6 @@ public class Sample implements ItemListener, EntryListener {
}
}

```
```

<br> </br>
2 changes: 2 additions & 0 deletions hazelcast-documentation/src/DocumentRevisionHistory.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
|[Chapter 13 - Security](#security)||*Socket Interceptor*, *Encryption* and *SSL* sections previously located under **Configuration** chapter moved to this one.
|[Chapter 17 - FAQ](#frequently-asked-questions)||Added as a new chapter.|

<br> </br>




Expand Down
8 changes: 6 additions & 2 deletions hazelcast-documentation/src/EC2AutoDiscovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ You need to add *hazelcast-cloud.jar* dependency into your project. Note that it



**Related Information**
<br> </br>

You can download the white paper *Hazelcast on AWS: Best Practices for Deployment* from [Hazelcast.com](http://hazelcast.com/resources/hazelcast-on-aws-best-practices-for-deployment/).
<font color="red">
***Related Information***
</font>

*You can download the white paper *"Hazelcast on AWS: Best Practices for Deployment"* from [Hazelcast.com](http://hazelcast.com/resources/hazelcast-on-aws-best-practices-for-deployment/).*
2 changes: 2 additions & 0 deletions hazelcast-documentation/src/ElasticMemory.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ And, the programmatic configuration:
MapConfig mapConfig = new MapConfig();
mapConfig.setInMemoryFormat(InMemoryFormat.OFFHEAP);
```

<br> </br>
8 changes: 6 additions & 2 deletions hazelcast-documentation/src/Encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Hazelcast allows you to encrypt entire socket level communication among all Haze
</hazelcast>
```

**Related Information**
<br> </br>

Please see [SSL](#ssl).
<font color="red">
***Related Information***
</font>

*Please see [SSL](#ssl).*
1 change: 1 addition & 0 deletions hazelcast-documentation/src/EnterpriseConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ config.setLicenseKey("HAZELCAST_ENTERPRISE_LICENSE_KEY");
-Dhazelcast.enterprise.license.key=HAZELCAST_ENTERPRISE_LICENSE_KEY
```

<br> </br>
2 changes: 2 additions & 0 deletions hazelcast-documentation/src/EntryProcessor.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,5 @@ public class EntryProcessorTest {
}
}
```

<br> </br>
2 changes: 1 addition & 1 deletion hazelcast-documentation/src/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Yes. But, please note that, Hazelcast's main design focus is multi-node clusters

**14\. How Can I Monitor Hazelcast**

[Hazelcast Management Center](#management-center) is used to monitor and managethe nodes running Hazelcast. In addition to monitoring overall state of a cluster, data structures can be analyzed and browsed in detail, map configurations can be updated and thread dump from nodes can be taken.
[Hazelcast Management Center](#management-center) is used to monitor and manage the nodes running Hazelcast. In addition to monitoring overall state of a cluster, data structures can be analyzed and browsed in detail, map configurations can be updated and thread dump from nodes can be taken.

Moreover, JMX monitoring is also provided. Please see [Monitoring with JMX](#monitoring-with-jmx) section for details.

Expand Down
2 changes: 2 additions & 0 deletions hazelcast-documentation/src/Lock.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ if (lock.tryLock (5000, TimeUnit.MILLISECONDS)) {
```

Locks are fail-safe. If a member holds a lock and some of the members go down, cluster will keep your locks safe and available. Moreover, when a member leaves the cluster, all the locks acquired by this dead member will be removed so that these locks can be available for live members immediately.

<br> </br>
2 changes: 2 additions & 0 deletions hazelcast-documentation/src/ManagementCenter.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,3 +415,5 @@ You can go back in time using the slider and/or calendar and check your cluster'

To see the documentation, click on the **Documentation** button located at the toolbar. Management Center manual will appear as a tab.

<br> </br>

2 changes: 1 addition & 1 deletion hazelcast-documentation/src/MemcacheClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ System.out.println(client.get("key2")); //get from hz_memcache_map2

An entry written with a memcache client can be read by another memcache client written in another language.


<br> </br>

1 change: 1 addition & 0 deletions hazelcast-documentation/src/NativeClientSecurity.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,4 @@ Permission policy should return a `PermissionCollection` containing permissions
</transaction-permission>
```
<br> </br>
3 changes: 3 additions & 0 deletions hazelcast-documentation/src/Resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,7 @@
- More use cases and resources can be found at [Hazelcast.com](http://www.hazelcast.com).
- Questions and discussions can be post in [Hazelcast mail group](https://groups.google.com/forum/#!forum/hazelcast).

<br> </br>



2 changes: 2 additions & 0 deletions hazelcast-documentation/src/SampleJBossConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,6 @@

If Hazelcast resource is used from EJBs, you should configure `ejb-jar.xml` and `jboss.xml` for resource reference and JNDI definitions.

<br> </br>


17 changes: 13 additions & 4 deletions hazelcast-documentation/src/SpringIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -452,9 +452,13 @@ In the example configuration above, Hibernate and MySQL is configured. You chang

By default, the key is expected to be the same with ID of the JPA object. You can change this behavior and customize MapStore implementation extending `SpringJPAMapStore` class.

**Related Information**
<br> </br>

For more information please see [Spring Data JPA Reference](http://static.springsource.org/spring-data/data-jpa/docs/current/reference/html/).
<font color="red">
***Related Information***
</font>

*For more information please see [Spring Data JPA Reference](http://static.springsource.org/spring-data/data-jpa/docs/current/reference/html/).*



Expand Down Expand Up @@ -489,7 +493,12 @@ Then, you can set this as map store for maps that you want to persist into Mongo

By default, the key is set as id of the MongoDB object. You can override `MongoMapStore` class for you custom needs.

**Related Information**
<br> </br>

<font color="red">
***Related Information***
</font>

For more information please see [Spring Data MongoDB Reference](http://static.springsource.org/spring-data/data-mongodb/docs/current/reference/html/).
*For more information please see [Spring Data MongoDB Reference](http://static.springsource.org/spring-data/data-mongodb/docs/current/reference/html/).*

<br> </br>
10 changes: 8 additions & 2 deletions hazelcast-documentation/src/StartingClusterClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ public class GettingStartedClient {

public static void main(String[] args) {
ClientConfig clientConfig = new ClientConfig();
clientConfig.addAddress("127.0.0.1:5701");
HazelcastInstance client = HazelcastClient.newHazelcastClient(clientConfig);
IMap map = client.getMap("customers");
System.out.println("Map Size:" + map.size());
Expand All @@ -80,6 +79,13 @@ public class GettingStartedClient {
```
- When you run it, you will see the client properly connecting to the cluster and printing the map size as **3**.

Hazelcast also offers a tool, **Management Center**, that enables monitoring your cluster. To be able to use it, deploy the `mancenter-`*`<version>`*`.war` included in the ZIP file to your web server. You can use it to monitor your maps, queues, other distributed data structures and nodes. Please see [Management Center](#management-center) for usage explanations.
Hazelcast also offers a tool, **Management Center**, that enables monitoring your cluster. To be able to use it, deploy the `mancenter-`*`<version>`*`.war` included in the ZIP file to your web server. You can use it to monitor your maps, queues, other distributed data structures and nodes. Please see [Management Center](#management-center) for usage explanations.

<br> </br>

<font color="red">
***Related Information***
</font>

*You can also check the video tutorials [here](http://hazelcast.org/getting-started/).*

10 changes: 8 additions & 2 deletions hazelcast-documentation/src/WanReplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@ Here we have `my-shared-map` is configured to replicate itself to the cluster ta

Note that, you will also need to define a `merge policy` for merging replica entries and resolving conflicts during the merge.

**Related Information**
<br> </br>

You can download the white paper *Hazelcast on AWS: Best Practices for Deployment* from [Hazelcast.com](http://hazelcast.com/resources/hazelcast-on-aws-best-practices-for-deployment/).
<font color="red">
***Related Information***
</font>

*You can download the white paper *Hazelcast on AWS: Best Practices for Deployment* from [Hazelcast.com](http://hazelcast.com/resources/hazelcast-on-aws-best-practices-for-deployment/).*

<br> </br>
26 changes: 7 additions & 19 deletions hazelcast-documentation/themes/single_html/assets/css/docs.less
Original file line number Diff line number Diff line change
Expand Up @@ -173,21 +173,24 @@ body {

h1 {
border-bottom: 2px solid #ccc;
font-size: 24px;
font-weight: normal;
color: #113847;
font-size: 29px;
font-weight: bold;
margin: 30px 0 15px 0;
padding-bottom: 7px;
}
h2 {
border-bottom: 2px solid #ccc;
font-size: 20px;
color: #113847;
font-size: 24px;
font-weight: normal;
margin: 30px 0 15px 0;
padding-bottom: 7px;
}
h3 {
border-bottom: 2px solid #ccc;
font-size: 18px;
color: #113847;
font-size: 20px;
font-weight: normal;
margin: 30px 0 15px 0;
padding-bottom: 7px;
Expand All @@ -200,21 +203,6 @@ body {
padding-bottom: 7px;
}

h2 {
border-bottom: 2px solid #ccc;
font-size: 20px;
font-weight: normal;
margin: 30px 0 15px 0;
padding-bottom: 7px;
}

h3 {
border-bottom: 2px solid #ccc;
font-size: 17px;
font-weight: normal;
margin: 30px 0 15px 0;
padding-bottom: 7px;
}

p {
margin: 15px 0;
Expand Down

0 comments on commit 7201447

Please sign in to comment.