Uploaded image for project: 'Red Hat OpenShift Data Science'
  1. Red Hat OpenShift Data Science
  2. RHODS-2156

Troubleshooting sections have multiple different users

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • RHODS_1.11.0_GA
    • RHODS_1.1_GA
    • Documentation
    • None

      In troubleshooting sections like "I see a database or disk is full error or a no space left on device error when I run my notebook cells", the documentation refers to two different user types (data scientists and administrators) as "you". This is confusing, as some users won't have the permissions to do both tasks.

      We need to organise these tasks in a way that makes sense for whoever reads them. "User" and "administrator" may be appropriate alternatives for "Data scientist" and "IT Ops admin"

      Direct quotes from doc:

      In the Problem section, the "you" is talking to a user.
      but in the Diagnosis section, we are talking to an admin.

      We should have a clarifying statement that the diagnosis steps are for the Admin.
      May be:

      • The last sentence under problem should read: "Contact your administrator so that they can perform the diagnosis steps below."

       

      Also:

      about "start the notebook server that belongs to the user having problems". An admin will likely not know how to do this. If we have more descriptive instructions, we should link to them.

      [LB] Agreed, the split audience here is something I want to improve on in the future. TODO - create a story/bug to structure the troubleshooting content appropriately for both users and administrators

      I think it would be simpler and more accurate to simply refer to "users" and "administrators".
      Mentioning "data scientist" might not always fit:
      A "data engineer" might also use Jupyter, and not think of themselves as Data Scientist.

      But people will always know whether they are a user or an administrator.

       

       

              rhn-support-chtyler Chris Tyler
              rhn-ecs-lbailey Laura Bailey
              Jorge Garcia Oncins Jorge Garcia Oncins
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: