Skip to content

Commit ae319ed

Browse files
themr0cclaude
andauthored
[RHIDP-12906]: Audit and fix book-link/book-title attributes (#1961)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 74095e0 commit ae319ed

7 files changed

Lines changed: 32 additions & 30 deletions

File tree

artifacts/attributes.adoc

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@
115115
// Links and their title (in alphabetical order)
116116
:about-book-link: {product-docs-link}/html-single/about_red_hat_developer_hub/index
117117
:about-book-title: About {product}
118-
:adoption-insights-link: {product-docs-link}/html-single/adoption_insights_in_red_hat_developer_hub/index
119-
:adoption-insights-title: Adoption Insights in {product}
118+
:adoption-insights-book-link: {product-docs-link}/html-single/adoption_insights_in_red_hat_developer_hub/index
119+
:adoption-insights-book-title: Adoption Insights in {product}
120120
:ansible-automation-platform-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{ansible-automation-platform-version}
121121
:audit-log-book-link: {product-docs-link}/html-single/audit_logs_in_red_hat_developer_hub/index
122122
:audit-log-book-title: Audit logs in {product}
@@ -133,14 +133,15 @@
133133
:customizing-book-link: {product-docs-link}/html-single/customizing_red_hat_developer_hub/index
134134
:customizing-book-title: Customizing {product}
135135
:default-helm-chart-values-link: link:https://github.com/redhat-developer/rhdh-chart/blob/release-{product-version}/charts/backstage/values.yaml
136-
:developer-lightspeed-link: {product-docs-link}/html-single/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/index
136+
:develop-and-deploy-dynamic-plugins-book-link: {product-docs-link}/html-single/develop_and_deploy_dynamic_plugins_in_red_hat_developer_hub/index
137+
:develop-and-deploy-dynamic-plugins-book-title: Develop and deploy dynamic plugins in {product}
138+
:developer-lightspeed-book-link: {product-docs-link}/html-single/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/index
139+
:developer-lightspeed-book-title: Interacting with {ls-brand-name}
137140
:discover-category-link: {product-docs-link}/#Discover
138141
:dynamic-plugins-default-yaml-link: link:https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml
139142
:dynamic-plugins-reference-book-link: {product-docs-link}/html-single/dynamic_plugins_reference/index
140143
:dynamic-plugins-reference-book-title: Dynamic plugins reference
141144
:extend-category-link: {product-docs-link}/#Extend
142-
:getting-started-on-ocp-for-the-platform-engineer-book-link: {product-docs-link}/html-single/getting_started_with_red_hat_developer_hub_on_red_hat_openshift_container_platform_for_the_platform_engineer/index
143-
:getting-started-on-ocp-for-the-platform-engineer-book-title: Getting started with {product} on {ocp-brand-name} for the platform engineer
144145
:install-category-link: {product-docs-link}/#Install
145146
:installing-and-viewing-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
146147
:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}
@@ -156,23 +157,22 @@
156157
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
157158
:installing-on-osd-on-gcp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud/index
158159
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
159-
:installing-rhdh-orch-on-ocp-book-link: {product-docs-link}/html-single/installing_rhdh_with_orchestrator_plugin_on_{ocp-short}_using_operator_in_an_air-gapped_environment/index
160-
:installing-rhdh-orch-on-ocp-book-title: Installing RHDH with the Orchestrator Plugin on {ocp-short} using the {product} Operator
161160
:integrating-with-github-book-link: {product-docs-link}/html-single/integrating_red_hat_developer_hub_with_github/index
162161
:integrating-with-github-book-title: Integrating {product} with GitHub
163162
:learning-path-data-json-link: link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json
164-
:manage-and-consume-techdocs-link: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.8/html-single/manage_and_consume_technical_documentation_within_red_hat_developer_hub/index
165-
:manage-and-consume-techdocs-title: Manage and consume technical documentation within {product}
166-
:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
167-
:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
163+
:manage-and-consume-techdocs-book-link: {product-docs-link}/html-single/manage_and_consume_technical_documentation_within_red_hat_developer_hub/index
164+
:manage-and-consume-techdocs-book-title: Manage and consume technical documentation within {product}
165+
:model-context-protocol-book-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
166+
:model-context-protocol-book-title: Interacting with Model Context Protocol tools for {product}
168167
:monitoring-and-logging-book-link: {product-docs-link}/html-single/monitoring_and_logging/index
169168
:monitoring-and-logging-book-title: Monitoring and logging
170-
:navigate-rhdh-on-your-first-day-link: {product-docs-link}/html-single/navigate_red_hat_developer_hub_on_your_first_day/index
171-
:navigate-rhdh-on-your-first-day-title: Navigate {product} on your first day
169+
:navigate-rhdh-on-your-first-day-book-link: {product-docs-link}/html-single/navigate_red_hat_developer_hub_on_your_first_day/index
170+
:navigate-rhdh-on-your-first-day-book-title: Navigate {product} on your first day
172171
:observability-category-link: {product-docs-link}/#Observability
173172
:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
174173
:odf-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/{ocp-version}
175-
:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index
174+
:openshift-ai-connector-for-rhdh-book-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index
175+
:openshift-ai-connector-for-rhdh-book-title: Accelerate AI development with {openshift-ai-connector-name}
176176
:orchestrator-book-link: {product-docs-link}/html-single/orchestrator_in_red_hat_developer_hub/index
177177
:orchestrator-book-title: Orchestrator in {product}
178178
:osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version}
@@ -184,6 +184,8 @@
184184
:rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version}
185185
:scorecard-plugin-book-link: {product-docs-link}/html-single/evaluate_project_health_using_scorecards/index
186186
:scorecard-plugin-book-title: Evaluate project health using Scorecards
187+
:setting-up-and-configuring-book-link: {product-docs-link}/html-single/setting_up_and_configuring_your_first_red_hat_developer_hub_instance/index
188+
:setting-up-and-configuring-book-title: Setting up and configuring your first {product} instance
187189
:streamline-software-development-and-management-in-rhdh-book-link: {product-docs-link}/html-single/streamline_software_development_and_management_in_red_hat_developer_hub/index
188190
:streamline-software-development-and-management-in-rhdh-book-title: Streamline software development and management in {product}
189191
:techdocs-book-link: {product-docs-link}/html-single/techdocs_for_red_hat_developer_hub/index
@@ -193,7 +195,7 @@
193195
:upgrade-category-link: {product-docs-link}/#Upgrade
194196
:upgrading-book-link: {product-docs-link}/html-single/upgrading_red_hat_developer_hub/index
195197
:upgrading-book-title: Upgrading {product}
196-
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
197-
:using-dynamic-plugins-book-title: Using dynamic plugins
198+
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/using_dynamic_plugins_in_red_hat_developer_hub/index
199+
:using-dynamic-plugins-book-title: Using dynamic plugins in {product}
198200

199201

assemblies/get-started_navigate-rhdh-on-your-first-day/assembly-search-for-relevant-content-in-technical-documentation-techdocs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ include::../modules/shared/proc-access-and-navigate-documentation.adoc[leveloffs
2222
[role="_additional-resources"]
2323
== Additional resources
2424

25-
* {manage-and-consume-techdocs-link}[{manage-and-consume-techdocs-title}]
25+
* {manage-and-consume-techdocs-book-link}[{manage-and-consume-techdocs-book-title}]
2626
ifdef::parent-context[:context: {parent-context}]
2727
ifndef::parent-context[:!context:]

assemblies/shared/assembly-customize.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ifdef::context[:parent-context: {context}]
77

88
:context: customize
99
[role="_abstract"]
10-
You can customize {ls-short} functionalities such as gathering feedback, storing chat history in PostgreSQL, and {model-context-protocol-link}#proc-configure-mcp-tools-for-developer-lightspeed_assembly-model-context-protocol-tools[configuring Model Context Protocol (MCP) tools].
10+
You can customize {ls-short} functionalities such as gathering feedback, storing chat history in PostgreSQL, and {model-context-protocol-book-link}#proc-configure-mcp-tools-for-developer-lightspeed_assembly-model-context-protocol-tools[configuring Model Context Protocol (MCP) tools].
1111

1212
include::../modules/shared/proc-gather-feedback-in.adoc[leveloffset=+1]
1313

modules/get-started_navigate-rhdh-on-your-first-day/con-overview-of-the-onboarding-workflow.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,26 @@ Your first step will be to confirm that you log in as the correct user and that
1313
* *Authenticate*: Access your organization's {product-very-short} URL and log in using your corporate credentials.
1414
* *Check your identity*: Click your avatar or name in the Global Header and select *Settings*. Verify that the *User Entity* matches your corporate identity.
1515
* *Verify ownership*: Navigate to *My Profile* from the user menu. Check the *Ownership* card to confirm it lists the components, APIs, and systems you or your team are responsible for. If this list is empty, you might need to register your ownership in the Software Catalog.
16-
For more information, see {navigate-rhdh-on-your-first-day-link}#log-in-to-rhdh[Log in to {product-very-short}].
16+
For more information, see {navigate-rhdh-on-your-first-day-book-link}#log-in-to-rhdh[Log in to {product-very-short}].
1717

1818
== Organize your workspace
1919

2020
To reduce navigation time across the software ecosystem, curate a list of high-priority resources.
2121

22-
* *Star your services*: Locate your often used components in the *Catalog* and select the *Add to favourites* (star) icon to add them to your favorites. See {navigate-rhdh-on-your-first-day-link}#managing-starred-items-for-quick-access[starred items].
22+
* *Star your services*: Locate your often used components in the *Catalog* and select the *Add to favourites* (star) icon to add them to your favorites. See {navigate-rhdh-on-your-first-day-book-link}#managing-starred-items-for-quick-access[starred items].
2323
* *Access starred items*: Use the *Starred Items* menu in the Global Header to open your favorite resources quickly.
24-
* *Pin the Sidebar*: Use this if you switch often between tools. The system pins the sidebar by default. To unpin the sidebar, go to *Settings* and clear *Pin Sidebar*. See {navigate-rhdh-on-your-first-day-link}#customize-interface-settings[Customize your {product-very-short} interface settings].
24+
* *Pin the Sidebar*: Use this if you switch often between tools. The system pins the sidebar by default. To unpin the sidebar, go to *Settings* and clear *Pin Sidebar*. See {navigate-rhdh-on-your-first-day-book-link}#customize-interface-settings[Customize your {product-very-short} interface settings].
2525

2626
== Explore production resources
2727

2828
Production instances give access to live infrastructure data and technical guides that you need for operational tasks.
2929

30-
* {navigate-rhdh-on-your-first-day-link}#finding-and-viewing-techdocs[*See production documentation*]: Use the *Docs* menu to find production-specific documentation, such as run books or deployment guides linked to your components.
31-
* {navigate-rhdh-on-your-first-day-link}#verify-api-contracts-before-integration[*Check production APIs*]: Navigate to the *APIs* page to verify that production endpoint definitions are correct and discoverable.
32-
* {navigate-rhdh-on-your-first-day-link}#import-and-use-an-existing-template-for-faster-development[*Test Self-Service templates*]: Click *Create* (+) in the Global Header to review available Software Templates. Check that you have access to the Software Templates that you need to generate new production services.
30+
* {navigate-rhdh-on-your-first-day-book-link}#finding-and-viewing-techdocs[*See production documentation*]: Use the *Docs* menu to find production-specific documentation, such as run books or deployment guides linked to your components.
31+
* {navigate-rhdh-on-your-first-day-book-link}#verify-api-contracts-before-integration[*Check production APIs*]: Navigate to the *APIs* page to verify that production endpoint definitions are correct and discoverable.
32+
* {navigate-rhdh-on-your-first-day-book-link}#import-and-use-an-existing-template-for-faster-development[*Test Self-Service templates*]: Click *Create* (+) in the Global Header to review available Software Templates. Check that you have access to the Software Templates that you need to generate new production services.
3333

3434
== Next steps
3535

36-
* {navigate-rhdh-on-your-first-day-link}#con-navigate-the-rhdh-interface_quickly-gain-access-and-find-what-you-need-in-rhdh[*Start your day*]: Navigate to the {product-very-short} *Home Page* to view your personalized dashboard.
37-
* {navigate-rhdh-on-your-first-day-link}#con-navigate-the-rhdh-interface_quickly-gain-access-and-find-what-you-need-in-rhdh[*Learn the interface*]: Understand the Global Header and Sidebar tools.
38-
* {navigate-rhdh-on-your-first-day-link}#get-ai-assisted-help[*Get AI help*]: If enabled in production, open {ls-short} to ask questions about your new environment.
36+
* {navigate-rhdh-on-your-first-day-book-link}#con-navigate-the-rhdh-interface_quickly-gain-access-and-find-what-you-need-in-rhdh[*Start your day*]: Navigate to the {product-very-short} *Home Page* to view your personalized dashboard.
37+
* {navigate-rhdh-on-your-first-day-book-link}#con-navigate-the-rhdh-interface_quickly-gain-access-and-find-what-you-need-in-rhdh[*Learn the interface*]: Understand the Global Header and Sidebar tools.
38+
* {navigate-rhdh-on-your-first-day-book-link}#get-ai-assisted-help[*Get AI help*]: If enabled in production, open {ls-short} to ask questions about your new environment.

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-mcp-clients-to-access-the-rhdh-server.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ where:
6767
`<MCP_TOKEN>`:: Enter the previously configured static token
6868
`pass:c,a,q[{my-product-domain}]`:: Enter the hostname of your {product-very-short} instance
6969

70-
. Configure *{ls-short}* as a client. For more details, see {developer-lightspeed-link}[{ls-brand-name}].
70+
. Configure *{ls-short}* as a client. For more details, see {developer-lightspeed-book-link}[{ls-brand-name}].
7171
.. In the `lightspeed-stack.yaml` configuration, add the following configuration for `mcp_servers`:
7272
+
7373
[source,yaml,subs="+attributes,+quotes"]

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-model-context-protocol-in-rhdh.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can enable your MCP client applications to use the MCP protocol to access {p
1010

1111
.Prerequisites
1212

13-
* You have {model-context-protocol-link}#install-the-mcp-server-and-tool-plugins-in-red-hat-developer-hub[installed the MCP server and tool plugins in {product}].
13+
* You have {model-context-protocol-book-link}#install-the-mcp-server-and-tool-plugins-in-red-hat-developer-hub[installed the MCP server and tool plugins in {product}].
1414

1515
.Procedure
1616

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-resolve-authentication-issues-when-tools-are-not-found.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ If your MCP client connects to the server but cannot find deployed tools, an aut
1818
.. Use *legacy SSE endpoint* if your MCP client requires it instead of the Streamable endpoint. (For more details, see the *Configuration* topic).
1919
. Verify your {product-very-short} `{my-app-config-file}` file for duplicate backend entries and make sure that the indentation is accurate.
2020
.. Make sure that the configuration for the static token and MCP plugin sources go under an existing backend field, if one is present.
21-
.. If you are unsure, see {model-context-protocol-link}#configure-model-context-protocol-in-red-hat-developer-hub[the sample app configuration provided in the reference procedure].
21+
.. If you are unsure, see {model-context-protocol-book-link}#configure-model-context-protocol-in-red-hat-developer-hub[the sample app configuration provided in the reference procedure].

0 commit comments

Comments
 (0)