I can set one up On Wed, Jun 1, 2016 at 8:20 PM, Oleg Nenashev <o.v.nenas...@gmail.com> wrote:
> Yes, raw HTMLs :( > > Do you have regular team meetings in this project. > I have a bunch of questions regarding the plugin documentation format (the > document is not detailed enough), and maybe a short chat is better than a > long review-change-review cycle. > > BR, Oleg > > 2016-05-31 17:28 GMT+02:00 Baptiste Mathus <m...@batmat.net>: > >> Hi, >> >> Sorry should already have reviewed the gdoc. Will do this evening. >> >> In general, please don't hesitate to ping me e.g. on irc as a reminder to >> some thread or things you're expecting an answer from Tyler or me. >> >> See below for the current email. >> >> Le 31 mai 2016 12:30 PM, "Cynthia Anyango" <acynthiaanya...@gmail.com> a >> écrit : >> > >> > @Oleg , >> > >> > - How would you suggest I handle the exploit injection issues plus what >> is RAM HTML ? :) >> >> Typo IMO. Raw HTML I guess. >> >> > I feel i would need some help with that @Tyler and @Baptise >> >> At first sight, I don't see an obvious solution. Will ping Dan Allen >> about this (that is, IIUC, how to somehow secure included asciidoc you >> don't trust.) >> >> > >> > - How to write multi-page documents >> > I have found pandoc.org which renders multiple files into a single >> file . >> > >> > for example >> > 1.getting _started.adoc >> > 2.installation.adoc >> > 3.configuration.adoc >> > >> > using padoc >> > >> > pandoc -o tutorial.adoc 1.getting _started.adoc 2.installation.adoc >> 3.configuration.adoc >> >> See >> https://raw.githubusercontent.com/batmat/presentations/master/git-next-level/labs/all-labs.adoc >> for an example. >> >> That is IMO one example of why markdowns just can't keep up w/ asciidoc >> features. >> >> > >> > -How is it going to handle multi-module repositories >> > does multi-module repositories mean repositories that contain branches >> , please clarify >> >> That means there may be actually many plugins to extract doc from in the >> same Git repo. >> https://github.com/jenkinsci/blueocean-plugin is one recent example. >> >> Also, you want to be aware in this case that of those (maven) modules may >> not be plugins but just libs or so. >> >> HTH >> >> -- Baptiste >> >> > >> > >> > >> > >> > >> > >> > On Friday, May 27, 2016 at 9:35:10 AM UTC+3, Oleg Nenashev wrote: >> >> >> >> Hi Cynthia, >> >> >> >> Thanks for sharing the document! I've added several comments. It >> definitely requires much more details. My main questions would be: >> >> How to handle the embedded content? >> >> How to secure Jenkins website from exploit injection into ASCIIDOC? >> (e.g. via RAM HTML) >> >> How to write multi-page documents? >> >> E.g. tutorials, feature details, etc. >> >> How is it going to handle multi-module repositories? >> >> >> >> BR, Oleg >> >> >> >> >> >> 2016-05-27 6:31 GMT+03:00 Cynthia Anyango <acynthi...@gmail.com>: >> >>> >> >>> Hello everyone , >> >>> >> >>> I have put up together a document containing some of the things that >> will go into various doc files . Please feel free to comment and put up as >> many suggestions as you can . >> >>> >> >>> >> https://docs.google.com/document/d/1EHX0DJ8alsctFN6POLCehowusuikmnUMeL_5jPHVURA/edit?usp=sharing >> >>> >> >>> Thanks >> >>> >> >>> On Tuesday, May 24, 2016 at 11:34:07 PM UTC+3, Cynthia Anyango wrote: >> >>>> >> >>>> @Baptise I have gone through more than 20 plugin repos(am still >> going through more) trying to come up with a standard template , I will >> share the google soon >> >>>> >> >>>> On Tue, May 24, 2016 at 11:00 PM, Baptiste Mathus <m...@batmat.net> >> wrote: >> >>>>> >> >>>>> Hi Cynthia, >> >>>>> >> >>>>> Not sure Oleg was referring to a specific plugin, more he's willing >> to convert his plugin docs to asciidoc IIUC. >> >>>>> If you already know markdown, then you can consider Asciidoc being >> quite the same, but being more /standard/ and with more features. >> >>>>> If you want examples of actual asciidoc, just let us know, or come >> over me on IRC and I'll show you many examples. >> >>>>> >> >>>>> IMO, you could (should?) manually crawl dozens of plugins wiki >> pages [1] to try and get a feeling/idea of what is currently in there and >> analyze it: >> >>>>> what should/could stay there, what is the structure, what should >> better be located alongside the code and so on to propose a >> DOCUMENTATION.[adoc|md] standard template here for feedback. >> >>>>> >> >>>>> You probably also wanna crawl the github org and have random looks >> at plugins [2], if you quickly go through say 50 of them you should be able >> to get a grasp of the average doc, what you think might be missing and so >> on. >> >>>>> Possibly, you want to use the number of installs (visible on the >> wiki page) to select those 50 to only have a look on plugins installed, >> say, more than 1000 or 2000 times (they're possibly more likely to have set >> a documentation somehow?). >> >>>>> >> >>>>> If you have any question, feel free to ask here or on IRC for >> possibly more interactive feedback. >> >>>>> >> >>>>> Cheers >> >>>>> >> >>>>> [1] https://wiki.jenkins-ci.org/display/JENKINS/Plugins >> >>>>> [2] https://github.com/jenkinsci/ >> >>>>> >> >>>>> >> >>>>> 2016-05-24 19:40 GMT+02:00 Cynthia Anyango <acynthi...@gmail.com>: >> >>>>>> >> >>>>>> 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, >> 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. 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 >> . >> >>>>>>>>>>> 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 >> . >> >>>>>>>>>> >> >>>>>>>>>> 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 >> . >> >>>>>>>>> >> >>>>>>>>> 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/05dc3f76-e369-432d-836c-53a081820dce%40googlegroups.com >> . >> >>>>>> >> >>>>>> For more options, visit https://groups.google.com/d/optout. >> >>>>> >> >>>>> >> >>>>> -- >> >>>>> 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/CANWgJS5Yzi-WjVrF4_QvCa80Ng95Q3zbjm5xPc_Ew6uo%2By8xsA%40mail.gmail.com >> . >> >>>>> >> >>>>> For more options, visit https://groups.google.com/d/optout. >> >>>> >> >>>> >> >>>> >> >>>> >> >>>> -- >> >>>> KInd Regards, >> >>>> Cynthia Anyango >> >>>> >> >>>> >> >>> -- >> >>> 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/401c78ed-7f9e-4d26-aec8-afd8c200ff0d%40googlegroups.com >> . >> >>> >> >>> 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/43781973-60da-4fd9-b1a3-36dbf0de82dc%40googlegroups.com >> . >> > >> > For more options, visit https://groups.google.com/d/optout. >> >> -- >> 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/CANWgJS4Srg6oT6pqos%3DmAOnZB-qQW8uUB_o7kqxHg3Hdj4-7iQ%40mail.gmail.com >> <https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS4Srg6oT6pqos%3DmAOnZB-qQW8uUB_o7kqxHg3Hdj4-7iQ%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 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/CAPfivLAff2d-EymYSQzEK4xfh40Xwmfq5VmrTwWq3LXq7QQFKw%40mail.gmail.com > <https://groups.google.com/d/msgid/jenkinsci-dev/CAPfivLAff2d-EymYSQzEK4xfh40Xwmfq5VmrTwWq3LXq7QQFKw%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > > For more options, visit https://groups.google.com/d/optout. > -- KInd Regards, Cynthia Anyango -- 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/CAFcxnmr1DFRE12KxtT-BgHNmjjHyNBWokmN_qEXfxGxcog_Ojg%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.