Bug 2145145

Summary: [Doc] Hyperlinks in Dashboard Guide point to wrong pages/sections
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Sayalee <saraut>
Component: DocumentationAssignee: Akash Raj <akraj>
Documentation sub component: Dashboard Guide QA Contact: Sayalee <saraut>
Status: CLOSED CURRENTRELEASE Docs Contact: Ranjini M N <rmandyam>
Severity: high    
Priority: unspecified CC: akraj, asriram, ceph-doc-bugzilla, rmandyam, vdas
Version: 5.2Keywords: NoDocsQEReview
Target Milestone: ---   
Target Release: 5.3z1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-03-20 18:59:37 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Sayalee 2022-11-23 10:54:20 UTC
Describe the issue:
==================
In the Red Hat Ceph Storage 5- Dashboard Guide, hyperlinks present at multiple instances point at incorrect page.


Describe the task you were trying to accomplish:
-----------------------------------------------
Navigate to section/page through the hyperlink.


Suggestions for improvement:
============================
Correct the hyperlinks to point at correct page.


Document URL:
=============
https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/index


Changes are required at below places:
=====================================

1) Chapter/Section Number and Title: 2.1. Network port requirements for Ceph Dashboard

Under "ADDITIONAL RESOURCES", 
"For more information, see Using and configuring firewalls in Configuring and managing networking."

Fix required at
---------------
Hyperlinks 'Using and configuring firewalls' and 'Configuring and managing networking' point to the same page, 

'Using and configuring firewalls' can point to https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_networking/index#using-and-configuring-firewalld_configuring-and-managing-networking



2) Chapter/Section Number and Title: 2.2. Accessing the Ceph dashboard

Under "ADDITIONAL RESOURCES", 
"For more information, see Changing the dashboard password using the dashboard in the Red Hat Ceph StorageDashboard guide."

Fix required at
---------------
Hyperlinks 'Changing the dashboard password using the dashboard' and 'Red Hat Ceph StorageDashboard guide' point to the same page,

'Changing the dashboard password using the dashboard' can point to https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#changing-the-dashboard-password-using-the-ceph-dashboard_dash



3) Chapter/Section Number and Title: 2.10. Creating an admin account for syncing users to the Ceph dashboard

Under the section number and title there is below info, 
"After creating the account, use Red Hat Single Sign-on (SSO) to synchronize users to the Ceph dashboard. See the Syncing users to the Ceph dashboard using Red Hat Single Sign-On section in the Red Hat Ceph Storage Dashboard Guide."

Fix required at
---------------
Hyperlink should point to  https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/ceph-dashboard-installation-and-access#syncing-users-to-the-ceph-dashboard-using-red-hat-single-sign-on_dash



4) Chapter/Section Number and Title: 2.11. Syncing users to the Ceph dashboard using Red Hat Single Sign-On

Under "Prerequisites"

Fix required at
---------------
"Users are added to the dashboard. See the Creating users on dashboard section in the Red Hat Ceph Storage Dashboard Guide."; 
>> hyperlink should point to https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/management-of-users-on-the-ceph-dashboard#creating-users-on-the-ceph-dashboard_dash


"Admin account created for syncing users. See the Creating an admin account for syncing users to the Ceph dashboard section in the Red Hat Ceph Storage Dashboard Guide."; 
>> hyperlink should point to https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/ceph-dashboard-installation-and-access#creating-an-admin-account-for-syncing-users-to-the-ceph-dashboard_dash


Under "ADDITIONAL RESOURCES"

Fix required at
---------------
For adding roles for users on the dashboard, see the Creating roles on dashboard section in the Red Hat Ceph Storage Dashboard Guide for more information.; 
>> hyperlink should point to 
https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/management-of-roles-on-the-ceph-dashboard#creating-roles-on-the-ceph-dashboard_dash



5) Chapter/Section Number and Title: 3.1. User roles and permissions on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fix required at
---------------
For creating users on the Ceph dashboard, see Creating users on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.;
>> hyperlink should point to https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/management-of-users-on-the-ceph-dashboard#creating-users-on-the-ceph-dashboard_dash


For creating roles on the Ceph dashboard, see Creating roles on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.
>> hyperlink should point to https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/management-of-roles-on-the-ceph-dashboard#creating-roles-on-the-ceph-dashboard_dash



6) Chapter/Section Number and Title: 3.2. Creating roles on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fix required at
---------------
See the Creating users on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard Guide for more details.;
>> hyperlink should point to https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/management-of-users-on-the-ceph-dashboard#creating-users-on-the-ceph-dashboard_dash



7) Chapter/Section Number and Title: 7.3. Viewing alerts on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fix required at
---------------
See the Using the Ceph Manager alerts module for more details to configure SMTP.;
>> hyperlink points to first page of the Dashboard Guide instead of directing to the correct section.



8) Chapter/Section Number and Title: 8.1. Configuring NFS Ganesha daemons on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fix required at
---------------
For more information on adding object gateway login credentials to the dashboard, see the Manually adding object gateway login credentials to the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.;
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#manually-adding-ceph-object-gateway-login-credentials-to-the-dashboard_dash


For more information on creating object gateway users on the dashboard, see the Creating object gateway users on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#creating-ceph-object-gateway-users-on-the-dashboard_dash


For more information on creating object gateway buckets on the dashboard, see the Creating object gateway buckets on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.;
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/dashboard_guide/management-of-ceph-object-gateway-using-the-dashboard#creating-ceph-object-gateway-buckets-on-the-dashboard_dash


For more information on system roles, see the System roles on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard Guide.;
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#user-roles-and-permissions-on-the-ceph-dashboard_dash




9) Chapter/Section Number and Title: 8.3. Editing NFS Ganesha daemons on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
All the hyperlinks under this section point to the first page of the Dashboard Guide, add links to the correct section/page.



10) Chapter/Section Number and Title: 8.4 Deleting NFS Ganesha daemons on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
All the hyperlinks under this section point to the first page of the Dashboard Guide, add links to the correct section/page.



11) Chapter/Section Number and Title: 11.3. Replacing the failed OSDs on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
For more information on system roles, see the System roles on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard Guide.;
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#user-roles-and-permissions-on-the-ceph-dashboard_dash



12) Chapter/Section Number and Title: 12.3.2. Creating Ceph object gateway users on the dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
See the Adding Ceph object gateway login credentials to the dashboard section in the Red Hat Ceph Storage Dashboard guide for more information.
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#manually-adding-ceph-object-gateway-login-credentials-to-the-dashboard_dash



13) Chapter/Section Number and Title: 12.3.4. Editing Ceph object gateway users on the dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
See the Adding Ceph object gateway login credentials to the dashboard section in the Red Hat Ceph Storage Dashboard guide for more information.
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#manually-adding-ceph-object-gateway-login-credentials-to-the-dashboard_dash



14) Chapter/Section Number and Title: 12.3.5. Deleting Ceph object gateway users on the dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
See the Adding Ceph object gateway login credentials to the dashboard section in the Red Hat Ceph Storage Dashboard guide for more information.
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#manually-adding-ceph-object-gateway-login-credentials-to-the-dashboard_dash



15) Chapter/Section Number and Title: 12.5. Monitoring multisite object gateway configuration on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------

Hyperlinks in below points navigate to first page of dashboard guide and need correction-

For more information on adding object gateway login credentials to the dashboard, see the Manually adding object gateway login credentials to the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on creating object gateway users on the dashboard, see the Creating object gateway users on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on creating object gateway buckets on the dashboard, see the Creating object gateway buckets on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.



16) Chapter/Section Number and Title: 12.6.2. Editing buckets of a multisite object gateway configuration on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------

Hyperlinks in below points navigate to first page of dashboard guide and need correction-

For more information on adding object gateway login credentials to the dashboard, see the Manually adding object gateway login credentials to the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on creating object gateway users on the dashboard, see the Creating object gateway users on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on creating object gateway buckets on the dashboard, see the Creating object gateway buckets on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on system roles, see the System roles on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard Guide.



17) Chapter/Section Number and Title: 12.6.3. Deleting buckets of a multisite object gateway configuration on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------

Hyperlinks in below points navigate to first page of dashboard guide and need correction-

For more information on adding object gateway login credentials to the dashboard, see the Manually adding object gateway login credentials to the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on creating object gateway users on the dashboard, see the Creating object gateway users on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on creating object gateway buckets on the dashboard, see the Creating object gateway buckets on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard guide.

For more information on system roles, see the System roles on the Ceph dashboard section in the Red Hat Ceph Storage Dashboard Guide.



18) Chapter/Section Number and Title: 13.1.7. Restoring images from trash on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
See the Creating images section in the Red Hat Ceph Storage Dashboard Guide for more details on creating images in an RBD pool.;
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/dashboard_guide/index#creating-images-on-the-ceph-dashboard_dash



19) Chapter/Section Number and Title: 13.2.3. Adding peer in mirroring on the Ceph dashboard

Under "ADDITIONAL RESOURCES"

Fixed required at
-----------------
See the Adding a storage cluster peer section in the Red Hat Ceph Storage Block Device Guide for more information.;
>> hyperlink should point at https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/block_device_guide/index#administration-for-mirroring-ceph-block-devices



Product Version:
================
Red Hat Ceph Storage 5