Hey Oleg , Could you please refer me to a plugin that has its documentation in Asciidoc
On Sunday, May 15, 2016 at 5:38:35 PM UTC+3, Oleg Nenashev 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-dev+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/05dc3f76-e369-432d-836c-53a081820dce%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
