Commit
rebasing and merging changes removing HR client docs, updating index rebasing and syncing changes for ISPN-10268 Cluster Resource
- Loading branch information
There are no files selected for viewing
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,28 @@ | ||
= {brandname} {infinispanversion} Documentation | ||
The {brandname} community | ||
Written and maintained by the {brandname} community | ||
:icons: font | ||
|
||
{brandname}'s documentation is organized as several individual 'books'. Each | ||
one can be read independently, however they do reference one another, | ||
particularly the link:user_guide/user_guide.html[User Guide]. | ||
Get answers and find help in the {brandname} {infinispanversion} titles: | ||
|
||
We hope you find this useful. Any and all feedback should be directed to the | ||
{brandname} link:http://www.infinispan.org/community[user forums]. | ||
* link:titles/overview/overview.html[Technical Overview] | ||
* link:titles/getting_started/getting_started.html[Get Up and Running with Infinispan] | ||
* link:titles/configuring/configuring.html[Configuring Infinispan] | ||
* link:titles/developing/developing.html[Developing with Infinispan] | ||
* link:titles/embedding/embedding.html[Embedding Infinispan] | ||
* link:titles/server/server.html[Running Infinispan Servers] | ||
* link:titles/clustering/clustering.html[Creating Infinispan Clusters] | ||
* link:titles/monitoring/monitoring.html[Administration and Monitoring] | ||
* link:titles/managing/managing.html[Managing Data] | ||
* link:titles/querying/querying.html[Indexing and Querying] | ||
* link:titles/tuning/tuning.html[Performance Tuning] | ||
* link:titles/xsite/xsite.html[Setting Up Cross Site Replication] | ||
* link:titles/security/security.html[Security Guide] | ||
* link:titles/extending/extending.html[Extending Infinispan] | ||
* link:titles/integrating/integrating.html[Integrating with Infinispan] | ||
* link:titles/hotrod_protocol/hotrod_protocol.html[Hot Rod Protocol Reference] | ||
TIP: This is written specifically for *{brandname} {infinispanversion}*. While | ||
the majority of it will apply to other versions as well, it is best that you | ||
reference the version of documentation that corresponds to your version of | ||
{brandname}. | ||
See the link:http://www.infinispan.org/documentation[Documentation] home for other versions. | ||
|
||
.Books | ||
* A link:getting_started/getting_started.html[Getting Started Guide] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/getting_started.pdf[PDF]) | ||
* A link:user_guide/user_guide.html[User Guide] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/user_guide.pdf[PDF]) | ||
* A link:server_guide/server_guide.html[Server Guide] if you are running the server (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/server_guide.pdf[PDF]) | ||
* A link:performance_guide/performance_guide.html[Performance Guide] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/performance_guide.pdf[PDF]) | ||
* An link:upgrading/upgrading.html[Upgrading Guide] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/upgrading.pdf[PDF]) | ||
* A description of the link:hotrod_protocol/hotrod_protocol.html[Hot Rod protocol] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/hotrod_protocol.pdf[PDF]) | ||
* A link:glossary/glossary.html[Glossary] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/glossary.pdf[PDF]) | ||
* A set of link:faqs/faqs.html[Frequently Asked Questions] (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/faqs.pdf[PDF]) | ||
* A guide to link:extending/extending.html[extending] {brandname} (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/extending.pdf[PDF]) | ||
* A guide to link:contributing/contributing.html[contributing] to {brandname} (link:https://docs.jboss.org/infinispan/{infinispanversion}/pdf/contributing.pdf[PDF]) | ||
Come and join the link:http://www.infinispan.org/community[Infinispan community] to submit feedback or ask questions. | ||
|
||
Interested in getting involved with Infinispan? See the link:titles/contributing/contributing.html[Contributor's Guide]. |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[id='managing_heap_space'] | ||
= Managing Heap Space | ||
:context: managing_heap_space | ||
|
||
Manage the Java heap space to tune performance and prevent `OutOfMemoryError` exceptions. | ||
|
||
include::topics/data_container/con_eviction_expiration.adoc[leveloffset=+1] | ||
include::topics/data_container/proc_configuring_eviction.adoc[leveloffset=+2] | ||
include::topics/data_container/proc_setting_cache_size.adoc[leveloffset=+2] | ||
include::topics/data_container/ref_eviction_strategies.adoc[leveloffset=+2] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../modules/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../topics |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Build the guide | ||
|
||
# Find the directory name and full path | ||
CURRENT_GUIDE=${PWD##*/} | ||
CURRENT_DIRECTORY=$(pwd) | ||
RED='\033[0;31m' | ||
BLACK='\033[0;30m' | ||
# Do not produce pot/po by default | ||
L10N=0 | ||
# A comma separated lists of default locales that books should be translated to. | ||
# This can be overriden in each book's individual buildGuide.sh | ||
LANG_CODE=ja-JP | ||
|
||
usage(){ | ||
cat <<EOM | ||
USAGE: $0 [OPTION] | ||
DESCRIPTION: Build the documentation in this directory and (optionally) | ||
the associated L10N pot/po files. | ||
OPTIONS: | ||
-h Print help. | ||
-t Produce the L10N pot/po files for this documentation | ||
EOM | ||
} | ||
|
||
while getopts "ht:" c | ||
do | ||
case "$c" in | ||
t) L10N=1 | ||
LANG_CODE=$OPTARG;; | ||
h) usage | ||
exit 1;; | ||
\?) echo "Unknown option: -$OPTARG." >&2 | ||
usage | ||
exit 1;; | ||
esac | ||
done | ||
|
||
if [ $L10N -eq 1 ]; then | ||
echo "Building pot/po for $CURRENT_GUIDE" | ||
ccutil translate --langs $LANG_CODE | ||
fi | ||
|
||
# Remove the html and build directories and then recreate the html/images/ directory | ||
if [ -d html ]; then | ||
rm -r html/ | ||
fi | ||
if [ -d build ]; then | ||
rm -r build/ | ||
fi | ||
|
||
mkdir -p html | ||
cp -r ../../docs/topics/images/ html/ | ||
|
||
echo "" | ||
echo "********************************************" | ||
echo " Building $CURRENT_GUIDE " | ||
echo "********************************************" | ||
echo "" | ||
echo "Building an asciidoctor version of the $CURRENT_GUIDE" | ||
asciidoctor -t -dbook -a toc -o html/$CURRENT_GUIDE.html master.adoc | ||
|
||
echo "Building the ccutil version of the $CURRENT_GUIDE" | ||
ccutil compile --lang en_US --main-file master.adoc --format html-single | ||
|
||
cd .. | ||
|
||
echo "$CURRENT_GUIDE (AsciiDoctor) is located at: " file://$CURRENT_DIRECTORY/html/$CURRENT_GUIDE.html | ||
|
||
if [ -d $CURRENT_DIRECTORY/build/tmp/en-US/html-single/ ]; then | ||
echo "$CURRENT_GUIDE (ccutil) is located at: " file://$CURRENT_DIRECTORY/build/tmp/en-US/html-single/index.html | ||
exit 0 | ||
else | ||
echo -e "${RED}Build of $CURRENT_GUIDE failed!" | ||
echo -e "${BLACK}See the log above for details." | ||
exit 1 | ||
fi |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
// Include global attributes | ||
include::topics/attributes/community-attributes.adoc[] | ||
|
||
= Creating {brandname} Clusters | ||
:toc2: | ||
:icons: font | ||
:toclevels: 3 | ||
:numbered: | ||
:stem: asciimath | ||
|
||
//Reference .adoc topic files for the title content. | ||
//Will eventually be replaced with user stories (assemblies). | ||
include::topics.adoc[] | ||
|
||
//Topics assembled into user stories. | ||
//include::stories.adoc[] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!--Productized Content--> | ||
<productname>{FullProductName}</productname> | ||
<productnumber>{DocInfoProductNumber}</productnumber> | ||
<subtitle>{FullProductName} Documentation</subtitle> | ||
<title>Creating {FullProductName} Clusters</title> | ||
<release>{DocInfoProductNumber}</release> | ||
<abstract> | ||
<para> | ||
Creating {FullProductName} clusters. | ||
</para> | ||
</abstract> | ||
<authorgroup> | ||
<orgname>Red Hat Customer Content Services</orgname> | ||
</authorgroup> | ||
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../images/ |