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

ISPN-10731 titles for 10 Final #7410

Merged
merged 3 commits into from Oct 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 20 additions & 28 deletions documentation/src/main/asciidoc/index.asciidoc
Expand Up @@ -2,48 +2,40 @@
Written and maintained by the {brandname} community
:icons: font

Get answers and find help in the {brandname} {infinispanversion} titles:
Get answers and find help in the {brandname} {infinispanversion} titles.

Getting Started::
+
* link:titles/caches/caches.html[Infinispan Concepts]
* link:titles/overview/overview.html[Technical Overview]
* link:titles/getting_started/getting_started.html[Get Up and Running with Infinispan]
* link:titles/getting_started/getting_started.html[Getting Started Guide]

Configuring Infinispan::
Configuring and Running::
+
* link:titles/configuring/configuring.html[Configuring Infinispan]
* link:titles/managing/managing.html[Managing Data in the Grid]
* link:titles/extending/extending.html[Extending Infinispan]

Developing::
+
* link:titles/embedding/embedding.html[Embedding Infinispan]
* link:titles/developing/developing.html[Programming with Infinispan]
* link:titles/integrating/integrating.html[Integrating Infinispan]
* link:titles/querying/querying.html[Indexing and Querying]
* link:titles/hotrod_protocol/hotrod_protocol.html[Hot Rod Protocol Reference]

Running Infinispan::
+
* link:titles/server/server.html[Running Infinispan Servers]
* link:titles/clustering/clustering.html[Creating Infinispan Clusters]
* link:https://infinispan.org/infinispan-operator/master/operator.html[Running the Infinispan Operator]
* link:titles/xsite/xsite.html[Setting Up Cross Site Replication]
* link:titles/security/security.html[Security Guide]
* link:titles/rolling_up_k8s/rolling.html[Rolling Upgrades on Kubernetes and Red Hat OpenShift]

Using Remote Infinispan Endpoints::
Developing and Integrating::
+
* link:titles/developing/developing.html[Infinispan Developer's Guide]
* link:titles/integrating/integrating.html[Integrating Infinispan]
* link:https://infinispan.org/infinispan-spring-boot/master/spring_boot_starter.html[Infinispan Spring Boot Starter]

Remotely Accessing Infinispan Endpoints::
+
* link:titles/connecting_clients/connecting_clients.html[Connecting to Infinispan Server with Remote Clients]
* link:titles/hotrod_java/hotrod_java.html[Using the Hot Rod Endpoint]
* link:titles/rest/rest.html[Using the REST Endpoint]
* link:titles/memcached/memcached.html[Using the Memcached Endpoint]
* link:titles/hotrod_java/hotrod_java.html[Using the Hot Rod Server]
* link:titles/hotrod_protocol/hotrod_protocol.html[Hot Rod Protocol Reference]
* link:titles/rest/rest.html[Using the REST Server]
* link:titles/memcached/memcached.html[Using the Memcached Server]

Monitoring, Tuning, and Recovering::
Administering Infinispan::
+
* link:titles/monitoring/monitoring.html[Administration and Monitoring]
* link:titles/partitioning/partitioning.html[Handling Network Partitions]
* link:titles/tuning/tuning.html[Performance Tuning]
* link:titles/admin/admin.html[Administration Guide]
* link:titles/security/security.html[Security Guide]
* link:titles/tuning/tuning.html[Tuning Infinispan Performance]
* link:titles/upgrading/upgrading.html[Upgrading Infinispan]

See link:http://www.infinispan.org/documentation[Infinispan Documentation] home for other versions.

Expand Down
@@ -1,5 +1,5 @@
[id='clustered_caches-{context}']
:context: concepts
:context: configuring
= Clustered Caches
Clustered caches store data across multiple {brandname} nodes using JGroups
technology as the transport layer to pass data across the network.
Expand Down
@@ -1,5 +1,5 @@
[id='async_comm-{context}']
:context: clustering
:context: configuring
= Asynchronous Communication with Clustered Caches

include::{topics}/con_async_communication.adoc[leveloffset=+1]
Expand Down
@@ -1,5 +1,5 @@
[id='local_caches-{context}']
:context: concepts
:context: configuring

include::{topics}/con_caches_local.adoc[leveloffset=+0]
include::{topics}/con_caches_simple.adoc[leveloffset=+1]
Expand Down
@@ -1,6 +1,6 @@
[id='cache_modes-{context}']
:context: concepts
= Understanding {brandname} Caches
:context: configuring
= {brandname} Caches
{brandname} caches provide flexible, in-memory data stores that you can configure to suit use cases such as:

* boosting application performance with high-speed local caches.
Expand Down
10 changes: 10 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_configuring.adoc
@@ -0,0 +1,10 @@
[id='configuring-{context}']
:context: configuring
= Configuring {brandname}
{brandname} offers both declarative and programmatic configuration.

include::{topics}/configuration.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
14 changes: 14 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_contributing.adoc
@@ -0,0 +1,14 @@
[id='contributing']

include::{topics}/contributing/basics.adoc[leveloffset=+0]
include::{topics}/contributing/source_control.adoc[leveloffset=+0]
include::{topics}/contributing/building.adoc[leveloffset=+0]
include::{topics}/contributing/api.adoc[leveloffset=+0]
include::{topics}/contributing/tests.adoc[leveloffset=+0]
include::{topics}/contributing/help.adoc[leveloffset=+0]
include::{topics}/contributing/configuration.adoc[leveloffset=+0]
include::{topics}/contributing/docs.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='interceptors-{context}']
:context: admin

