Skip to content

Commit 2a27aa3

Browse files
authored
Merge branch 'main' into RHIDP-8196
2 parents a2d6fd6 + bceea79 commit 2a27aa3

File tree

67 files changed

+1606
-33
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+1606
-33
lines changed

artifacts/attributes.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,9 @@
168168
:upgrading-book-title: Upgrading {product}
169169
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
170170
:using-dynamic-plugins-book-title: Using dynamic plugins
171+
172+
:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
173+
:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards
174+
175+
:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
176+
:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
File renamed without changes.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[IMPORTANT]
2+
====
3+
This section describes Developer Preview features in the Model Context Protocol plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
4+
5+
For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
6+
====
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[IMPORTANT]
2+
====
3+
This section describes Developer Preview features in the Scorecard plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
4+
5+
For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
6+
====
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-configuring-scorecards-in-rhdh"]
4+
= Installing and configuring Scorecards to view metrics in your {product} instance
5+
:context: assembly-configuring-scorecards-in-rhdh
6+
7+
You can install and configure the following Scorecards to display metrics and visual health status for software components in the {product-very-short} catalog:
8+
9+
* GitHub Scorecards
10+
* Jira Scorecards
11+
12+
include::modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc[leveloffset=+1]
13+
14+
include::modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc[leveloffset=+1]

assemblies/assembly-configuring-the-quickstarts.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ include::modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc
1111
include::modules/configuring-the-quickstarts/proc-disabling-rhdh-quickstart.adoc[leveloffset=+2]
1212

1313
include::modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc[leveloffset=+1]
14+
15+
include::modules/configuring-the-quickstarts/con-using-rbac-with-quickstarts.adoc[leveloffset=+1]
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-model-context-protocol-tools"]
4+
= Interacting with Model Context Protocol tools for {product}
5+
:context: assembly-model-context-protocol-tools
6+
7+
include::modules/model-context-protocol-tools/con-understanding-model-context-protocol.adoc[leveloffset=+1]
8+
9+
include::modules/model-context-protocol-tools/proc-installing-the-mcp-server-and-tool-plugins.adoc[leveloffset=+1]
10+
11+
include::modules/model-context-protocol-tools/proc-configuring-model-context-protocol.adoc[leveloffset=+1]
12+
13+
include::modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc[leveloffset=+2]
14+
15+
include::modules/model-context-protocol-tools/proc-configuring-mcp-tools-for-developer-lightspeed.adoc[leveloffset=+1]
16+
17+
include::assembly-using-the-mcp-tools-to-access-data.adoc[leveloffset=+1]
18+
19+
include::assembly-troubleshooting-mcp-server-and-client-problems.adoc[leveloffset=+1]

assemblies/assembly-orchestrator-rhdh.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,7 @@ include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.a
4545
include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+2]
4646

4747
// {product-very-short} helper script
48-
include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2]
48+
include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2]
49+
50+
// best practices when creating workflows
51+
include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1]
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-rhdh-observability"]
4+
= Understanding and visualizing {product} project health using Scorecards
5+
:context: assembly-scorecards-rhdh
6+
7+
include::modules/observe/scorecards/con-understand-scorecard-plugins.adoc[leveloffset=+1]
8+
9+
include::modules/observe/scorecards/ref-supported-metrics-providers.adoc[leveloffset=+2]
10+
11+
include::assembly-setting-up-scorecards-to-monitor-your-rhdh-health.adoc[leveloffset=+1]
12+
13+
include::assembly-configuring-scorecards-in-rhdh.adoc[leveloffset=+1]
14+
15+
include::modules/observe/scorecards/con-manage-metric-thresholds-in-scorecard-plugin.adoc[leveloffset=+1]
16+
17+
include::modules/observe/scorecards/con-how-thresholds-work.adoc[leveloffset=+2]
18+
19+
include::modules/observe/scorecards/ref-supported-threshold-expressions.adoc[leveloffset=+2]
20+
21+
include::modules/observe/scorecards/ref-threshold-rules-to-metrics-for-scorecard-plugin.adoc[leveloffset=+2]
22+
23+
include::modules/observe/scorecards/con-set-global-standards-for-metric-thresholds.adoc[leveloffset=+2]
24+
25+
include::modules/observe/scorecards/ref-override-rules-to-configure-entity-specific-thresholds.adoc[leveloffset=+2]
26+
27+
include::modules/observe/scorecards/con-best-practices-for-threshold-rules.adoc[leveloffset=+2]
28+
29+
include::modules/observe/scorecards/proc-viewing-scorecards-in-rhdh.adoc[leveloffset=+1]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-setting-up-scorecards-to-monitor-your-rhdh-health"]
4+
= Setting up Scorecards to monitor your {product} project health
5+
:context: assembly-setting-up-scorecards-to-monitor-your-rhdh-health
6+
7+
include::modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc[leveloffset=+1]
8+
9+
include::modules/observe/scorecards/proc-authenticating-and-managing-scorecard-plugins.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)