Uploaded image for project: 'Oozie'
  1. Oozie
  2. OOZIE-1881 Docs fixes
  3. OOZIE-1853

Improve the Credentials documentation

    XMLWordPrintableJSON

    Details

    • Type: Sub-task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 4.0.0
    • Fix Version/s: 4.2.0
    • Component/s: docs
    • Labels:
      None

      Description

      We've heard from users that the Credentials documentation isn't very clear or easy to find.

      More specifically:

      1. It's titled "Unified Credentials Module" which, to the user, isn't super-obvious what it means. Perhaps something like "Authenticating with Other Components", "Action Authentication", etc would be more clear
      2. The content of the page itself reads more like a design document; it presents two options for solving the problem with their shortcomings. It would be better to restructure the page to only mention what we did do, and make it more clear how to setup and use the Credentials.
        • The Sample implementation is nice to have, but it's for advanced users. Most users would be interested in the last section of the page where we briefly say how to enable the Credentials classes and the middle of the page where we talk about UI changes.

        Attachments

        1. OOZIE-1853_amendment.patch
          2 kB
          Robert Kanter
        2. OOZIE-1853.patch
          15 kB
          Robert Kanter
        3. OOZIE-1853.patch
          15 kB
          Robert Kanter
        4. OOZIE-1853.patch
          15 kB
          Robert Kanter

          Issue Links

            Activity

              People

              • Assignee:
                rkanter Robert Kanter
                Reporter:
                rkanter Robert Kanter
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: