[IPython-User] Vote: should we move our wiki over to github?

Tom Brander tombrander@tombrander....
Sat Sep 8 18:01:36 CDT 2012


Would also consider moving the Sphinx site to read the docs as well (keep
the repo in github), same argument.

On Sat, Sep 8, 2012 at 5:45 PM, Aaron Meurer <asmeurer@gmail.com> wrote:

> I gave my view on the matter a while back at
> http://mail.scipy.org/pipermail/ipython-user/2012-June/010375.html and
> http://mail.scipy.org/pipermail/ipython-user/2012-June/010392.html.  I
> don't really feel involved enough in the community to vote (I have
> never used the IPython wiki), so you should just take it as advice
> from my personal experience with SymPy's wikis and no more.
>
> Summary:
>
> - The GitHub wiki is pretty good, though it has its deficiencies.
> - The biggest strength of the GitHub wiki is that everything is just a
> git repository.  This pretty much makes up for the deficiencies (in my
> opinion).
> - Regardless of what you do, having more than one wiki is a serious
> PITA (we at one point had three).
>
> I also talked a little bit about how to transition.  It's a lot easier
> to deal with the GitHub wiki if you use the fact that it's a git
> repository, and just do all your editing locally and pushing up the
> results.  Unfortunately, the wiki permissions are exactly the same as
> the repository permissions, and there's no way to change that, so if
> you don't have push access and want to use git to contribute, you'll
> have to fork the wiki and get someone with push access to merge your
> changes.
>
> And by the way, I just noticed another deficiency in Gollum that I
> didn't notice before: it doesn't seem to have a search functionality.
> So if you want to search the wiki, you'll either have to use Google,
> or clone the wiki repo and use grep.  But it's open source, so maybe
> someone can contribute...
>
> Aaron Meurer
>
> On Sat, Sep 8, 2012 at 4:11 PM, Brian Granger <ellisonbg@gmail.com> wrote:
> > Fernando has given some motivation for this proposed change, but I
> > think a few more details are important:
> >
> > * Currently, we have "developer docs" in two locations: the IPython
> > Sphinx docs and the mediawiki wiki site.  At best, these two locations
> > repeat information, at worse they are inconsistent.  In practice
> > having two locations for these things has meant that this information
> > gets out of date.
> > * We would like to start to develop a "Development Roadmap" for
> > IPython that outlines the big picture of where we are headed.
> > * We have started to use IPEPs (IPython Enhancement Proposals) to
> > guide the development of particular "big" features.
> >
> > All of these things are developer related documentation that we want
> > to make it easy for all developers to read and edit in a single
> > location.  Because most of our development happens on github, I think
> > it makes sense for that location to be the github wiki.  That was my
> > original argument for hosting this context on the github wiki.
> >
> > >From there, Fernando wisely brought up the impracticality of
> > maintaining two wikis (github and mediawiki) and proposed to move
> > *all* our existing mediawiki content to github as well.
> >
> > On Sat, Sep 8, 2012 at 2:31 PM, Fernando Perez <fperez.net@gmail.com>
> wrote:
> >> Hi all,
> >>
> >> We've been having on and off discussions about this in the middle of
> >> other threads for a while, and we think it's time to make a decision.
> >> Our current wiki setup (http://wiki.ipython.org) is a manual mediawiki
> >> installation that we manage, with configuration mostly having been
> >> done by Thomas and myself.  We chose that instead of activating the
> >> github wiki mainly because we wanted a more 'user friendly' space:
> >> github wikis are still located deep inside of the github site with a
> >> lot of screen space and controls that are mostly relevant to those
> >> following development more closely.
> >>
> >> But as more and more of our workflow happens on github, we are
> >> reconsidering this decision.  For example, with the new process for
> >> discussing more complex IPython enahncements via IPEPs
> >> (
> https://github.com/ipython/ipython/wiki/IPython-Enhancement-Proposals-%28IPEPs%29
> ),
> >> it makes a lot of sense to work on github itself, as it lets us
> >> conveniently link all materials on one site, we reuse skills
> >> (markdown) and workflow patterns, etc.  And keeping *two* wikis, one
> >> on a manual Mediawiki install and one on github, is really more
> >> management than it's worth.  Hence the question:
> >>
> >> Should we consolidate all wiki materials on a single one on github?
> >
> > [ X] Yes
> > [ ] No
> >
> >> In terms of actually agreeing to move, we need to have a migration
> >> plan in place first, though.  Maintaining two wikis is untenable, so
> >> before we start building the new github one we need to have a solution
> >> for migrating content, which fortunately isn't too much.  Would anyone
> >> here volunteer to help out with this process?  Most likely it can be
> >> automated to a significant degree; we can give a volunteer acess to
> >> the mediawiki installation; since the github wiki is itself just a
> >> wiki repo, then running pandoc over all the pages on the existing wiki
> >> and pushing to that local repo should be pretty easy.
> >
> > I volunteer to move over all of our developer related docs from the
> > various locations.
> >
> > Cheers,
> >
> > Brian
> >
> >> Cheers,
> >>
> >> f
> >> _______________________________________________
> >> IPython-User mailing list
> >> IPython-User@scipy.org
> >> http://mail.scipy.org/mailman/listinfo/ipython-user
> >
> >
> >
> > --
> > Brian E. Granger
> > Cal Poly State University, San Luis Obispo
> > bgranger@calpoly.edu and ellisonbg@gmail.com
> > _______________________________________________
> > IPython-User mailing list
> > IPython-User@scipy.org
> > http://mail.scipy.org/mailman/listinfo/ipython-user
> _______________________________________________
> IPython-User mailing list
> IPython-User@scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-user
>



-- 
Tom Brander
http://tombrander.com -Real Estate
http://oswco.com -Open Software
3763 West Jackson Blvd.
Birmingham, AL 35213
Phone 205-267-1089
@dartdog
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/ipython-user/attachments/20120908/85827592/attachment-0001.html 


More information about the IPython-User mailing list