Thinking about it again, I somehow agree for the reasons above, and also probably because of legacy reasons:
If we are to use the hundreds of already existing README, there's a good chance to see a lot of inconsistencies flowing through the documentation pipe... 2016-06-17 9:52 GMT+00:00 Adrien Lecharpentier < [email protected]>: > I agree with Robert. Moreover, Readme files across the repositories are > not containing the same details, are not written the same way and some > repositories don't have any. I'm all for KISS principle but I don't think > README.md is the place to old this but it should be on the repository so > the maintainers have full control on it and users can offer fix / > enhancement on the doc through PR. > > Le ven. 17 juin 2016 à 11:24, Robert Sandell <[email protected]> a > écrit : > >> No please, how many times do I have to plead my case here? >> The readme in the root of the repo is IMO aimed at describing the >> repository you are currently looking at; e.g. what it is, *how to build >> it*, who maintains it, links to additional resources (like user docs) >> etc. it is not the user documentation, it is developer documentation. >> >> You should sync with the GSoC project that is currently going on user >> docs: >> https://groups.google.com/forum/#!searchin/jenkinsci-dev/GSoC/jenkinsci-dev/kNZMOsF_ueA/15BWeTdXDQAJ >> >> /B >> >> On Tue, Jun 14, 2016 at 10:43 PM, Gus Reiber <[email protected]> >> wrote: >> >>> +1 to GitHub readme as well. Why put the same doc in 2 places. >>> >>> >>> >>> On Tuesday, June 14, 2016 at 1:30:24 PM UTC-7, slide wrote: >>>> >>>> +1 for the effort, ideally I'd like to see something that can pull >>>> information from the github README.md files and have people push updates to >>>> the descriptions that would be shown to their own plugin repositories. >>>> Perhaps some of the other information could be pulled from a metadata file >>>> that was also in the plugin repository. >>>> >>>> On Tue, Jun 14, 2016 at 1:02 PM Gus Reiber <[email protected]> >>>> wrote: >>>> >>>>> Hey all, >>>>> So I have on and off pushed the idea that the Jenkins community >>>>> could benefit greatly from an overhaul of the wiki based plugins site. As >>>>> an ultimate goal, I don't see any reason we couldn't build something that >>>>> approach a modern app store, like https://play.google.com/store, but >>>>> for the short run, it seems like we should be able to improove upon the >>>>> browsing experience of the existing list page and detail view. >>>>> >>>>> Existing: >>>>> >>>>> - list: https://wiki.jenkins-ci.org/display/JENKINS/Plugins >>>>> - detail: >>>>> https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Plugin >>>>> >>>>> I think as a minimum, we ought to be able to provide a reasonable >>>>> search interface and means of filtering plugins by maintainer, Jenkins >>>>> core >>>>> requirement, plugins labels, and installation count. Plugins should also >>>>> be >>>>> assigned to categories that map to Jenkins user expectations a bit better >>>>> than the current list of ~30ish maintainer assigned labels do today. >>>>> Ideally the user ought to be able to manage the list of all plugins by >>>>> specific features of the plugin and by some suggestion of quality or >>>>> currentness of the plugin. >>>>> >>>>> At various points, my interest in bringing this value to the community >>>>> has been great enough to assemble a couple of different prototypes and >>>>> wireframes, attempting to generate interest. I have also had a chance to >>>>> play with some prototypes from others all with what seems to me to be >>>>> reasonable implementation paths. Attached are a few more recent sketches >>>>> showing the gist of how we might handle searching and filtering as well as >>>>> the plugin details. >>>>> >>>>> Anyway, at the moment, the plugin site is maintained by our >>>>> representatives here in the community. So it is really the will of the >>>>> community that should be reflected in any efforts that are actually >>>>> deployed and later maintained by our community. Thus again, I am looking >>>>> for grass roots support for the effort, support that potentially includes >>>>> some avenue for long term hosting and support. >>>>> >>>>> So my questions are these: Is enhancing the plugin site really worth >>>>> that degree of effort to the community? If you think it is, would you be >>>>> willing to join the effort, both for the immediate development needs, but >>>>> also for longer term support? Do you have any experience with other >>>>> communities who manage to accomplish this sort of ends? >>>>> >>>>> ...and finally, could you help articulate a set of minimum >>>>> requirements that would make overhauling the plugin site worth while? >>>>> >>>>> Thanks in advance, >>>>> Gus >>>>> >>>>> -- >>>>> 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/33ab5051-e2b8-4684-8d9e-0d5aa6ab1284%40googlegroups.com >>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/33ab5051-e2b8-4684-8d9e-0d5aa6ab1284%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 [email protected]. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/jenkinsci-dev/d8062fe5-ddd3-49b7-b530-6721ffa9243d%40googlegroups.com >>> <https://groups.google.com/d/msgid/jenkinsci-dev/d8062fe5-ddd3-49b7-b530-6721ffa9243d%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 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/CALzHZS0WLq1yfKv4FJB4JTyTwYZe8bSPZvttHFfTcxbL2HVf1w%40mail.gmail.com >> <https://groups.google.com/d/msgid/jenkinsci-dev/CALzHZS0WLq1yfKv4FJB4JTyTwYZe8bSPZvttHFfTcxbL2HVf1w%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 [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/jenkinsci-dev/CAKwJSvy8rmw%2B%3D%3D0rOnmE4xAB8RJk-a427eW7j-nq%2BoUutu8Xnw%40mail.gmail.com > <https://groups.google.com/d/msgid/jenkinsci-dev/CAKwJSvy8rmw%2B%3D%3D0rOnmE4xAB8RJk-a427eW7j-nq%2BoUutu8Xnw%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 [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS6V8Wp8jn0BRWX1mfR%3D4CbekFZxoCYVbOf8u-92g_jm1g%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
