jenkinsci / jenkinsci/credentials-plugin

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

Open
#832 1 comment 0 reactions 0 assignees View on GitHub
component:credentials-plugin documentation imported-jira-issue priority:minor resolution:unresolved
Dominant language
Java
Stars
134
Forks
258
Avg merge
48m
Merged PRs (30d)
1

Description

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. 

---
Originally reported by ddbrackett, imported from: credentials plugin user guide is system-centric rather than user-centric


  • status: Open
  • priority: Minor
  • component(s): credentials-plugin
  • label(s): documentation
  • resolution: Unresolved
  • votes: 1
  • watchers: 3
  • imported: 2025-12-08

Raw content of original issue

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. 

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.