From 509844502fa229fe50fee412f7f31062288ed2f6 Mon Sep 17 00:00:00 2001 From: Agil Antony Date: Tue, 12 May 2026 17:21:58 +0530 Subject: [PATCH] ROX33164 Fixing DITA errors in support/getting-support.adoc fix(support-knowledgebase-about): DITA compatibility fixes - Fixed ShortDescription: Added [role="_abstract"] to REFERENCE module Co-Authored-By: Claude ROX33164 Fixing Vale errors --- modules/common-attributes.adoc | 1 + ...te-diagnostic-bundle-using-acs-portal.adoc | 2 +- ...te-diagnostic-bundle-using-roxctl-cli.adoc | 45 ++++++++++++++++++- modules/generating-diagnostic-bundle.adoc | 15 +++++++ modules/support-knowledgebase-about.adoc | 3 +- modules/support-knowledgebase-search.adoc | 5 ++- modules/support-submitting-a-case.adoc | 15 ++++--- support/getting-support.adoc | 36 +++++++++------ 8 files changed, 98 insertions(+), 24 deletions(-) create mode 100644 modules/generating-diagnostic-bundle.adoc diff --git a/modules/common-attributes.adoc b/modules/common-attributes.adoc index e37b73694076..02697753563a 100644 --- a/modules/common-attributes.adoc +++ b/modules/common-attributes.adoc @@ -59,6 +59,7 @@ endif::[] :ocp: OpenShift Container Platform :ocp-short: OCP :osp: Red{nbsp}Hat OpenShift +:opp: Red{nbsp}Hat OpenShift Platform Plus :product-registry: OpenShift image registry :olm-first: Operator Lifecycle Manager (OLM) :olm: OLM diff --git a/modules/generate-diagnostic-bundle-using-acs-portal.adoc b/modules/generate-diagnostic-bundle-using-acs-portal.adoc index 6cc7f15014ba..fc59eb4e5338 100644 --- a/modules/generate-diagnostic-bundle-using-acs-portal.adoc +++ b/modules/generate-diagnostic-bundle-using-acs-portal.adoc @@ -4,7 +4,7 @@ // * operating/use-system-health-dashboard.adoc :_mod-docs-content-type: PROCEDURE [id="generate-diagnostic-bundle-using-acs-portal_{context}"] -= Generating a diagnostic bundle by using the RHACS portal += Generating a diagnostic bundle by using the {product-title-short} portal [role="_abstract"] You can generate a diagnostic bundle by using the system health dashboard in the {product-title-short} portal. diff --git a/modules/generate-diagnostic-bundle-using-roxctl-cli.adoc b/modules/generate-diagnostic-bundle-using-roxctl-cli.adoc index 2a8852841f9b..09cc050c2d56 100644 --- a/modules/generate-diagnostic-bundle-using-roxctl-cli.adoc +++ b/modules/generate-diagnostic-bundle-using-roxctl-cli.adoc @@ -7,4 +7,47 @@ = Generating a diagnostic bundle by using the roxctl CLI [role="_abstract"] -You can generate a diagnostic bundle with the {rh-rhacs-first} administrator password or API token and central address by using the `roxctl` CLI. \ No newline at end of file +You can use the `roxctl` CLI to generate a diagnostic bundle. You need the {rh-rhacs-first} administrator password or API token and central address. + +.Prerequisites +* To generate a diagnostic bundle, you need `read` permission for the `Administration` resource. + +* You must have configured the {product-title-short} administrator password or API token and central address. + +.Procedure + +* To generate a diagnostic bundle by using the {product-title-short} administrator password, perform the following steps: + +. Run the following command to configure the `ROX_PASSWORD` and `ROX_CENTRAL_ADDRESS` environment variables: ++ +[source,terminal,subs="+quotes"] +---- +$ export ROX_PASSWORD=__ && export ROX_CENTRAL_ADDRESS=_
:_ +---- ++ +where: ++ +-- +:: Specifies the {product-title-short} administrator password. +-- +. Run the following command to generate a diagnostic bundle by using the {product-title-short} administrator password: ++ +[source,terminal] +---- +$ roxctl -e "$ROX_CENTRAL_ADDRESS" -p "$ROX_PASSWORD" central debug download-diagnostics +---- +* To generate a diagnostic bundle by using the API token, perform the following steps: + +. Run the following command to configure the `ROX_API_TOKEN` environment variable: ++ +[source,terminal,subs="+quotes"] +---- +$ export ROX_API_TOKEN=__ +---- + +. Run the following command to generate a diagnostic bundle by using the API token: ++ +[source,terminal] +---- +$ roxctl -e "$ROX_CENTRAL_ADDRESS" central debug download-diagnostics +---- diff --git a/modules/generating-diagnostic-bundle.adoc b/modules/generating-diagnostic-bundle.adoc new file mode 100644 index 000000000000..7b4fa79db2a5 --- /dev/null +++ b/modules/generating-diagnostic-bundle.adoc @@ -0,0 +1,15 @@ +// Module included in the following assemblies: +// +// * support/getting-support.adoc + +:_mod-docs-content-type: CONCEPT +[id="generating-diagnostic-bundle_{context}"] += Generating a diagnostic bundle + +[role="_abstract"] +You can generate a diagnostic bundle to help the support team analyze the status and health of {product-title} components. + +[NOTE] +==== +The diagnostic bundle is not encrypted. Depending on the number of clusters in your environment, the bundle size is between 100 KB and 1 MB. +==== diff --git a/modules/support-knowledgebase-about.adoc b/modules/support-knowledgebase-about.adoc index ad7660a34ac4..c7f4d8f6e4b7 100644 --- a/modules/support-knowledgebase-about.adoc +++ b/modules/support-knowledgebase-about.adoc @@ -5,4 +5,5 @@ [id="support-knowledgebase-about_{context}"] = About the Red Hat Knowledgebase -The link:https://access.redhat.com/knowledgebase[Red{nbsp}Hat Knowledgebase] provides rich content aimed at helping you make the most of Red{nbsp}Hat products and technologies. The Red{nbsp}Hat Knowledgebase consists of articles, product documentation, and videos outlining best practices on installing, configuring, and using Red{nbsp}Hat products. In addition, you can search for solutions to known issues, each providing concise root cause descriptions and remedial steps. \ No newline at end of file +[role="_abstract"] +The Red{nbsp}Hat Knowledgebase provides content to help you make the most of Red{nbsp}Hat products and technologies. The Knowledgebase consists of articles, product documentation, and videos. These resources outline best practices for installing, configuring, and using Red{nbsp}Hat products. You can also search for solutions to known issues, with root cause descriptions and remedial steps. \ No newline at end of file diff --git a/modules/support-knowledgebase-search.adoc b/modules/support-knowledgebase-search.adoc index 21640265caca..fa964617c1ff 100644 --- a/modules/support-knowledgebase-search.adoc +++ b/modules/support-knowledgebase-search.adoc @@ -5,14 +5,15 @@ [id="support-knowledgebase-search_{context}"] = Searching the Red Hat Knowledgebase -In the event of an {product-title} issue, you can perform an initial search to determine if a solution already exists within the Red{nbsp}Hat Knowledgebase. +[role="_abstract"] +If you have a {product-title} issue, you can perform an initial search to find if a solution already exists within the Red{nbsp}Hat Knowledgebase. .Prerequisites * You have a Red{nbsp}Hat Customer Portal account. .Procedure -. Log in to the link:http://access.redhat.com[Red{nbsp}Hat Customer Portal]. +. Log in to the Red{nbsp}Hat Customer Portal. . In the main Red{nbsp}Hat Customer Portal search field, input keywords and strings relating to the problem, including: ** {product-title} components (such as *etcd*) ** Related procedure (such as *installation*) diff --git a/modules/support-submitting-a-case.adoc b/modules/support-submitting-a-case.adoc index 561891eb83d4..1733b9233af6 100644 --- a/modules/support-submitting-a-case.adoc +++ b/modules/support-submitting-a-case.adoc @@ -5,18 +5,21 @@ [id="support-submitting-a-case_{context}"] = Submitting a support case +[role="_abstract"] +You can submit a support case to Red{nbsp}Hat Support for help with {product-title} issues. + .Prerequisites * You have access to the cluster. * You have a Red{nbsp}Hat Customer Portal account. -* You have a link:https://www.redhat.com/en/technologies/cloud-computing/openshift/platform-plus[Red{nbsp}Hat OpenShift Platform Plus] subscription. +* You have a {opp} subscription. .Procedure -. Log in to the link:http://access.redhat.com[Red{nbsp}Hat Customer Portal] and select *SUPPORT CASES* -> *Open a case*. +. Log in to the Red{nbsp}Hat Customer Portal and select *SUPPORT CASES* -> *Open a case*. . Select the appropriate category for your issue (such as *Defect / Bug*), product (*{product-title}*), and product version (*{product-version}*, if this is not already autofilled). -. Review the list of suggested Red{nbsp}Hat Knowledgebase solutions for a potential match against the problem that is being reported. If the suggested articles do not address the issue, click *Continue*. -. Enter a concise but descriptive problem summary and further details about the symptoms being experienced, as well as your expectations. -. Review the updated list of suggested Red{nbsp}Hat Knowledgebase solutions for a potential match against the problem that is being reported. The list is refined as you provide more information during the case creation process. If the suggested articles do not address the issue, click *Continue*. -. Ensure that the account information presented is as expected, and if not, amend accordingly. +. Review the list of suggested Red{nbsp}Hat Knowledgebase solutions for a potential match against the problem you are reporting. If the suggested articles do not address the issue, click *Continue*. +. Enter a concise but descriptive problem summary and further details about the symptoms you are experiencing and your expectations. +. Review the updated list of suggested Red{nbsp}Hat Knowledgebase solutions for a potential match against the problem you are reporting. Providing more information during the case creation process refines the list. If the suggested articles do not address the issue, click *Continue*. +. Ensure that the account information presented is as expected, and if not, change it. . Upload the generated diagnostic bundle and click *Continue*. . Input relevant case management details and click *Continue*. . Preview the case details and click *Submit*. \ No newline at end of file diff --git a/support/getting-support.adoc b/support/getting-support.adoc index 580b6c2e3184..1e71bc9a5577 100644 --- a/support/getting-support.adoc +++ b/support/getting-support.adoc @@ -6,33 +6,43 @@ include::modules/common-attributes.adoc[] toc::[] -This topic provides information about the technical support for {product-title}. +[role="_abstract"] +Learn about the technical support options available for {product-title}. -If you experience difficulty with a procedure described in this documentation, or with {product-title} in general, visit the link:http://access.redhat.com[Red{nbsp}Hat Customer Portal]. From the Customer Portal, you can: +If you experience difficulty with a procedure described in this documentation, or with {product-title} in general, visit the Red{nbsp}Hat Customer Portal. From the Customer Portal, you can: * Search or browse through the Red{nbsp}Hat Knowledgebase of articles and solutions relating to Red{nbsp}Hat products. * Submit a support case to Red{nbsp}Hat Support. * Access other product documentation. -If you have a suggestion for improving the documentation or have identified an error, create a link:https://red.ht/rhacsdocsissue[Jira issue] against the -*{product-title}* product for the *Documentation* component. -Ensure that you include specific details such as the section name and the version of {product-title} for us to manage your feedback effectively. +If you have a suggestion for improving the documentation or have identified an error, create a Jira issue against the *{product-title}* product for the *Documentation* component. Ensure that you include specific details such as the section name and the version of {product-title} for us to manage your feedback effectively. + +[role="_additional-resources"] +.Additional resources +* link:http://access.redhat.com[Red Hat Customer Portal] +* link:https://red.ht/rhacsdocsissue[Report a documentation issue] include::modules/support-knowledgebase-about.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* link:https://access.redhat.com/knowledgebase[Red Hat Knowledgebase] + include::modules/support-knowledgebase-search.adoc[leveloffset=+1] -[id="generating-a-diagnostic-bundle"] -== Generating a diagnostic bundle -You can generate a diagnostic bundle and send that data to enable the support team to provide insights into the status and health of {product-title} components. +[role="_additional-resources"] +.Additional resources +* link:http://access.redhat.com[Red Hat Customer Portal] -[NOTE] -==== -The diagnostic bundle is unencrypted, and depending upon the number of clusters in your environment, the bundle size is between 100 KB and 1 MB. -==== +include::modules/generating-diagnostic-bundle.adoc[leveloffset=+1] include::modules/generate-diagnostic-bundle-using-acs-portal.adoc[leveloffset=+2] include::modules/generate-diagnostic-bundle-using-roxctl-cli.adoc[leveloffset=+2] +include::modules/support-submitting-a-case.adoc[leveloffset=+1] -include::modules/support-submitting-a-case.adoc[leveloffset=+1] \ No newline at end of file +[role="_additional-resources"] +.Additional resources +* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/platform-plus[{opp}] +* link:http://access.redhat.com[Red Hat Customer Portal] \ No newline at end of file