Hi Daniel,

I found that learning Jelly and how Jelly, descriptors, and instances all work 
together was a bit frustrating. If there were more examples that described why 
or how the code does what it does, that’d probably be a good thing. GitHub 
already gives us the what, but through that vehicle we are given many options 
and not really any one best-practice.

So if there were anything I’d like to see for future plugin developers, it’d be 
a larger set of “here’s an example of making a xyz, and why it is the way it 
is”.

Good luck!
-Brian

From: [email protected] [mailto:[email protected]] On 
Behalf Of Daniel Beck
Sent: Thursday, July 16, 2015 08:32
To: [email protected]
Subject: Improvements to the developer docs

Hi everyone,

I'm looking into improving the developer documentation for Jenkins. I'm not 
going to be able to do an entire rewrite of the docs, but if you have specific 
issues with the docs you think should be improved, please let me know. What 
parts do you think are documented insufficiently?

This should preferably be issues with getting the 'big picture', 
interaction/relation of different parts, discovering available APIs, etc. -- 
things not as easily done in Javadoc, but if you see major problems with these, 
add them to the list.

I'm also specifically inviting less experienced core/plugin developers to 
provide suggestions. What are/were you struggling with the most? What 
documentation would you have liked to find but couldn't?

Daniel

--
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 
[email protected]<mailto:[email protected]>.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/jenkinsci-dev/52690EB6-1E39-4248-A46A-2124822FD162%40beckweb.net<https://groups.google.com/d/msgid/jenkinsci-dev/52690EB6-1E39-4248-A46A-2124822FD162%40beckweb.net>.
For more options, visit 
https://groups.google.com/d/optout<https://groups.google.com/d/optout>.

-- 
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 [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/jenkinsci-dev/3F9EC1BBB8AE8245963929DFA7A2F31C8C257FE3%40WNDMAIL02.vistaprint.net.
For more options, visit https://groups.google.com/d/optout.

Reply via email to