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