>
> But I don't want to have to release a new version of my plugin just
> because I updated the tutorial or tips & tricks sections.
> The new feature bug is present in today's wiki usage as well.
>

So there could be a manual documentation publishing trigger. Then owners
will be able to get the new documentation version.

   - Ideally it should be done from Jenkins-on-Jenkins
      - We have some plugin ownership management there
      - Off-topic: /me advertises Ownership plugin
      <https://wiki.jenkins-ci.org/display/JENKINS/Ownership+Plugin>
      - It could be also done from IRC Bot
   <https://wiki.jenkins-ci.org/display/JENKINS/IRC+Bot>.
   - This bot could trigger Jenkins-on-Jenkins jobs
      - But in such case there will be some fun with permission management

BR, Oleg


2016-05-17 18:26 GMT+02:00 Robert Sandell <rsand...@cloudbees.com>:

> But I don't want to have to release a new version of my plugin just
> because I updated the tutorial or tips & tricks sections.
>
> The new feature bug is present in today's wiki usage as well.
>
> /B
>
> On Tue, May 17, 2016 at 5:57 PM, Cynthia Anyango <
> acynthiaanya...@gmail.com> wrote:
>
>> I agree with @Oleg ,
>>
>> One of the important aspect to this project is to ensure that plugin
>> documentation remains up-to date
>>
>> On Tuesday, May 17, 2016 at 5:22:22 PM UTC+3, Oleg Nenashev wrote:
>>>
>>> I don't think we should have to rely on having to make a release just to
>>>> get a fix into the documentation.
>>>> The doc generation should be just picked from the master branch during
>>>> the static generation of jenkins.io unless that would take too much
>>>> time. That way a pull request with a new feature in it could also contain a
>>>> documentation update in the same PR, I believe the Jenkins DLS plugin is
>>>> doing it that way.
>>>
>>>
>>> It breaks the case when people update the documentation for their
>>> Feature pull requests. And I think we really want to support this case. So
>>> we would need an immediate release of features (yay, CD!).
>>>
>>>
>>>> I would also like to propose that the README file in the repo is NOT
>>>> the main user documentation index file, it seems to be tradition that that
>>>> file is aimed at people currently browsing the repo and hence aimed at
>>>> developers more than users. It doesn't hurt to include it in the plugin
>>>> docs but it shouldn't be the front page.
>>>
>>>
>>> +/-. In such case Jenkins website will have to embedd build statuses and
>>> other such contents being put to the main pages. It's not bad, but it may
>>> require some additional implementation work to get smooth visualization.
>>>
>>>
>>>
>>>
>>>
>>> 2016-05-17 15:26 GMT+02:00 Robert Sandell <rsan...@cloudbees.com>:
>>>
>>>> I don't think we should have to rely on having to make a release just
>>>> to get a fix into the documentation.
>>>> The doc generation should be just picked from the master branch during
>>>> the static generation of jenkins.io unless that would take too much
>>>> time.
>>>> That way a pull request with a new feature in it could also contain a
>>>> documentation update in the same PR, I believe the Jenkins DLS plugin is
>>>> doing it that way.
>>>>
>>>> I would also like to propose that the README file in the repo is NOT
>>>> the main user documentation index file, it seems to be tradition that that
>>>> file is aimed at people currently browsing the repo and hence aimed at
>>>> developers more than users. It doesn't hurt to include it in the plugin
>>>> docs but it shouldn't be the front page.
>>>>
>>>> /B
>>>>
>>>> On Tue, May 17, 2016 at 1:16 PM, Cynthia Anyango <acynthi...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hey Manfred ,
>>>>>
>>>>> Thanks for your feedback ,
>>>>>
>>>>> We are going to prototype both asciidoc and markdown  the results of
>>>>> the will be hosted on jenkins.io which supports both .
>>>>>
>>>>> I will prepare a plugin subsection in the Documentation section 
>>>>> https://jenkins.io/doc/
>>>>> this is where all the plugin docs will go to .
>>>>> <https://jenkins.io/doc/>
>>>>>
>>>>> HERE
>>>>> <https://storage.googleapis.com/summerofcode-prod.appspot.com/gsoc/core_project/doc/1458818983_GOOGLESUMMEROFCODEPROPOSAL.pdf?Expires=1463570084&GoogleAccessId=summerofcode-prod%40appspot.gserviceaccount.com&Signature=j6k7KlCbg87%2FatflO1JjqKj%2BfMgd5Q%2BkB%2Fmz5ZQzkGhaukpuczoyZLjq8nVkPpnTEbkSgpY%2BiuQg9xTjx1T0%2FBVUieIt2Llwy6DYCy%2FiYN%2Bz2gSMZ3COS1RxiV6eYuDAm8%2BGtcD8o%2BYCKQx9KL%2FcgFPPw%2FDENrmWKujhZnnEc%2FlTzH3Xex8CXlTnziwgvWzkAbsMrSF88tGBtdJPIFcg3ULa1H49rz1%2BfLUX7XDDZFVvlleHmOzeN3nFEfZgnCjVVl%2BdZLE%2BwjSCaVDJAmZGfwmq%2BSiq27rLZa%2BCqnGdsP9vXm5Wr0p0gDx5YeNNf8OT3ZszNelXjAn5Dx0KFEP%2Fww%3D%3D>is
>>>>> the link to my proposal , you can check it out for a deeper insight to how
>>>>> I have planned to work on this .
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> On Monday, May 16, 2016 at 7:12:55 PM UTC+3, Manfred Moser wrote:
>>>>>>
>>>>>> In terms of asciidoc (and doc in general) usage for plugins I can see
>>>>>> a number of ways for this to work.
>>>>>>
>>>>>> 1. Just write the docs and rely on the rendering in github. Similar
>>>>>> to a readme being rendered just fine github renders any asciidoc or
>>>>>> markdown files. E.g. see
>>>>>> https://github.com/simpligility/android-maven-plugin/blob/master/src/site/asciidoc/changelog.adoc
>>>>>>
>>>>>> 2. You could generate a static site and host it on github or
>>>>>> whereever .. and use jekyll or anything to do that really.
>>>>>>
>>>>>> 3. We could standardize to use the Maven Site Plugin to create the
>>>>>> site and write any additional docs in asciidoc or markdown and then host
>>>>>> the result on github pages. This is imho the preferred options since we
>>>>>> already build everything with Maven and that keeps it simple and 
>>>>>> powerful.
>>>>>> You could create a specific navigation as part of it and so on.
>>>>>>
>>>>>> If you are looking for a fully working example setup of this approach
>>>>>> have a look at the Android Maven Plugin codebase and the site.
>>>>>>
>>>>>> https://github.com/simpligility/android-maven-plugin
>>>>>>
>>>>>> http://simpligility.github.io/android-maven-plugin/
>>>>>>
>>>>>> Hth
>>>>>>
>>>>>> Manfred
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Sun, May 15, 2016 at 7:38 AM, Oleg Nenashev <o.v.ne...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> In Jenkins.io we support both Markdown and Asciidoc.
>>>>>>> Asciidoc is recommended, because we use it's macros features for
>>>>>>> particular cases.
>>>>>>>
>>>>>>> If you need any reference plugin with documentation in Asciidoc,
>>>>>>> please let me know.
>>>>>>> I consider moving docs for several plugins to GitHub, so I can
>>>>>>> migrate one of them to Asciidoc.
>>>>>>> If there are specific format requirements, let's try to prototype
>>>>>>> them.
>>>>>>>
>>>>>>> BR, Oleg
>>>>>>>
>>>>>>> понедельник, 9 мая 2016 г., 23:14:10 UTC+2 пользователь Manfred
>>>>>>> Moser написал:
>>>>>>>>
>>>>>>>> I am all for asciidoc first, its the better format after all  ;-)
>>>>>>>>
>>>>>>>> On Mon, May 9, 2016 at 1:53 PM, Baptiste Mathus <m...@batmat.net>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>>> +1 Manfred.
>>>>>>>>> IMO, this could even be asciidoc first, and possibly some Markdown
>>>>>>>>> flavour (prolly GH's) secondly.
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> 2016-05-09 21:24 GMT+02:00 Manfred Moser <mos...@gmail.com>:
>>>>>>>>>
>>>>>>>>>> I sure hope this will work with asciidoc as well as markdown
>>>>>>>>>> files ;-)
>>>>>>>>>>
>>>>>>>>>> On Mon, May 9, 2016 at 10:54 AM, Cynthia Anyango <
>>>>>>>>>> acynthi...@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> Hey Martinda ,
>>>>>>>>>>>
>>>>>>>>>>> Thanks for your feedback .
>>>>>>>>>>>
>>>>>>>>>>> All that you have mentioned is within the scope of my project .
>>>>>>>>>>>
>>>>>>>>>>> As @Daniel mentioned I will be introducing various
>>>>>>>>>>> named-by-convention files that will define all that should be 
>>>>>>>>>>> contained in
>>>>>>>>>>> a plugin documentation . All the plugin documentation will go into
>>>>>>>>>>> jenkins.io .
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Saturday, May 7, 2016 at 2:00:17 AM UTC+3, martinda wrote:
>>>>>>>>>>>>
>>>>>>>>>>>> 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://www.google.com/url?q=https%3A%2F%2Fwiki.jenkins-ci.org%2Fdisplay%2FJENKINS%2FPlugin%2Btutorial&sa=D&sntz=1&usg=AFQjCNFulyD-ypRNLRuYxru4CEYRiKSVmQ>,
>>>>>>>>>>>> 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://www.google.com/url?q=https%3A%2F%2Fissues.jenkins-ci.org%2Fbrowse%2FJENKINS-33980&sa=D&sntz=1&usg=AFQjCNHgReicIk7qQrV90TH9GHC01rutCw>.
>>>>>>>>>>>> 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-de...@googlegroups.com.
>>>>>>>>>>> To view this discussion on the web visit
>>>>>>>>>>> https://groups.google.com/d/msgid/jenkinsci-dev/672a71a9-b120-46d1-9259-b2f4922c46a2%40googlegroups.com
>>>>>>>>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/672a71a9-b120-46d1-9259-b2f4922c46a2%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>>>>>>>>> .
>>>>>>>>>>> For more options, visit 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 jenkinsci-de...@googlegroups.com.
>>>>>>>>>> To view this discussion on the web visit
>>>>>>>>>> https://groups.google.com/d/msgid/jenkinsci-dev/CABffhO6nSVgzHARxeboGc3Gg7JQw2hSXjR3z36asWrA3NtdEvg%40mail.gmail.com
>>>>>>>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/CABffhO6nSVgzHARxeboGc3Gg7JQw2hSXjR3z36asWrA3NtdEvg%40mail.gmail.com?utm_medium=email&utm_source=footer>
>>>>>>>>>> .
>>>>>>>>>>
>>>>>>>>>> For more options, visit 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 jenkinsci-de...@googlegroups.com.
>>>>>>>>> To view this discussion on the web visit
>>>>>>>>> https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS7fXFyKSWEBnm%2BRJfEmdL4nBFxFepkhF1GPyu%3D%2BDbCEzQ%40mail.gmail.com
>>>>>>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS7fXFyKSWEBnm%2BRJfEmdL4nBFxFepkhF1GPyu%3D%2BDbCEzQ%40mail.gmail.com?utm_medium=email&utm_source=footer>
>>>>>>>>> .
>>>>>>>>>
>>>>>>>>> For more options, visit 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 jenkinsci-de...@googlegroups.com.
>>>>>>> To view this discussion on the web visit
>>>>>>> https://groups.google.com/d/msgid/jenkinsci-dev/a01e9475-b433-42e1-864d-a042598a76fb%40googlegroups.com
>>>>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/a01e9475-b433-42e1-864d-a042598a76fb%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>>>>> .
>>>>>>>
>>>>>>> For more options, visit 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 jenkinsci-de...@googlegroups.com.
>>>>> To view this discussion on the web visit
>>>>> https://groups.google.com/d/msgid/jenkinsci-dev/284d57ee-617d-4528-ac37-ee4b458a9c36%40googlegroups.com
>>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/284d57ee-617d-4528-ac37-ee4b458a9c36%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>>> .
>>>>>
>>>>> For more options, visit https://groups.google.com/d/optout.
>>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> Robert Sandell
>>>> *Software Engineer*
>>>> *CloudBees Inc.*
>>>>
>>>> --
>>>> You received this message because you are subscribed to a topic in the
>>>> Google Groups "Jenkins Developers" group.
>>>> To unsubscribe from this topic, visit
>>>> https://groups.google.com/d/topic/jenkinsci-dev/kNZMOsF_ueA/unsubscribe
>>>> .
>>>> To unsubscribe from this group and all its topics, send an email to
>>>> jenkinsci-de...@googlegroups.com.
>>>> To view this discussion on the web visit
>>>> https://groups.google.com/d/msgid/jenkinsci-dev/CALzHZS1iXRr4_A5xKz%2BgE28vR6obQt0gq1M72OUK2K-Fq7j%2BQw%40mail.gmail.com
>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/CALzHZS1iXRr4_A5xKz%2BgE28vR6obQt0gq1M72OUK2K-Fq7j%2BQw%40mail.gmail.com?utm_medium=email&utm_source=footer>
>>>> .
>>>>
>>>> For more options, visit 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 jenkinsci-dev+unsubscr...@googlegroups.com.
>> To view this discussion on the web visit
>> https://groups.google.com/d/msgid/jenkinsci-dev/267a3f92-792b-4750-b154-fc3bacdd8512%40googlegroups.com
>> <https://groups.google.com/d/msgid/jenkinsci-dev/267a3f92-792b-4750-b154-fc3bacdd8512%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>>
>> For more options, visit https://groups.google.com/d/optout.
>>
>
>
>
> --
> Robert Sandell
> *Software Engineer*
> *CloudBees Inc.*
>
> --
> You received this message because you are subscribed to a topic in the
> Google Groups "Jenkins Developers" group.
> To unsubscribe from this topic, visit
> https://groups.google.com/d/topic/jenkinsci-dev/kNZMOsF_ueA/unsubscribe.
> To unsubscribe from this group and all its topics, 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/CALzHZS3GkL6nKk4j9SOhArdpB2W%3DkBpR2JTO0wjstSyhqQ7mOA%40mail.gmail.com
> <https://groups.google.com/d/msgid/jenkinsci-dev/CALzHZS3GkL6nKk4j9SOhArdpB2W%3DkBpR2JTO0wjstSyhqQ7mOA%40mail.gmail.com?utm_medium=email&utm_source=footer>
> .
>
> For more options, visit 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 jenkinsci-dev+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/jenkinsci-dev/CAPfivLDidMVR%2Bme5ghnZYzos6yY%2B8roTih3job_%3DEZ_s07E4uQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to