generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 47
RHIDP-6499: Modularize Learning Paths docs #1008
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
:context: customizing-learning-paths | ||
[id="{context}"] | ||
= Customizing the Learning Paths in {product} | ||
|
||
In {product}, you can configure Learning Paths by passing the data into the `{my-app-config-file}` file as a proxy. The base URL must include the `/developer-hub/learning-paths` proxy. | ||
|
||
[NOTE] | ||
==== | ||
Due to the use of overlapping `pathRewrites` for both the `learning-path` and `homepage` quick access proxies, you must create the `learning-paths` configuration (`^api/proxy/developer-hub/learning-paths`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`). | ||
|
||
For more information about customizing the Home page in {product}, see xref:customizing-the-home-page[Customizing the Home page in {product}]. | ||
==== | ||
|
||
You can provide data to the Learning Path from the following sources: | ||
|
||
* JSON files hosted on GitHub or GitLab. | ||
* A dedicated service that provides the Learning Path data in JSON format using an API. | ||
|
||
include::modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths-json-files.adoc[] | ||
|
||
include::modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths-dedicated-service.adoc[] |
44 changes: 1 addition & 43 deletions
44
...s/proc-customize-rhdh-learning-paths.adoc → ...hdh-learning-paths-dedicated-service.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...stomizing-the-learning-paths/proc-customize-rhdh-learning-paths-json-files.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,28 @@ | ||||||
[id='proc-customize-rhdh-learning-paths-json-files_{context}'] | ||||||
|
||||||
== Using hosted JSON files to provide data to the Learning Paths | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
.Prerequisites | ||||||
|
||||||
You have installed {product} by using either the Operator or Helm chart. | ||||||
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}]. | ||||||
|
||||||
.Procedure | ||||||
|
||||||
To access the data from the JSON files, complete the following step: | ||||||
|
||||||
* Add the following code to the `{my-app-config-file}` file: | ||||||
+ | ||||||
[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 | ||||||
---- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.