WIP: 02-populate Straight copy of files from mod-docs-repo-example

README.md

@@ -1,2 +1,6 @@
 # publishing-tutorial-sample-repo
-A sample repo to be used in conjunction with the tutorial "Getting started publishing with Pantheon 2" 
+A sample repo to be used in conjunction with the tutorial "Getting started publishing with Pantheon 2"
+
+This repo is a copy of the [Example modular documentation repository (Kogito)](https://github.com/redhat-documentation/modular-docs/tree/mod-doc-repo-example).
+
+For more information, including an explanation of the directories and the directory structure of this repo, see the README file for that repo.

_artifacts/author-group.adoc

@@ -0,0 +1,8 @@
+//:sectnums!:
+ifndef::DOCU_NAME[]
+[appendix]
+[id='author-group']
+= Contact information
+
+{CONTACT}
+endif::DOCU_NAME[]

_artifacts/document-attributes-kogito-comm.adoc

@@ -0,0 +1,12 @@
+// Do NOT delete repeated or superfluous variables unless the same can be deleted from all other attributes docs (for DM, PAM, jBPM, etc.). All attributes here are in use in product docs at this time, and as we single source, we need those same variables to render appropriately for Drools. But do please correct and add info where necessary. (Stetson, 2 Aug 2018)
+
+:PRODUCT: Kogito
+:PRODUCT_SHORT: Kogito
+:PRODUCT_INIT: kogito
+:PRODUCT_INIT_CAP: KOGITO
+:PRODUCT_INIT_BA: kogito
+:PRODUCT_INIT_CAP_BA: KOGITO
+:URL_COMPONENT_PRODUCT: kogito
+
+:OPENSHIFT: OpenShift
+:URL_COMPONENT_OPENSHIFT: openshift

_artifacts/document-attributes-kogito-ent.adoc

@@ -0,0 +1,14 @@
+// Do NOT delete repeated or superfluous variables unless the same can be deleted from all other attributes docs (for DM, PAM, jBPM, etc.). All attributes here are in use in product docs at this time, and as we single source, we need those same variables to render appropriately for Drools. But do please correct and add info where necessary. (Stetson, 2 Aug 2018)
+
+:PRODUCT: Kogito
+:PRODUCT_SHORT: Kogito
+:PRODUCT_INIT: kogito
+:PRODUCT_INIT_CAP: KOGITO
+:PRODUCT_INIT_BA: kogito
+:PRODUCT_INIT_CAP_BA: KOGITO
+:URL_COMPONENT_PRODUCT: kogito
+
+:OPENSHIFT: Red Hat OpenShift Container Platform
+:URL_COMPONENT_OPENSHIFT: red_hat_openshift_container_platform
+
+:CONTACT: {PRODUCT} documentation team: [email protected]

_artifacts/document-attributes.adoc

@@ -0,0 +1,102 @@
+
+:REBUILT: Tuesday, April 21, 2020
+
+:COMMUNITY_VERSION: 0.9
+:ENTERPRISE_VERSION: {COMMUNITY_VERSION}
+:ENTERPRISE_VERSION_LONG: {COMMUNITY_VERSION}.1
+:COMMUNITY_VERSION_LONG: {COMMUNITY_VERSION}.1
+:COMMUNITY_VERSION_FINAL: {COMMUNITY_VERSION_LONG}.Final
+:COMMUNITY_VERSION_BRANCH: 0.9.x
+
+:PRODUCT_FILE: {PRODUCT_INIT}-{ENTERPRISE_VERSION_LONG}
+:PRODUCT_FILE_BA: {PRODUCT_INIT_BA}-{ENTERPRISE_VERSION_LONG}
+
+// For copyright
+:YEAR: 2020
+
+// Maven info, from https://mvnrepository.com (public repo) or https://repository.jboss.org/nexus/index.html#welcome (Nexus repo)
+ifdef::KOGITO-ENT[]
+:MAVEN_ARTIFACT_VERSION: {COMMUNITY_VERSION_FINAL}-redhat-00002
+:BOM_VERSION: {ENTERPRISE_VERSION_LONG}.redhat-00002
+endif::[]
+ifdef::KOGITO-COMM[]
+:MAVEN_ARTIFACT_VERSION: {COMMUNITY_VERSION_FINAL}
+:BOM_VERSION: {COMMUNITY_VERSION_FINAL}
+endif::[]
+
+////
+IMPORTANT: The `{BOM_VERSION}` variable requires additional conditioning in single-sourced content, as shown in this example:
+
+.Example BOM declaration in single-sourced content
+[source,xml,subs="attributes+"]
+----
+ifdef::KOGITO-ENT[]
+  <groupId>com.redhat.ba</groupId>
+  <artifactId>ba-platform-bom</artifactId>
+endif::[]
+ifdef::KOGITO-COMM[]
+  <groupId>org.kie</groupId>
+  <artifactId>kie-platform-bom</artifactId>
+endif::[]
+  <version>{BOM_VERSION}</version>
+----
+////
+
+ifdef::KOGITO-ENT[]
+include::document-attributes-kogito-ent.adoc[]
+endif::KOGITO-ENT[]
+
+ifdef::KOGITO-COMM[]
+include::document-attributes-kogito-comm.adoc[]
+endif::KOGITO-COMM[]
+
+////
+//For source includes
+:kogito-dir: kogito-docs/src/main/asciidoc
+////
+
+// Product and component names
+:PRODUCT_PAM: Red Hat Process Automation Manager
+:PRODUCT_DM: Red Hat Decision Manager
+:PRODUCT_BO: Red Hat Business Optimizer
+:PRODUCT_BA: Red Hat Business Automation
+:PRODUCT_DROOLS: Drools
+:PRODUCT_JBPM: jBPM
+:PRODUCT_OP: OptaPlanner
+
+:DECISION_ENGINE: decision engine
+:DECISION_ENGINE_CAP: Decision engine
+:PROCESS_ENGINE: process engine
+:PROCESS_ENGINE_CAP: process engine
+:PLANNING_ENGINE: planning engine
+:PLANNING_ENGINE_CAP: Planning engine
+:URL_COMPONENT_DECISION_ENGINE: decision-engine
+:URL_COMPONENT_PROCESS_ENGINE: process-engine
+:URL_COMPONENT_PLANNING_ENGINE: planner-engine
+
+// Assembly names (some of these will likely be moved product-specific attrs docs in the future, i.e., document-attributes-dm.adoc and ..-ba.adoc)
+
+:RELEASE_NOTES: Release notes for {PRODUCT} {ENTERPRISE_VERSION}
+:CREATING_RUNNING: Creating and running your first {PRODUCT} services
+:DEPLOYING_ON_OPENSHIFT: Deploying {PRODUCT} services on {OPENSHIFT}
+:DECISION_SERVICES: Developing decision services with {PRODUCT}
+:PROCESS_SERVICES: Developing process services with {PRODUCT}
+:CONFIGURING_KOGITO: Configuring {PRODUCT} supporting services and runtime capabilities
+
+// URL components, for post Dev Preview
+:URL_COMPONENT_FORMAT: html-single
+:URL_BASE_ENTERPRISE: https://access.redhat.com/documentation/en-us/{URL_COMPONENT_PRODUCT}/{ENTERPRISE_VERSION}/{URL_COMPONENT_FORMAT}
+:URL_BASE_BPMSUITE: https://access.redhat.com/documentation/en-us/red-hat-jboss-bpm-suite/{ENTERPRISE_VERSION}/{URL_COMPONENT_FORMAT}
+:URL_BASE_GITHUB_DM: https://github.com/jboss-container-images/rhdm-7-openshift-image/tree/rhdm70-dev
+:URL_BASE_GITHUB_PAM: https://github.com/jboss-container-images/rhpam-7-openshift-image/tree/rhpam70-dev
+
+// URLs for assemblies (some of these will likely be moved product-specific attrs docs in the future, i.e., document-attributes-dm.adoc and ..-ba.adoc)
+
+:URL_RELEASE_NOTES: {URL_BASE_ENTERPRISE}/release_notes_for_{PRODUCT_INIT}_{ENTERPRISE_VERSION}
+:URL_CREATING_RUNNING: {URL_BASE_ENTERPRISE}/creating_and_running_your_first_{PRODUCT_INIT}_services
+:URL_DEPLOYING_ON_OPENSHIFT: {URL_BASE_ENTERPRISE}/deploying_{PRODUCT_INIT}_services_on_{URL_COMPONENT_OPENSHIFT}
+:URL_DECISION_SERVICES: {URL_BASE_ENTERPRISE}/developing_decision_services_with_{PRODUCT_INIT}
+:URL_PROCESS_SERVICES: {URL_BASE_ENTERPRISE}/developing_process_services_with_{PRODUCT_INIT}
+:URL_CONFIGURING_KOGITO: {URL_BASE_ENTERPRISE}/configuring_{PRODUCT_INIT}_supporting_services_and_runtime_capabilities
+
+:ndash: &ndash;

_artifacts/legal-notice.adoc

@@ -0,0 +1,29 @@
+== Legal Notice
+
+Copyright (C) {YEAR} Red Hat, Inc.
+
+This document is licensed by Red Hat under the http://creativecommons.org/licenses/by-sa/3.0/[Creative Commons Attribution-ShareAlike 3.0 Unported License].
+If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc.
+and provide a link to the original.
+If the document is modified, all Red Hat trademarks must be removed.
+
+Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
+
+Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
+
+Linux(R) is the registered trademark of Linus Torvalds in the United States and other countries.
+
+Java(R) is a registered trademark of Oracle and/or its affiliates.
+
+XFS(R) is a trademark of Silicon Graphics International Corp.
+or its subsidiaries in the United States and/or other countries.
+
+MySQL(R) is a registered trademark of MySQL AB in the United States, the European Union and other countries.
+
+Node.js(R) is an official trademark of Joyent.
+Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
+
+The OpenStack(R) Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission.
+We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
+
+All other trademarks are the property of their respective owners.

_artifacts/versioning-information-bigbuild.adoc

@@ -0,0 +1,7 @@
+//:sectnums!:
+
+[appendix]
+[id='versioning-information-bigbuild']
+= Versioning information
+
+Documentation set last updated on {REBUILT}.

_artifacts/versioning-information.adoc

@@ -0,0 +1,8 @@
+//:sectnums!:
+ifndef::DOCU_NAME[]
+[appendix]
+[id='versioning-information']
+= Versioning information
+
+Documentation last updated on {REBUILT}.
+endif::DOCU_NAME[]

_artifacts/xpaas_maven_mirror_url.adoc

@@ -0,0 +1,54 @@
+// This page describes MAVEN_MIRROR_URL variable usage
+// It requires 'bcname' attribute to be set to the name of the product
+
+A repository in Maven holds build artifacts and dependencies of various types
+(all the project jars, library jar, plugins or any other project specific
+artifacts). It also specifies locations from where to download artifacts from,
+while performing the S2I build. Besides using central repositories, it is a
+common practice for organizations to deploy a local custom repository (mirror).
+
+Benefits of using a mirror are:
+
+* Availability of a synchronized mirror, which is geographically closer and
+  faster.
+* Ability to have greater control over the repository content.
+* Possibility to share artifacts across different teams (developers, CI),
+  without the need to rely on public servers and repositories.
+* Improved build times.
+
+Often, a repository manager can serve as local cache to a mirror. Assuming that
+the repository manager is already deployed and reachable externally at
+*_pass:[http://10.0.0.1:8080/repository/internal/]_*, the S2I build can then use this
+manager by supplying the `MAVEN_MIRROR_URL` environment variable to the
+build configuration of the application as follows:
+
+. Identify the name of the build configuration to apply `MAVEN_MIRROR_URL`
+  variable against:
++
+[subs="attributes"]
+----
+oc get bc -o name
+buildconfig/{bcname}
+----
+. Update build configuration of `{bcname}` with a `MAVEN_MIRROR_URL` environment variable
++
+[subs="attributes"]
+----
+oc env bc/{bcname} MAVEN_MIRROR_URL="http://10.0.0.1:8080/repository/internal/"
+buildconfig "{bcname}" updated
+----
+. Verify the setting
++
+[subs="attributes"]
+----
+oc env bc/{bcname} --list
+# buildconfigs {bcname}
+MAVEN_MIRROR_URL=http://10.0.0.1:8080/repository/internal/
+----
+. Schedule new build of the application
+
+NOTE: During application build, you will notice that Maven dependencies are
+pulled from the repository manager, instead of the default public repositories.
+Also, after the build is finished, you will see that the mirror is filled with
+all the dependencies that were retrieved and used during the build.
+