Hello Cynthia, As a plugin user, and as a very occasional contributor, what would help me document plugins better and faster would be to know where the documentation I put in the code ends up on the web, and where to put the documentation in the code (the help*.html files).
I don't know if this is part of the work you intend to do, but perhaps a plugin documentation guide section, in the plugin tutorial <https://wiki.jenkins-ci.org/display/JENKINS/Plugin+tutorial>, would be useful. If I had a list of everything that can be documented (some sort of check-list), and where it is published (where users will see it), it would help me document the plugins I work on from time to time. I am sure I have seen plugin documentation documented somewhere but I can't find it right now. For those who write plugins more regularly, they just know what to do, but for occasional contributors like me, I have to look it up each time (by comparing with other plugins) and it is always time consuming - this should be easy to find. I would also draw the attention to JENKINS-33980 <https://issues.jenkins-ci.org/browse/JENKINS-33980>. To me this issue is an example that people do want to read detailed plugin documentation, before they installing plugins. Again, I don't know if this is part of your GSoC project. Thanks in advance, Martin -- You received this message because you are subscribed to the Google Groups "Jenkins Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-dev+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/df5c74a1-b302-4158-aacb-f44939143cf4%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
