This is finally done: https://github.com/stephenmcd/mezzanine/commit/73f6d0e39d6c634ce7fab7a38d806592b987ef2d https://github.com/stephenmcd/mezzanine.jupo.org/commit/0b1e4590070752ba4574bcb0ab97159b72fcd592
Welcome to the more compact README: https://github.com/stephenmcd/mezzanine On Sun, May 24, 2015 at 3:40 AM, Stephen McDonald <[email protected]> wrote: > > > On Fri, May 22, 2015 at 11:14 PM, Mathias Ettinger < > [email protected]> wrote: > >> Why not swap it entirely with doc/overview.rst? >> > > I think this will be the general approach - move stuff out of the README, > and directly into the docs, and adding links in the README back to the docs > for these moved pieces. > > Here's my initial thoughts on each section, feedback welcome. > > Overview -> leave as is > Features -> leave as is > Dependencies -> move to end of "installation" section > Installation -> move to "overview" in docs, and link from README > Themes -> move to "overview" in docs, no link needed from README > Browser support -> move to "overview" in docs, no link needed from README > Contributing -> leave as is > Multi-lingual sites -> already has a docs section, merge into that or > remove > Third party plugins -> move to "overview" in docs, and link from README > Donating -> leave as is > Support -> leave as is, but move up to a more prominent spot (the number > of invalid issues opened when posting to the mailing list would suffice is > overwhelming) > Sites using Mezzanine -> move to "overview" in docs, and link from README > (refactoring demo site required) > Quotes -> leave as is > > > > > > > >> >> This way, what relies on README.rst today can rely on overview.rst >> tomorow without breaking anything. Or is the point to shorten both? >> >> >> Le vendredi 22 mai 2015 22:32:01 UTC+2, Stephen McDonald a écrit : >>> >>> It's a good idea. >>> >>> Please keep in mind there's some functionality of the project site >>> dependent on the format of the readme, particularly those lists we'll >>> probably remove: >>> >>> >>> https://github.com/stephenmcd/mezzanine.jupo.org/blob/master/demo/__init__.py >>> >>> On Fri, May 22, 2015 at 1:26 PM, Geo <[email protected]> wrote: >>> >>>> +1 >>>> >>>> Mezzanine's Readme is, at the time of writing, 795 lines long - pretty >>>> much an essay! The GH Readme for Django itself is short and sweet at just >>>> 44 lines. That's a massive 94% reduction in lines. >>>> >>>> If you are looking for a python CMS to use, you want to read about 3 >>>> key features of Mezzanine that make it stand out from all the others, >>>> that's all. Then one could link to the Mezzanine website and documentation >>>> website for further details and even for installation steps etc. >>>> >>>> Just my thoughts. Interesting to hear what the core devs think... >>>> >>>> >>>> On Friday, 22 May 2015 10:43:37 UTC+1, Graham Oliver wrote: >>>>> >>>>> Hi all >>>>> I would like to have a go at revamping the readme on GitHub >>>>> https://github.com/stephenmcd/mezzanine/blob/master/README.rst >>>>> >>>>> Initial thoughts >>>>> - Make it way shorter >>>>> - Put the 'third party plugins' and 'sites using Mezzanine' lists in >>>>> separate documents >>>>> - Add details of 'Core Development Team' >>>>> >>>>> Possibly also something for people (relatively) new to the Open Source >>>>> thing..... >>>>> >>>>> All feedback appreciated... >>>>> >>>>> This one I quite like (apart from the crypto stuff) >>>>> http://svn.apache.org/repos/asf/httpd/httpd/trunk/README >>>>> >>>>> Take Care >>>>> g >>>>> >>>>> -- >>>> You received this message because you are subscribed to the Google >>>> Groups "Mezzanine Users" group. >>>> To unsubscribe from this group and stop receiving emails from it, send >>>> an email to [email protected]. >>>> For more options, visit https://groups.google.com/d/optout. >>>> >>> >>> >>> >>> -- >>> Stephen McDonald >>> http://jupo.org >>> >> -- >> You received this message because you are subscribed to the Google Groups >> "Mezzanine Users" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> For more options, visit https://groups.google.com/d/optout. >> > > > > -- > Stephen McDonald > http://jupo.org > -- Stephen McDonald http://jupo.org -- You received this message because you are subscribed to the Google Groups "Mezzanine Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
