QOS tables are not easy to find on the new documentation

[RVNOAA]

Example: https://oriondocs.rdhpcs.noaa.gov/wiki/index.php?title=Running_Jobs_on_MSU-HPC#Specifying_a_Partition or https://rdhpcs-common-docs.rdhpcs.noaa.gov/wiki/index.php?title=Running_and_Monitoring_Jobs#Specifying_a_Partition

In the old docs it's easy to find the tables and I can't find them in the new docs.

[underwoo]

There are two issues here that make discovery of this information difficult:

1. The table is in a strange location — it is on the policy page. I'm not sure why it was placed there other than the table was in the common docs and not on the site-specific pages on the wikis.
   2 The sidebar menu has the text "Specifying a Quality of Service (QOS)" and "Changing QOS's." With this text in the menu, searching for "quality of service" and "QOS" will show every page as a valid, good result.

We are still learning to optimize the search (SEO) and will apply items as we understand them. We can experiment with the data-nosnippet HTML attribute to hide the menus from the Google search snippet.

However, both of the above will only do so much. The actual resolution, which should have also been done this way on the wikis, is to replace the host-specific content in the "common" areas with instructions to the user on how to get the information on the systems and place host-specific information on the host pages.

In this example, the Slurm page should indicate how a user can discover the valid QOSes on the systems (sacctmgr show qos), and then on the hera and jet pages list the QOSes with more specific information This helps both the users who search, and others who are reading the pages.

[RVNOAA]

Hi Seth,

Thank you for the quick reply. I agree the placement is not correct and that needs to be updated. I've copied Forrest, David, and Raghu so we can bring more people into this discussion as to where to place within the new document context. The sidebar is nice, but we will need users to be able to find this via 'search' as that's what most users do out of the gate. Renn Valo NOAA Affiliate NOAA Systems Administrator – HPC RIVA/Cherokee 1(508)-495-2303

On Tue, Aug 20, 2024 at 12:39 PM Seth Underwood @.***> wrote:

There are two issues here that make discovery of this information difficult:

1. The table is in a strange location — it is on the policy page. I'm not sure why it was placed there other than the table was in the common docs and not on the site-specific pages on the wikis. 2 The sidebar menu has the text "Specifying a Quality of Service (QOS)" and "Changing QOS's." With this text in the menu, searching for "quality of service" and "QOS" will show every page as a valid, good result.

We are still learning to optimize the search (SEO) and will apply items as we understand them. We can experiment with the data-nosnippet HTML attribute https://developers.google.com/search/docs/crawling-indexing/robots-meta-tag#data-nosnippet-attr to hide the menus from the Google search snippet.

However, both of the above will only do so much. The actual resolution, which should have also been done this way on the wikis, is to replace the host-specific content in the "common" areas with instructions to the user on how to get the information on the systems and place host-specific information on the host pages.

In this example, the Slurm page should indicate how a user can discover the valid QOSes on the systems (sacctmgr show qos), and then on the hera and jet pages list the QOSes with more specific information This helps both the users who search, and others who are reading the pages.

— Reply to this email directly, view it on GitHub https://github.com/NOAA-RDHPCS/noaa-rdhpcs.github.io/issues/183#issuecomment-2299504011, or unsubscribe https://github.com/notifications/unsubscribe-auth/A7YZFEZQTIFEHG5VKX2EJGDZSOEMPAVCNFSM6AAAAABM2FMBBOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEOJZGUYDIMBRGE . You are receiving this because you authored the thread.Message ID: @.***>

[elisabethpatterson]

Forrest and User Support team request this information be transferred to the Slurm pages, and Partition information as we

[elisabethpatterson]

195 and #196 will update the Hera and Jet user guides to include the QOS tables, as Seth instructed.

[chanwilson]

Closing issue, Slurm information has been collected under the slurm/ location. The Jet QOS table that was (incorrectly) part of common-docs is available in the Jet area at https://docs.rdhpcs.noaa.gov/systems/jet_user_guide.html#jet-partitions