[Python-ideas] Encouraging more use of the Python wiki

[Wes Turner]

Fair disclosure: I'm not a big fan of Moin syntax (can Pandoc convert
this?). I don't like having to login to share with the Python community. It
would be great to gain maximum synergy from the community on this.

Some interesting perspectives on wikis, and where wikis are going:

[1] https://github.com/blog/1939-how-github-uses-github-to-document-github
[2] https://github.com/westurner/wiki/blob/master/Makefile

[2] is a Sphinx Makefile for a GitHub ReStructuredText wiki. It seems to
work okay for my purposes. What could prevent this from scaling to handle
the Python wiki?

>From https://github.com/westurner/wiki/issues/5 , in Markdown (which works
on both BitBucket and GitHub):

# Advantages
>


* Beautiful Sphinx output:
> https://github.com/westurner/wiki/blob/master/conf.py
>   * Search
>   * Context-focused pages
>   * Navbar
>   * **Responsive** CSS Freedom; for my cell phone
> * Pull Requests
> # Challenges / Disadvantages
> * New wiki pages created through the GitHub wiki interface add the `.rest`
> suffix, rather than `.rst`
>   * Sort of an advantage (`.rest` files are docutils-only)
>   * This precludes inclusion of the wiki pages into a standard Sphinx
> docset as a submodule or subtree.
> * Sphinx ReStructuredText is a superset of GitHub ReStructuredText
> (docutils), so Sphinx markup is, in the best case not supported, and in the
> worst case breaks the wiki render
>   * Notably: `:ref:`, `.. index:`, and `.. toctree::` are only supported
> by Sphinx
>   * To test this: `make rst2html_all`
> * Double Tables of Contents (#4)
> * Double pulls and pushes (`make pull push`):
> https://github.com/westurner/wiki/blob/master/Makefile
> * Sphinx requires a manual build step in order to publish in-progress
> changes





On Tue, Jan 6, 2015 at 2:31 AM, M.-A. Lemburg <mal at egenix.com> wrote:

> On 06.01.2015 07:26, Ben Finney wrote:
> > "M.-A. Lemburg" <mal at egenix.com> writes:
> >
> >> [editing the Python wiki] requiring asking for editing rights
> >> on the pydotorg-www mailing list. Which is a little annoying and
> >> some work for the admins, but has resulted in the amount of
> >> spam to go down to zero. We usually grant the editing requests
> >> within a day.
> >
> > I quite understand the motivation for this.
> >
> > It does need to be recognised that this will dramatically reduce the
> > number of pople who will pass that hurdle to edit the wiki, and thus the
> > wiki loses a lot of edits (both helpful and unhelpful) it might
> > otherwise have.
>
> We might lose some occasional quick typo fixes, but it seems that
> those genuinely interested in helping with the wiki don't have
> a problem asking on the list.
>
> To reduce the problem I had created a list of user names
> who had made good edits in the months before the change.
>
> The only nit I still have with the setup is that it's not
> necessarily apparent for new users how to get editing rights.
> There's a section on the front page, but you don't see this
> when looking at a random page.
>
> > Thanks to those doing the work to maintain Python community
> > infrastructure.
>
> --
> Marc-Andre Lemburg
> eGenix.com
>
> Professional Python Services directly from the Source  (#1, Jan 06 2015)
> >>> Python Projects, Coaching and Consulting ...  http://www.egenix.com/
> >>> mxODBC Plone/Zope Database Adapter ...       http://zope.egenix.com/
> >>> mxODBC, mxDateTime, mxTextTools ...        http://python.egenix.com/
> ________________________________________________________________________
>
> ::::: Try our mxODBC.Connect Python Database Interface for free ! ::::::
>
>    eGenix.com Software, Skills and Services GmbH  Pastor-Loeh-Str.48
>     D-40764 Langenfeld, Germany. CEO Dipl.-Math. Marc-Andre Lemburg
>            Registered at Amtsgericht Duesseldorf: HRB 46611
>                http://www.egenix.com/company/contact/
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> https://mail.python.org/mailman/listinfo/python-ideas
> Code of Conduct: http://python.org/psf/codeofconduct/
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20150106/486c058e/attachment-0001.html>