Uploaded image for project: 'Satellite'
  1. Satellite
  2. SAT-25769

Documentation feedback: Suggesting changes to Providing Feedback section.

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • None
    • 6.13.0, 6.14.0, 6.15.0
    • Documentation
    • None
    • 0
    • False
    • Hide

      None

      Show
      None
    • False
    • 0
    • Rocket
    • Sat_docs_8_2024
    • No

      Description of problem:

      The New Satellite "Providing Feedback Red Hat Documentation" is written in such a way that it is highly likely that users may incorrectly create tickets for documentation changes in ways that need Red Hat Staff to go in and correct them. For instance some users may think step 2's Create Issue form is badly worded and that they should click on the "Create" Button they see after being sure to log in to Jira in step one  and they may then click on that and start randomly selecting things that don't have the values that the link in step 2 auto populate into the form. Thus, creating more work for you. 

       

      An example of the same Providing feedback that is many Satellite documents as or recently. (note there is no chapter of section number for this section.)  https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html/configuring_virtual_machine_subscriptions_in_red_hat_satellite/providing-feedback-on-red-hat-documentation_vm-subs-satellite and many other 6.13, 6.14 and 6.15 documents. 

       

      How reproducible:

      Every time if you don't click on Create Issues form text because you think it should be in the main Jira interface after logging in.

       

      Is this issue a regression from an earlier version:

      No. 

       

      Steps to Reproduce:

      A. Open any of a number of Satellite documents to their "Providing Feedback on Red Hat Documentation" section. 
       

      B. Perform the documented step 1, ensure you are logged in to red Hat Jira.  using the step 1 link provided. 

      C. Move onto reading Step two but think there should be a button in the page you opened in step one.  Then think there are documentation issues and click on the create button because there is no "Create issues" button on the page you logged into. 

       

      Actual behavior:
      I made assumptions based on the wording and clicked on issues and started filling in my own best guess values as the prefilled in values were missing or definitely wrong.  I thought might be needed to get them to documentation which, I eventually realized was not the values that would have been entered had I click on the link in steps 2. 

      Expected behavior:
      I would be expected the wording to be clearer or, to have a single link that I could click on to if not logged in take me to the login page and then post login directly taken me to the create issue form in step two. 

       

      For instance, step 2 might be better worded go to This Create Issues form link .  with the entere text being the text of the https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12324223&summary=Documentation%20feedback:%20%3CAdd%20summary%20here%3E&issuetype=1&components=12347630&priority=10300 URL. 

       

      Or possibly modify  Jira such that you  don't need step one at all and if you are logged out and click in the documentation on Create Issue form instead of it telling you there is an error, it throws up the log in dialog box and, then once you are logged in you go to the page.

      For instance when I tried to go to the link in step two directly while logged out of jira, and click on the Log_in link of the error,  it took me to the Jira Create Issues Page that had the project and Issue type of bug automatically entered so maybe you should not have step one and just say go to the Create issues form in step two and click login if you receive an error then. Step 3 stuff. 

       

      Business Impact / Additional info:

      This could very well make things harder for Red Hat, and wasted a bit of my time trying to figure out what I was actually supposed to be doing as it was not exactly clear I had to go to that link specifically and not trying to do a create issue button withing the the main Jira interface itself, I had gone to in step 1. . 

            zuansorg Lena Ansorgová
            awkohr2 Alexander Kohr
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: