Merge pull request #27 from sgilda/jboss-eap-link-variables

Use variables for JBoss EAP documentation links

.gitignore

@@ -49,3 +49,7 @@ catalog.xml
 #########
 target
 
+# Test build
+############
+build/
+

book-product.json

@@ -21,38 +21,43 @@
     "images": "rhsso-images",
     "appserver": {
       "name": "JBoss EAP",
-      "version": "7",
+      "version": "7.0",
+      "doc_base_url": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/",
+      "develdoc": {
+        "name": "JBoss EAP Development Guide",
+        "link": "/single/development-guide"
+      },
       "admindoc": {
         "name": "JBoss EAP Configuration Guide",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/configuration-guide"
+        "link": "/single/configuration-guide"
       },
-      "datasource": {
+      "datasource_ref": {
-        "name": "JBoss EAP Configuration Guide",
+        "name": "Datasource Management",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-13-datasource-management"
+        "link": "/single/configuration-guide/#datasource_management"
       },
-      "network": {
+      "network_ref": {
-        "name": "JBoss EAP Configuration Guide",
+        "name": "Network and Port Configuration",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-4-network-and-port-configuration"
+        "link": "/single/configuration-guide/#network_and_port_configuration"
       },
-      "socket": {
+      "socket_ref": {
-        "name": "JBoss EAP Configuration Guide",
+        "name": "Socket Binding",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-4-network-and-port-configuration"
+        "link": "/single/configuration-guide/#socket_bindings"
       },
-      "loadbalancer": {
+      "loadbalancer_ref": {
-        "name": "JBoss EAP Configuration Guide",
+        "name": "Configuring High Availability",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-21-configuring-high-availability"
+        "link": "/single/configuration-guide/#configuring_high_availability"
       },
-      "jgroups": {
+      "jgroups_ref": {
-        "name": "JBoss EAP Configuration Guide",
+        "name": "Cluster Communication with JGroups",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-21-configuring-high-availability#cluster_communication_jgroups"
+        "link": "/single/configuration-guide/#cluster_communication_jgroups"
       },
-      "caching": {
+      "caching_ref": {
-        "name": "JBoss EAP Configuration Guide",
+        "name": "Infinispan",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-21-configuring-high-availability#infinispan"
+        "link": "/single/configuration-guide/#infinispan"
       },
-      "jpa": {
+      "jpa_ref": {
-        "name": "JBoss EAP Development Guide",
+        "name": "Hibernate",
-        "link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/development-guide/chapter-13-hibernate"
+        "link": "/single/development-guide/#hibernate"
       }
     },
     "developerguide": {

topics/cache.adoc

@@ -15,6 +15,4 @@ but is possibly replicated across the cluster.
 
 This chapter discusses some configuration options for these caches for both clustered a non-clustered deployments.
 
-Note:  More advanced configuration of these caches can be found in link:{{book.appserver.caching.link}}[{{book.appserver.caching.name}}]
+NOTE:  More advanced configuration of these caches can be found in link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.caching_ref.link}}[{{book.appserver.caching_ref.name}}] in the _{{book.appserver.admindoc.name}}_.
-
-

topics/clustering.adoc

@@ -14,6 +14,4 @@ Picking an operation mode and configuring a shared database have been discussed
 we'll discuss setting up a load balancer and supplying a private network.  We'll also discuss some issues that you need
 to be aware of when booting up a host in the cluster.
 
-Note:  It is possible to cluster {{book.project.name}} without IP Multicast, but this topic is beyond the
+NOTE:  It is possible to cluster {{book.project.name}} without IP Multicast, but this topic is beyond the scope of this guide.  For more information, see link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.jgroups_ref.link}}[{{book.appserver.jgroups_ref.name}}] in the _{{book.appserver.admindoc.name}}_.
-       scope of this guide.  Please see the link:{{book.appserver.jgroups.link}}[JGroups] chapter of the {{book.appserver.jgroups.name}}.
-

topics/clustering/load-balancer.adoc

@@ -195,9 +195,4 @@ of the master host.
 
 ==== Configuring Other Load Balancers
 
-The link:{{book.appserver.loadbalancer.link}}[the load balancer] chapter of the {{book.appserver.loadbalancer.name}}
+See link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.loadbalancer_ref.link}}[{{book.appserver.loadbalancer_ref.name}}] in the _{{book.appserver.admindoc.name}}_ for information how to use other software-based load balancers.
-has information on using some other software based load balancers that may help you.
-
-
-
-

topics/clustering/multicast.adoc

@@ -30,7 +30,5 @@ You'll have to edit your the _standalone-ha.xml_ or _domain.xml_ sections discus
 ----
 
 Things you'll want to configure are the `jboss.bind.address.private` and `jboss.default.multicast.address` as well as the ports of the services on the clustering stack.
-Please see the link:{{book.appserver.jgroups.link}}[JGroups] chapter of the {{book.appserver.jgroups.name}} for more details.
 
-Note:  It is possible to cluster {{book.project.name}} without IP Multicast, but this topic is beyond the
+NOTE: It is possible to cluster {{book.project.name}} without IP Multicast, but this topic is beyond the scope of this guide. For more information, see link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.jgroups_ref.link}}[{{book.appserver.jgroups_ref.name}}] in the _{{book.appserver.admindoc.name}}_.
-       scope of this guide.  Please see the link:{{book.appserver.jgroups.link}}[JGroups] chapter of the {{book.appserver.jgroups.name}}.

