JBEAP-15768: Update the root README file to support CD, Product, and …

…Project releases
wildfly · Nov 6, 2018 · ae513a0 · ae513a0
1 parent db24710
commit ae513a0
Show file tree

Hide file tree

Showing 7 changed files with 773 additions and 184 deletions.
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
diff --git a/README.adoc b/README.adoc
diff --git a/shared-doc/attributes.adoc b/shared-doc/attributes.adoc
@@ -2,13 +2,13 @@
 // Enable the following flag to build README.html files for Product (CD or JBoss EAP) builds.
 // Comment it out to build README.html files for WildFly builds.
 //***********************************************************************************
-//:ProductRelease:
+// :ProductRelease:
 
 //***********************************************************************************
 // Enable the following flag to build README.html files for CD product builds.
 // Comment it out to build README.html files for JBoss EAP product builds.
 //***********************************************************************************
-//:EAPCDRelease:
+// :EAPCDRelease:
 
 // This is a universal name for all releases
 :ProductShortName: JBoss EAP
@@ -21,27 +21,31 @@ ifdef::ProductRelease[]
 
 ifdef::EAPCDRelease[]
 // EAP CD release
-:productName: JBoss EAP for OpenShift
-:productNameFull: Red Hat JBoss Enterprise Application Platform for OpenShift
+:productName: JBoss EAP Continuous Delivery
+:productNameFull: JBoss Enterprise Application Platform continuous delivery
 :productVersion: 15
-:githubRepoUrl: https://github.com/jboss-developer/jboss-eap-quickstarts/
+:githubRepoUrl: https://github.com/jboss-developer/jboss-eap-quickstarts/openshift
 :jbossHomeName: EAP_HOME
 :DocInfoProductNameURL: jboss_enterprise_application_platform_continuous_delivery
 :DocInfoProductName: JBoss Enterprise Application Platform Continuous Delivery
-:DocInfoProductNumber: 15
+:DocInfoProductNumber: {productVersion}
+:quickstartDownloadName: JBoss EAP CD {productVersion} Quickstarts
+:quickstartDownloadUrl: https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?product=eap-cd&downloadType=distributions
 endif::[]
 
 ifndef::EAPCDRelease[]
 // JBoss EAP release
 :productName: JBoss EAP
 :productNameFull: JBoss Enterprise Application Platform Server
 :productVersion: 7.2
-:githubRepoUrl: https://github.com/jboss-developer/jboss-eap-quickstarts/
+:githubRepoUrl: https://github.com/jboss-developer/jboss-eap-quickstarts/{productVersion}
 :jbossHomeName: EAP_HOME
 :DocInfoProductName: red_hat_jboss_enterprise_application_platform
 :DocInfoProductNameURL: red_hat_jboss_enterprise_application_platform
-:DocInfoProductNumber: 7.2
+:DocInfoProductNumber: {productVersion}
 :DocInfoPreviousProductName: jboss-enterprise-application-platform
+:quickstartDownloadName: Red Hat JBoss Enterprise Application Platform {productVersion} Quickstarts
+:quickstartDownloadUrl: https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?product=appplatform&downloadType=distributions
 endif::[]
 
 endif::[]

diff --git a/shared-doc/available-quickstarts.adoc b/shared-doc/available-quickstarts.adoc
diff --git a/shared-doc/cd-openshift-getting-started-overview.adoc b/shared-doc/cd-openshift-getting-started-overview.adoc
@@ -0,0 +1,8 @@
+[[getting_started_with_openshift_overview]]
+= Getting Started with {xpaasproduct-shortname}
+
+Each quickstart `README{outfilesuffix}` file contains the basic instructions to build and deploy the quickstart to {xpaasproduct-shortname} or {xpaasproductOpenShiftOnline-shortname}.
+
+See link:{LinkOpenShiftGuide}[_{EapForOpenshiftBookName}_] for more detailed information about building and running applications on {xpaasproduct-shortname}.
+
+See link:{LinkOpenShiftOnlineGuide}[_{EapForOpenshiftOnlineBookName}_] for more detailed information about building and running applications on {xpaasproductOpenShiftOnline-shortname}.
diff --git a/shared-doc/cd-openshift-getting-started.adoc b/shared-doc/cd-openshift-getting-started.adoc
@@ -1,5 +1,5 @@
 [[getting_started_with_openshift]]
-= Getting Started with OpenShift
+= Getting Started with {xpaasproduct-shortname}
 
 This document contains the basic instructions to build and deploy this quickstart to {xpaasproduct-shortname} or {xpaasproductOpenShiftOnline-shortname}.
 

diff --git a/shared-doc/suggested-approach.adoc b/shared-doc/suggested-approach.adoc
@@ -0,0 +1,8 @@
+[[suggested_approach_to_the_quickstarts]]
+= Suggested Approach to the Quickstarts
+
+We suggest you approach the quickstarts as follows:
+
+* Regardless of your level of expertise, we suggest you start with the link:helloworld/README{outfilesuffix}[`helloworld`] quickstart. It is the simplest example and is an easy way to prove the server is configured and running correctly.
+* If you are a beginner or new to JBoss, start with the quickstarts labeled `Beginner`, then try those marked as `Intermediate`. When you are comfortable with those, move on to the `Advanced` quickstarts.
+* Some quickstarts are based upon other quickstarts but have expanded capabilities and functionality. If a prerequisite quickstart is listed, make sure you deploy and test it before looking at the expanded version.