include::{topics}/interceptors.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
24 changes: 24 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_developing.adoc
@@ -0,0 +1,24 @@
[id='developing-{context}']
:context: developing

include::{topics}/cache_api.adoc[leveloffset=+0]
include::{topics}/functional_api.adoc[leveloffset=+0]
include::{topics}/encoding.adoc[leveloffset=+0]
include::{topics}/cache_manager.adoc[leveloffset=+0]
include::{topics}/locking.adoc[leveloffset=+0]
include::{topics}/clustered_lock.adoc[leveloffset=+0]
include::{topics}/counters.adoc[leveloffset=+0]
include::{topics}/endpoint_interop.adoc[leveloffset=+0]
include::{topics}/marshalling.adoc[leveloffset=+0]
include::{topics}/grid_file_system.adoc[leveloffset=+0]
include::{topics}/cdi.adoc[leveloffset=+0]
include::{topics}/jcache.adoc[leveloffset=+0]
include::{topics}/multimapcache.adoc[leveloffset=+0]
include::{topics}/transactions.adoc[leveloffset=+0]
include::{topics}/query.adoc[leveloffset=+0]
include::{topics}/execute_grid.adoc[leveloffset=+0]
include::{topics}/streams.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,9 @@
[id='embedding-{context}']
:context: embedding

include::{topics}/embedded_cache.adoc[leveloffset=+0]
include::{topics}/embedded_datagrid.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,9 @@
[id='eviction-{context}']
:context: admin
= Configuring Eviction and Expiration

include::{topics}/eviction.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='extending-{context}']
:context: admin

include::{topics}/extending.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,10 @@
[id='starting-{context}']
:context: getting_started

include::{topics}/installation.adoc[leveloffset=+0]
include::{topics}/create_project.adoc[leveloffset=+0]
include::{topics}/gui_demo.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
11 changes: 11 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_hotrod_java.adoc
@@ -0,0 +1,11 @@
[id='hotrod-{context}']
:context: hotrod

include::{topics}/server_protocols_hotrod.adoc[leveloffset=+0]
//server_protocols_hotrod.adoc includes these topics:
//proc_configuring_hotrod_java_client.adoc
//server_protocols_hotrod_transaction.adoc

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='hotrod_protocol-{context}']
:context: hotrod

include::{topics}/hotrod_protocol.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
11 changes: 11 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_integrating.adoc
@@ -0,0 +1,11 @@
[id='integrating-{context}']
:context: integration

include::{topics}/integrations.adoc[leveloffset=+0]
//topic includes the following:
//include::{topics}/integrations_hibernate_cache.adoc[leveloffset=+2]
//include::{topics}/integrations_spring.adoc[leveloffset=+2]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -1,4 +1,5 @@
[id='jgroups-{context}']
:context: configuring
= Setting Up Cluster Transport
{brandname} nodes rely on a transport layer to join and leave clusters as well
as to replicate data across the network.
Expand Down
19 changes: 19 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_memcached.adoc
@@ -0,0 +1,19 @@
[id='memcached_server-{context}']
:context: client

= Memcached Server

The {brandname} server distribution contains a server module that implements the link:http://github.com/memcached/memcached/blob/master/doc/protocol.txt[Memcached text protocol]. This allows Memcached clients to talk to one or several {brandname} backed Memcached servers. These servers can be standalone just like Memcached, where each server acts independently and does not communicate with the rest. They can also be clustered, where the servers replicate or distribute their contents to other {brandname} backed Memcached servers, providing clients with failover capabilities.


include::{topics}/con_memcached_client_encoding.adoc[leveloffset=+2]

== Command Clarification

include::{topics}/ref_memcached_flush_all.adoc[leveloffset=+2]
include::{topics}/ref_memcached_unsupported.adoc[leveloffset=+2]
include::{topics}/proc_memcached_multi_clustered_server_tutorial.adoc[leveloffset+=2]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
12 changes: 12 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_monitoring.adoc
@@ -0,0 +1,12 @@
[id='monitoring-{context}']
:context: monitoring

include::{topics}/management_server.adoc[leveloffset=+0]
include::{topics}/management.adoc[leveloffset=+0]
include::{topics}/cli.adoc[leveloffset=+1]
include::{topics}/hawt.adoc[leveloffset=+1]
include::{topics}/mgmt_plugins.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
14 changes: 14 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_overview.adoc
@@ -0,0 +1,14 @@
[id='overview-{context}']
:context: concepts

include::{topics}/introduction.adoc[leveloffset=+0]
include::{topics}/architecture.adoc[leveloffset=+0]
include::{topics}/con_server_client_overview.adoc[leveloffset=+0]
include::{topics}/con_server_using_client_mode.adoc[leveloffset=+1]
include::{topics}/con_server_using_embedded_mode.adoc[leveloffset=+1]
include::{topics}/faq_content.adoc[leveloffset=+0]
include::{topics}/glossary.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -1,5 +1,5 @@
[id='partition_handling-{context}']
:context: network
:context: admin
= Setting Up Partition Handling

include::{topics}/con_partition_handling.adoc[leveloffset=+1]
Expand Down
19 changes: 19 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_persistence.adoc
@@ -0,0 +1,19 @@
[id='persistence-{context}']
:context: admin

include::{topics}/persistence.adoc[leveloffset=+0]
include::{topics}/persistence_sfs.adoc[leveloffset=+1]
include::{topics}/persistence_sifs.adoc[leveloffset=+1]
include::{topics}/persistence_jdbc.adoc[leveloffset=+1]
include::{topics}/persistence_remote.adoc[leveloffset=+1]
include::{topics}/persistence_cluster.adoc[leveloffset=+1]
include::{topics}/persistence_cli.adoc[leveloffset=+1]
include::{topics}/persistence_rocksdb.adoc[leveloffset=+1]
include::{topics}/persistence_jpa.adoc[leveloffset=+1]
include::{topics}/persistence_custom.adoc[leveloffset=+1]
include::{topics}/persistence_storemigrator.adoc[leveloffset=+1]
include::{topics}/persistence_spi.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
8 changes: 8 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_rest.adoc
@@ -0,0 +1,8 @@
[id='rest-{context}']
:context: rest

include::{topics}/server_protocols_rest.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='security-{context}']
:context: security

include::{topics}/security.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,12 @@
[id='server_modules-{context}']
:context: modules
= {brandname} Server Modules

What solutions are available after you deploy {brandname} in client-server mode? All {brandname} server modules are based on the same pattern where the server backend creates an embedded {brandname} instance and if you start multiple backends, they can form a cluster and share/distribute state if configured to do so. The server types below primarily differ in the type of listener endpoint used to handle incoming connections.

include::{topics}/con_server_modules.adoc[leveloffset=+1]
include::{topics}/ref_server_protocols.adoc[leveloffset=+2]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='security-{context}']
:context: server

include::{topics}/security_server.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
8 changes: 8 additions & 0 deletions documentation/src/main/asciidoc/stories/assembly_tuning.adoc
@@ -0,0 +1,8 @@
[id='tuning-{context}']
:context: tuning

include::{topics}/performance.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='upgrading-{context}']
:context: upgrading

include::{topics}/upgrading.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
@@ -0,0 +1,8 @@
[id='xsite_replication-{context}']
:context: xsite

include::{topics}/cross_site_replication.adoc[leveloffset=+0]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Expand Up @@ -12,10 +12,9 @@ include::../{topics}/attributes/community-attributes.adoc[]
:toclevels: 3
:numbered:
:stem: asciimath
:context: clustering

//Title
= Configuring {brandname} Cluster Transport
= Administration Guide for {brandname} {infinispanversion}

//User stories
include::stories.adoc[]