@Manfred, great hint about the maven site plugin. I remember using it for another format in the past, but just got to know that it actually supports Markdown since release 3.3. First I though about using jekyll, just like GitHub. But the maven site plugin would be better integrated. Thanks!
@Jesse, I'll probably end up with a stub confluence page internally also, though I can foresee some resistance :-) btw, is there any documentation about the Jenkins release process behind the scenes? For example, when someone wants to contribute with a new plugin, a whole environment is created around it (github repo, confluence page, a jenkins job to build the plugin, Jira etc). Is everything triggered by scripts? On Wednesday, March 9, 2016 at 5:40:02 PM UTC+1, Jesse Glick wrote: > > On Wed, Mar 9, 2016 at 11:13 AM, Rafael Rezende <[email protected] > <javascript:>> wrote: > > I was thinking about introducing the documentation in > > markdown format directly from the Jenkins plugin itself. That is, an > extra > > doc folder in the plugin's source that will be part of the snapshot > (tag, > > revision, release.. you name it). This way, there is a direct > correlation > > between the source and the doc, devs feel motivated (or compelled) to > update > > docs accordingly > > That is what I did in `workflow-plugin`, for reasons similar to those > you outline. > > There was some discussion about this topic in the context of the > Jenkins 2.0 website. I was not really involved but IIRC there was > general agreement that it would be nice to have plugin documentation > maintained (a) in markup in SCM, rather than in a wiki, (b) in > per-plugin repositories rather than globally (meaning that the site > would somehow suck in conventionally-named files from other > repositories). Someone involved in this work should fill in details. > > > you established that plugins > > without documentation in your confluence are to be considered > deprecated. > > I think the rule was that they had to *have* a wiki page, and use that > as the `<url>` in `pom.xml`. But the wiki could merely be a stub > linking to the real docs. > -- 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/361eccbd-2cf3-4210-b85c-d0a0399df896%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
