> On 07.05.2016, at 01:00, martinda <martin.danjo...@gmail.com> wrote:
> 
> 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).

This project is about basically replacing today's plugin wiki pages by 
named-by-convention files in the GitHub repo (e.g. README.*), and integrating 
it into the jenkins.io site.

See the proposal titled 'Automatic plugin documentation publishing on 
https://jenkins-ci.org/' here for the basic idea:
https://wiki.jenkins-ci.org/display/JENKINS/Google+Summer+Of+Code+2016

So this does not deal with documentation inside the plugins as all. However, it 
should improve the situation for people who want to learn about plugins before 
installing them.

-- 
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/7B0C74DF-2772-4722-BC80-3E20FEE304C2%40beckweb.net.
For more options, visit https://groups.google.com/d/optout.

Reply via email to