topics/clustering/troubleshooting.adoc

@@ -16,7 +16,4 @@ If for some reason you still need to have firewall enabled on cluster nodes, you
 Default values are UDP port 55200 and multicast port 45688 with multicast address 230.0.0.4.
 Note that you may need more ports opened if you want to enable additional features like diagnostics for your JGroups stack.
 {{book.project.name}} delegates most of the clustering work to Infinispan/JGroups.
-Please consult the link:{{book.appserver.jgroups.link}}[JGroups] chapter of the {{book.appserver.jgroups.name}}.
+Please consult link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.jgroups_ref.link}}[{{book.appserver.jgroups_ref.name}}] in the _{{book.appserver.admindoc.name}}_.
-
-
-

topics/config-subsystem/start-cli.adoc

@@ -41,7 +41,7 @@ connect
 
 You may be thinking to yourself, "I didn't enter in any username or password!".  If you run `jboss-cli` on the same machine
 as your running standalone server or domain controller and your account has appropriate file permissions, you do not have
-to setup or enter in a admin username and password.  See the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
+to setup or enter in a admin username and password.  See the link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
 for more details on how to make things more secure if you are uncomfortable with that setup.
 
 === CLI Embedded Mode

topics/database.adoc

@@ -15,9 +15,5 @@ The top layered technology for persistence is Hibernate JPA.  This is a object t
 Objects to relational data.  Most deployments of {{book.project.name}} will never have to touch the configuration aspects
 of Hibernate, but we will discuss how that is done if you run into that rare circumstance.
 
-NOTE:  Datasource configuration is covered much more thoroughly within the link:{{book.appserver.datasource.link}}[the datasource configuration chapter]
+NOTE:  Datasource configuration is covered much more thoroughly in link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.datasource_ref.link}}[{{book.appserver.datasource_ref.name}}]
-       of the {{book.appserver.admindoc.name}}.
+       in the _{{book.appserver.admindoc.name}}_.
-
-
-
-

topics/database/datasource.adoc

@@ -42,6 +42,5 @@ Finally, with PostgreSQL at least, you need to define the database username and
 may be worried that this is in clear text in the example.  There are methods to obfuscate this, but this is beyond the
 scope of this guide.
 
-NOTE:  For more information and details features of datasources, please see the link:{{book.appserver.datasource.link}}[the datasource configuration chapter]
+NOTE:  For more information about datasource features, see link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.datasource_ref.link}}[{{book.appserver.datasource_ref.name}}]
-       of the {{book.appserver.admindoc.name}}.
+       in the _{{book.appserver.admindoc.name}}_.
-

topics/database/hibernate.adoc

@@ -54,5 +54,4 @@ globalStatsInterval::
 schema::
   Specify the database schema to use
 
-NOTE:  All these configuration switches and more are described in the link:{{book.appserver.jpa.link}}[{{book.appserver.jpa.name}}].
+NOTE:  These configuration switches and more are described in link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.jpa_ref.link}}[{{book.appserver.jpa_ref.name}}] in the _{{book.appserver.develdoc.name}}_.
-

topics/manage.adoc

