[release-1.6] RHIDP-6499: Modularize Customizing the Learning Paths (#1088)

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

Author: openshift-cherrypick-robot

assemblies/assembly-customizing-the-learning-paths.adoc

@@ -0,0 +1,15 @@
+[id='proc-customize-rhdh-learning-paths_{context}']
+= Customizing the Learning Paths in {product}
+
+In {product}, you can configure Learning Paths by hosting the required data externally,
+and using the built-in proxy to deliver this data rather than the default.
+
+You can provide Learning Paths data from the following sources:
+
+* A JSON file hosted on a web server, such as GitHub or GitLab.
+* A dedicated service that provides the Learning Paths data in JSON format using an API.
+
+include::modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc[leveloffset=+1]
+
+
+include::modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc[leveloffset=+1]

modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc

@@ -0,0 +1,23 @@
+[id='proc-customizing-the-learning-paths-by-using-a-customization-service_{context}']
+= Customizing the Learning Paths by using a customization service
+
+For advanced scenarios, you can host your {product} customization service to provide data to all configurable {product-short} pages, such as the Learning Paths.
+You can even use a different service for each page.
+
+.Procedure
+. Deploy your {product-short} customization service on the same {ocp-short} cluster as your {product-short} instance.
+You can find an example at link:https://github.com/redhat-developer/red-hat-developer-hub-customization-provider[`red-hat-developer-hub-customization-provider`], that provides the same data as default {product-short} data.
+The customization service provides a Learning Paths data URL such as: `pass:c,a,q[http://_<rhdh-customization-provider>_/learning-paths]`.
+
+. Configure the  {product-short} proxy to use your dedicated service to provide the Learning Path data, add the following to the link:{configuring-book-url}[`{my-app-config-file}` file]:
++
+[source,yaml,subs='+quotes']
+----
+proxy:
+  endpoints:
+    '/developer-hub/learning-paths':
+      target: _<learning_path_data_url>_
+      changeOrigin: true
+      qsecure: true # <1>
+----
+<1> Change to "false" in case of using self hosted cluster with a self-signed certificate

modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-a-dedicated-service.adoc

@@ -0,0 +1,49 @@
+[id='proc-customizing-the-learning-paths-by-using-a-hosted-json-file_{context}']
+= Customizing the Learning Paths by using a hosted JSON file
+
+For ease of use and simplicity, you can configure the Learning Paths by using a hosted JSON file.
+
+.Procedure
+. Publish the JSON file containing your Learning Paths data to a web server, such as GitHub or Gitlab. You can find an example at link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json[].
+
+. Configure the {product-short} proxy to access the Learning Paths data from the hosted JSON file, by adding the following to the `{my-app-config-file}` file:
++
+[source,yaml,subs='+quotes']
+----
+proxy:
+  endpoints:
+    '/developer-hub':
+      target: _<target>_
+      pathRewrite:
+        '^/api/proxy/developer-hub/learning-paths': '_<learning_path.json>_'
+      changeOrigin: true
+      secure: true
+----
+
+`_<target>_`:: Enter the hosted JSON file base URL, such as `https://raw.githubusercontent.com`.
+
+`_<learning_path.json>_`:: Enter the hosted JSON file path without the base URL, such as
+`'/redhat-developer/rhdh/main/packages/app/public/learning-paths/data.json'`
++
+[TIP]
+====
+When also configuring the home page, due to the use of overlapping `pathRewrites` for both the `learning-path` and `homepage` quick access proxies, create the `learning-paths` configuration (`^api/proxy/developer-hub/learning-paths`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`).
+For example:
+
+[source,yaml]
+----
+proxy:
+  endpoints:
+    '/developer-hub':
+      target: https://raw.githubusercontent.com/
+      pathRewrite:
+        '^/api/proxy/developer-hub/learning-paths': '/redhat-developer/rhdh/main/packages/app/public/learning-paths/data.json'
+        '^/api/proxy/developer-hub/tech-radar': '/redhat-developer/rhdh/main/packages/app/public/tech-radar/data-default.json'
+        '^/api/proxy/developer-hub': '/redhat-developer/rhdh/main/packages/app/public/homepage/data.json'
+      changeOrigin: true
+      secure: true
+----
+====
+
+.Additional resources
+* xref:customizing-the-home-page[Customizing the Home page in {product}].

modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc

@@ -20,7 +20,7 @@ include::modules/customizing/proc-customizing-the-backend-secret.adoc[leveloffse
 include::assemblies/assembly-configuring-templates.adoc[leveloffset=+1]
 
 
-include::modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc[leveloffset=+1]
+include::assemblies/assembly-customizing-the-learning-paths.adoc[leveloffset=+1]
 
 
 include::assemblies/assembly-configuring-the-global-header.adoc[leveloffset=+1]