Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-57406

credentials plugin user guide is system-centric rather than user-centric

      I am reading the Jenkins credentials plugin user guide to try to understand an issue I'm having with my Jenkins setup, and I am finding it extremely frustrating.  The guide is written by someone(s?) who obviously understand the credentials plugin well, and the motivation behind it; unfortunately, it assumes that I want or need to understand everything about the plugin in order to do anything with it.  I just want to use the thing, not learn the whys and wherefores of its creation.  It has no internal links to facilitate navigation around the document; section headers are difficult to find while scrolling; detailed step-by-step screenshots are put next to overviews. 

          [JENKINS-57406] credentials plugin user guide is system-centric rather than user-centric

          Dan Davies Brackett created issue -
          Ian Williams made changes -
          Labels New: new-permission
          Ian Williams made changes -
          Environment Original: I am reading the Jenkins credentials plugin user guide to try to understand an issue I'm having with my Jenkins setup, and I am finding it extremely frustrating. The guide is written by someone(s?) who obviously understand the credentials plugin well, and the motivation behind it; unfortunately, it assumes that I want or need to understand everything about the plugin in order to do anything with it. I just want to use the thing, not learn the whys and wherefores of its creation. It has no internal links to facilitate navigation around the document; section headers are difficult to find while scrolling; detailed step-by-step screenshots are put next to overviews.
          Ian Williams made changes -
          Description New: I am reading the Jenkins credentials plugin user guide to try to understand an issue I'm having with my Jenkins setup, and I am finding it extremely frustrating.  The guide is written by someone(s?) who obviously understand the credentials plugin well, and the motivation behind it; unfortunately, it assumes that I want or need to understand everything about the plugin in order to do anything with it.  I just want to use the thing, not learn the whys and wherefores of its creation.  It has no internal links to facilitate navigation around the document; section headers are difficult to find while scrolling; detailed step-by-step screenshots are put next to overviews. 
          Ian Williams made changes -
          Labels Original: new-permission New: newbie-friendly
          Oleg Nenashev made changes -
          Labels Original: newbie-friendly New: documentation newbie-friendly

          Mark Waite added a comment -

          The Jenkins credentials documentation page provides an overview and links to the using credentials page page. An overview video is included in that page as well. Pipeline examples are included in the Jenkins Pipeline documentation as well.

          Mark Waite added a comment - The Jenkins credentials documentation page provides an overview and links to the using credentials page page. An overview video is included in that page as well. Pipeline examples are included in the Jenkins Pipeline documentation as well.
          Mark Waite made changes -
          Labels Original: documentation newbie-friendly New: documentation

            Unassigned Unassigned
            ddbrackett Dan Davies Brackett
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: