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-9531 Adding files for product docs and resolving build issues #6262

Closed
wants to merge 3 commits into from
Closed
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
658 changes: 658 additions & 0 deletions documentation/src/main/asciidoc/faqs/faq-content.adoc

Large diffs are not rendered by default.

661 changes: 1 addition & 660 deletions documentation/src/main/asciidoc/faqs/faqs.asciidoc

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions documentation/src/main/asciidoc/faqs/master-docinfo.xml
@@ -0,0 +1,14 @@
<productname>{FullProductName}</productname>
<productnumber>{DocInfoProductNumber}</productnumber>
<subtitle>For use with {FullProductName} {ProductRelease}</subtitle>
<title>{FullProductName} Frequently Asked Questions</title>
<release>{DocInfoProductNumber}</release>
<abstract>
<para>
This guide answers frequently asked questions for {FullProductName} {ProductRelease}.
</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" />
11 changes: 11 additions & 0 deletions documentation/src/main/asciidoc/faqs/master.adoc
@@ -0,0 +1,11 @@
:toc:
:toclevels: 3
:icons: font
:numbered:
:productized:

include::topics/attributes/product-attributes.adoc[]

= {FAQ}

include::faq-content.adoc[]
1 change: 1 addition & 0 deletions documentation/src/main/asciidoc/faqs/topics
Expand Up @@ -26,10 +26,12 @@ If you are using Maven (or another build system like Gradle or Ivy which can use
to the `<dependencies>` section of the POM.
You'll need to substitute `${infinispan.version}` for the version of {brandname} you wish to use.

ifndef::productized[]
.Which version of {brandname} should I use?
TIP: We recommend using the latest stable version of {brandname}. All releases are displayed on the link:http://www.infinispan.org/download[downloads page].

Alternatively, you can link:https://raw.github.com/infinispan/infinispan-quickstart/master/embedded-cache/pom.xml[use the POM] from the quickstart that accompanies this tutorial.
Alternatively, you can link:https://raw.github.com/infinispan/infinispan-quickstart/master/embedded-cache/pom.xml[use the POM] from the quickstart that accompanies this tutorial.
endif::productized[]

==== Ant users
If you are using Ant, or another build system which doesn't provide declarative dependency management, then the {brandname} distribution zip contains a lib/ directory. Add the contents of this to the build classpath.
Expand All @@ -42,7 +44,7 @@ In order to run {brandname}, we're going to create a `main()` method in the `Qui
.Quickstart.java

----
public class Quickstart {
public class Quickstart {

public static void main(String args[]) throws Exception {
Cache<Object, Object> c = new DefaultCacheManager().getCache();
Expand Down
@@ -1,3 +1,4 @@
[[start_example_groovy]]
== Example with Groovy
The idea by this tutorial is to give an introduction in the use of the link:{javadocroot}[{brandname} API] and its configuration file. As trying to do it in a more interactive fashion, the tutorial makes use of the link:http://groovy.codehaus.org/[Groovy] dynamic language that will allow to interact with the API by using a console.

Expand Down Expand Up @@ -453,4 +454,3 @@ groovy:000> cacheStoreEvictionCache.get("cs1")
=== > value1

----

@@ -1,5 +1,6 @@
[[start_example_scala]]
== Example with Scala
This article shows how to use {brandname} with link:http://www.scala-lang.org/[Scala language] . It uses the same commands and configurations used in the <<_example_with_groovy, Example with Groovy>>. For more details about the scenarios and steps please visit about page since here will will only focus on Scala compatibility.
This article shows how to use {brandname} with link:http://www.scala-lang.org/[Scala language] . It uses the same commands and configurations used in the link:#start_example_groovy[Example with Groovy]. For more details about the scenarios and steps please visit about page since here will will only focus on Scala compatibility.

=== Environment
Running the shell
Expand Down Expand Up @@ -334,4 +335,3 @@ scala> cacheStoreEvictionCache.get("cs1")
res43: String = value1

----

Expand Up @@ -10,16 +10,4 @@ This is a guide to getting started with {brandname}.
It is meant to be read alongside the more complete link:../user_guide/user_guide.html[User Guide],
and as a supplement to the link:http://infinispan.org/tutorials[Tutorials] that have been made available.

include::introduction.adoc[]
include::installation.adoc[]
include::gui_demo.adoc[]
include::embedded_cache.adoc[]
include::embedded_datagrid.adoc[]
include::create_project.adoc[]
include::hibernate_2lc.adoc[]
include::server.adoc[]
include::wildfly.adoc[]
include::servlet_containers.adoc[]
include::monitoring.adoc[]
include::example_with_groovy.adoc[]
include::example_with_scala.adoc[]
include::topics.adoc[]
22 changes: 13 additions & 9 deletions documentation/src/main/asciidoc/getting_started/gui_demo.adoc
@@ -1,5 +1,10 @@
== {brandname} GUI demo
This document walks you through using the {brandname} GUI demo that ships with {brandname}, and assumes that you have link:http://www.infinispan.org/download[downloaded] the latest version of {brandname} and unzipped the archive. 
This document walks you through using the {brandname} GUI demo that ships with {brandname}, and assumes that you have
ifndef::productized[]
link:http://www.infinispan.org/download[downloaded]
endif::productized[]
the latest version of {brandname} and unzipped the archive. 

I will refer to the {brandname} directory created by unzipping the archive as `${INFINISPAN_HOME}`.

NOTE: You will need either the -bin.zip or -all.zip version for this demo.
Expand All @@ -15,24 +20,23 @@ An equivalent `runGuiDemo.bat` file is also provided for Windows users.
image::images/guidemo1.png[]

=== Step 2: Start the cache
Start the cache in the GUI that starts up, using the _Start Cache_ button.
Start the cache in the GUI that starts up, using the _Start Cache_ button.

image::images/guidemo2.png[]

=== Step 3: Manipulate data
In the _Manipulate Data_ tab, add entries, generate random data, etc.
In the _Manipulate Data_ tab, add entries, generate random data, etc.

image::images/guidemo3.png[]

=== Step 4: Start more cache instances
Repeat steps 1 and 2 to launch and start up more caches.
Watch cluster formation in the _Cluster View_ tab.
Watch cluster formation in the _Cluster View_ tab.

image::images/guidemo4.png[]

=== Step 5: Manipulate more data
Add and remove data on any of the nodes, and watch state being distributed.
Shut nodes down as well to witness data durability.

image::images/guidemo5.png[]

image::images/guidemo5.png[]
14 changes: 14 additions & 0 deletions documentation/src/main/asciidoc/getting_started/master-docinfo.xml
@@ -0,0 +1,14 @@
<productname>{FullProductName}</productname>
<productnumber>{DocInfoProductNumber}</productnumber>
<subtitle>For use with {FullProductName} {ProductRelease}</subtitle>
<title>Getting Started with {FullProductName}</title>
<release>{DocInfoProductNumber}</release>
<abstract>
<para>
This guide provides information to help you get started with {FullProductName} {ProductRelease}.
</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" />
11 changes: 11 additions & 0 deletions documentation/src/main/asciidoc/getting_started/master.adoc
@@ -0,0 +1,11 @@
:toc:
:toclevels: 3
:icons: font
:numbered:
:productized:

include::topics/attributes/product-attributes.adoc[]

= {GetStarted}

include::topics.adoc[]
1 change: 1 addition & 0 deletions documentation/src/main/asciidoc/getting_started/topics
13 changes: 13 additions & 0 deletions documentation/src/main/asciidoc/getting_started/topics.adoc
@@ -0,0 +1,13 @@
include::introduction.adoc[]
include::installation.adoc[]
include::gui_demo.adoc[]
include::embedded_cache.adoc[]
include::embedded_datagrid.adoc[]
include::create_project.adoc[]
include::hibernate_2lc.adoc[]
include::server.adoc[]
include::wildfly.adoc[]
include::servlet_containers.adoc[]
include::monitoring.adoc[]
include::example_with_groovy.adoc[]
include::example_with_scala.adoc[]