@@ -46,9 +46,5 @@ connect
 
 You may be thinking to yourself, "I didn't enter in any username or password!".  If you run `jboss-cli` on the same machine
 as your running standalone server or domain controller and your account has appropriate file permissions, you do not have
-to setup or enter in a admin username and password.  See the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
+to setup or enter in a admin username and password.  See the link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
 for more details on how to make things more secure if you are uncomfortable with that setup.
-
-
-
-

topics/network/bind-address.adoc

@@ -50,5 +50,4 @@ $ domain.sh -Djboss.bind.address=192.168.0.5
 The `-b` is just a shorthand notation for this command.  So, you can either change the bind address value directly in the profile config, or change it on the command line when
 you boot up.
 
-NOTE:  There's a lot more nifty options when setting up `interface` definitions.  See the link:{{book.appserver.network.link}}[the network interface]
+NOTE:  There are many more options available when setting up `interface` definitions. For more information, see link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.network_ref.link}}[{{book.appserver.network_ref.name}}] in the _{{book.appserver.admindoc.name}}_.
-       chapter of the {{book.appserver.network.name}}.

topics/network/ports.adoc

@@ -55,6 +55,4 @@ to the `server-group` definitions you can see what `socket-binding-group` is use
     </server-groups>
 ----
 
-NOTE:  There's a lot more nifty options when setting up `socket-binding-group` definitions.  See the link:{{book.appserver.socket.link}}[the socket binding group]
+NOTE:  There are many more options available when setting up `socket-binding-group` definitions.  For more information, see link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.socket_ref.link}}[{{book.appserver.socket_ref.name}}] in the _{{book.appserver.admindoc.name}}_.
-       chapter of the {{book.appserver.socket.name}}.
-

topics/operating-mode.adoc

@@ -9,4 +9,4 @@ your server configurations?  Your choice of operating mode effects how you confi
 
 TIP: The {{book.project.name}} is built on top of the {{book.appserver.name}} Application Server.  This guide will only
      go over the basics for deployment within a specific mode.  If you want specific information on this, a better place
-     to go would be the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
+     to go would be the link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]

topics/operating-mode/domain.adoc

@@ -10,7 +10,7 @@ a central place to store and publish configuration.  It can be quite complex to
 This capability is built into the {{book.appserver.name}} Application Server which {{book.project.name}} derives from.
 
 NOTE:  The guide will go over the very basics of domain mode.  Detailed steps on how to set up domain mode in a cluster should be obtained from the
-       link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}].
+       link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}].
 
 Here are some of the basic concepts of running in domain mode.
 
@@ -51,7 +51,7 @@ image:../../{{book.images}}/domain-file.png[]
 
 WARNING: Any changes you make to this file while the domain controller is running will not take effect and may even be overwritten
       by the server.  Instead use the the command line scripting or the web console of {{book.appserver.name}}.  See
-      the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information.
+      the link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information.
 
 Let's look at some aspects of this _domain.xml_ file.  The `auth-server-standalone` and `auth-server-clustered` `profile` XML blocks are where you are going to make the bulk of your configuration decisions.
 You'll be configuring things here like network connections, caches, and database connections.

topics/operating-mode/standalone-ha.adoc

@@ -22,7 +22,7 @@ image:../../{{book.images}}/standalone-ha-config-file.png[]
 
 WARNING: Any changes you make to this file while the server is running will not take effect and may even be overwritten
       by the server.  Instead use the the command line scripting or the web console of {{book.appserver.name}}.  See
-      the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information.
+      the link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information.
 
 ==== Standalone Clustered Boot Script
 

topics/operating-mode/standalone.adoc

@@ -41,4 +41,4 @@ image:../../{{book.images}}/standalone-config-file.png[]
 
 WARNING: Any changes you make to this file while the server is running will not take effect and may even be overwritten
       by the server.  Instead use the the command line scripting or the web console of {{book.appserver.name}}.  See
-      the link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information.
+      the link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}] for more information.

topics/overview/recommended-reading.adoc

@@ -5,4 +5,4 @@
 This guide only covers basics for infrastructure-level configuration.  It is highly recommended that you peruse the documentation
 for {{book.appserver.name}} and its sub projects. Here is the link to the documentation:
 
-* link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
+* link:{{book.appserver.doc_base_url}}{{book.appserver.version}}{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]