[Neuroimaging] Site Discussion

Ben Cipollini bcipolli at ucsd.edu
Thu Aug 27 01:42:18 CEST 2015 

I would suggest that, before working on #1-3, work on the documentation for
the workflow, and any weirdness about the templates to work around bugs.
Given the fears about the workflow and the need to work around Jekyll / CI
bugs, I think we should make it clear what the current workflow entails.

The docs don't have to be super-pretty, but I think at least a complete
sketch of the workflow would be great to document and discuss while you
start moving forward with the rest.

Would you be up for doing that, Vanessa? I assume it wouldn't be too
complex--just a few details about how to build on each system (not what's
underneath the hood, just what the user has to do), and any requirements of
template writing that are constrained by that.

Thanks,
Ben

On Wed, Aug 26, 2015 at 4:28 PM, vanessa sochat <vsochat at stanford.edu>
wrote:

> My suggestions for moving forward:
>
>
> 1)
>
> Feedback and desires for the template and look, best as issues on the
> repo. Ironically, we've been so focused on getting it working that I don't
> consider the style complete, and there were good suggestions that I haven't
> even looked at yet! If you have a style or element preference, please
> share, and it would be great to provide an example. First we fix those
> details.
>
> 2)
>
> Then content (specific packages, pages that are not posts, and where we
> tell users to ask for help, etc). I'm pretty indifferent about these
> things, and will be happy to go with the consensus. I can write
> documentation for the "contribute" page for the different flavors of
> contributors.
>
> 3)
>
> It would be good for others to then give the different kinds of
> contribution a try, and get feedback on those workflows.
>
> 4)
>
> Then when the CI, ghpages, blogging / site workflow, and documentation are
> properly in order, we deploy our little nipy.
>
>
> I'll start a first round of edits (step 1) this weekend.
>
>
> On Wed, Aug 26, 2015 at 4:13 PM, vanessa sochat <vsochat at stanford.edu>
> wrote:
>
>> This should be fairly easy to maintain. The main "package" pages are
>> jekyll, meaning anyone can push a PR to the repo, preview on circle, and
>> then deploy to github pages with approved changes. Developers know how to
>> use github.
>>
>> The hidden blog is hosted at tumblr, which means that:
>>
>> - anyone can contribute content. We can let it get pushed or put it in a
>> queue for approval.
>> - posts can be done on mobile, or from email. In html, markdown, or
>> standard text editor.
>> - we can choose to "hide" the neuroimaging.tumblr.com url if we want,
>> but it's really not so bad.
>> - looks spiffy on mobile too :)
>> - posts can be associated with authors, but don't need to be.
>> - people can ask questions on posts, share posts, like them, etc.
>> - integrated notifications, social media, apps, all the standard stuff
>> you get with a platform like this. Tumblr has an API :)
>>
>> We kill lots of birds with a snakey thought stone. The site has CI,
>> hosted for free on ghpages, and is an easy workflow for developers to
>> update or add their packages. The site is also better integrated into the
>> non-developer community, because anyone can contribute content easily
>> without github, and we still have control over that content.
>>
>> If there is a huge redesign of the site, then the template would need to
>> be updated on tumblr, but that really comes down to copy pasting the base
>> code into the template editor. This was the idea that I had this morning.
>>
>>
>> On Wed, Aug 26, 2015 at 3:44 PM, vanessa sochat <vsochat at stanford.edu>
>> wrote:
>>
>>> *Continuous integration:*
>>>
>>> https://circle-artifacts.com/gh/vsoch/nipy-jekyll/68/artifacts/0/home/ubuntu/nipy-jekyll/_site/index.html
>>>
>>> *Gihub pages:*
>>> http://vsoch.github.io/nipy-jekyll/
>>>
>>> All things seem to be in working order :)
>>>
>>>
>>>
>>> On Wed, Aug 26, 2015 at 3:25 PM, Eleftherios Garyfallidis <
>>> garyfallidis at gmail.com> wrote:
>>>
>>>> So another push for Jekyll?
>>>>
>>>>
>>>> On Wed, Aug 26, 2015 at 6:05 PM, Ariel Rokem <arokem at gmail.com> wrote:
>>>>
>>>>> Hey Eleftherios,
>>>>>
>>>>> On Wed, Aug 26, 2015 at 1:08 PM, Eleftherios Garyfallidis <
>>>>> garyfallidis at gmail.com> wrote:
>>>>>
>>>>>> Hi Vanessa,
>>>>>>
>>>>>> On Wed, Aug 26, 2015 at 3:20 PM, vanessa sochat <vsochat at stanford.edu
>>>>>> > wrote:
>>>>>>
>>>>>>> Eleftherios, it's good that you express concern because that means
>>>>>>> that you care about nipy, and we can work together to ensure that the
>>>>>>> vision is properly reflected in this site. It's typically not a straight
>>>>>>> path to converge on the right solution, and I think that it's ok we are
>>>>>>> needing to try different things. If it isn't too troubling to you, please
>>>>>>> let me implement what I have in mind, and then we can move forward with
>>>>>>> discussion on the points of content.
>>>>>>>
>>>>>>>
>>>>>> Sure, be happy to prepare whatever you think will help the
>>>>>> discussion. Can I ask you to summarize quickly here the next steps of
>>>>>> development that you have in mind?
>>>>>>
>>>>>
>>>>> I think that question has been answered here:
>>>>> https://mail.python.org/pipermail/neuroimaging/2015-August/000380.html
>>>>>
>>>>>
>>>>>> Best,
>>>>>> Eleftherios
>>>>>>
>>>>>>
>>>>>>
>>>>>>> On Wed, Aug 26, 2015 at 12:09 PM, vanessa sochat <
>>>>>>> vsochat at stanford.edu> wrote:
>>>>>>>
>>>>>>>> Hi Eleftherios,
>>>>>>>>
>>>>>>>> A framework like Django is too heavy for a simple portal and blog,
>>>>>>>> and we want to stay away from making something substantial that requires
>>>>>>>> regular maintenance and care, and an actual server. We can achieve all the
>>>>>>>> functionality of comments / social media, etc by integrating a blogging
>>>>>>>> platform into a site that works on Github pages. Question b (sites
>>>>>>>> included) and c (organization vision) needs discussion from everyone, and
>>>>>>>> for the rest, here are my thoughts:
>>>>>>>>
>>>>>>>> a) What the portal is about? We need to reach consensus. This is
>>>>>>>>> currently vague.
>>>>>>>>>
>>>>>>>>> A simple portal that gives nipy a brand, links to its products,
>>>>>>>> and integrates some platform for us to easily write about it. If something
>>>>>>>> more substantial than that is desired, then we first need to resolve where
>>>>>>>> it will be hosted and who takes responsibility for its life.
>>>>>>>>
>>>>>>>>
>>>>>>>>> c) How the website and e-mail lists/forums will benefit and
>>>>>>>>> promote the work and the vision of this organization.
>>>>>>>>>
>>>>>>>>> For the work - the website blog will afford all the things that
>>>>>>>> blogs afford: sharing ideas, examples, links, social media integration, etc.
>>>>>>>>
>>>>>>>>
>>>>>>>>> d) Make some decisions on the technologies that we can use to
>>>>>>>>> support a, b, c.
>>>>>>>>>
>>>>>>>>> Again, this is more about hosting and responsibility.
>>>>>>>>
>>>>>>>>
>>>>>>>>> (b) is critical because for example I saw that you added in the
>>>>>>>>> website projects which are not currently under our
>>>>>>>>> github organization https://github.com/nipy. I think we need
>>>>>>>>> consensus to take such a decisions.
>>>>>>>>>
>>>>>>>>> You should consider all current content on the site as Lorem Ipsum
>>>>>>>> etc. I simply reproduced what is on the current site and did not make any
>>>>>>>> "decisions." As I said earlier, content and template come *after* getting
>>>>>>>> the site functioning.
>>>>>>>>
>>>>>>>>
>>>>>>>>> (c) is also much related to Matthew's e-mail for supporting or not
>>>>>>>>> Neurostars for answering questions about the NIPY
>>>>>>>>> projects. This information and whatever we decide must be
>>>>>>>>> highlighted clearly in the portal.
>>>>>>>>>
>>>>>>>>> Lorem,.. ipsum...
>>>>>>>>
>>>>>>>> :)
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Wed, Aug 26, 2015 at 1:54 PM, vanessa sochat <
>>>>>>>>> vsochat at stanford.edu> wrote:
>>>>>>>>>
>>>>>>>>>> exactly :)
>>>>>>>>>>
>>>>>>>>>> https://www.youtube.com/watch?v=Uwzg7SYZKF0
>>>>>>>>>>
>>>>>>>>>> On Wed, Aug 26, 2015 at 10:46 AM, Ariel Rokem <arokem at gmail.com>
>>>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> Sorry - didn't see that one for some reason.
>>>>>>>>>>>
>>>>>>>>>>> On Wed, Aug 26, 2015 at 9:23 AM, Vanessa Villamia Sochat <
>>>>>>>>>>> vsochat at stanford.edu> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Hi everyone!
>>>>>>>>>>>>
>>>>>>>>>>>> I thought more about this on my walk - here is a reasonable
>>>>>>>>>>>> game plan! I will do the work to put together a solution that integrates
>>>>>>>>>>>> Ariel's original vision with ghpages, the parts of Jekyll that do work, and
>>>>>>>>>>>> a more non developer friendly integrated blog. I think this could meet all
>>>>>>>>>>>> of our goals and be a solution that better integrates social aspects of our
>>>>>>>>>>>> community - github just doesn't specialize in blogging but many services
>>>>>>>>>>>> do. If that does not work, then we can go to Sphinx. Boum!
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> +1
>>>>>>>>>>>
>>>>>>>>>>> Bada-boum!
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>> I will send out an update likely during weekend time when I've
>>>>>>>>>>>> tested some things.
>>>>>>>>>>>>
>>>>>>>>>>>> Best,
>>>>>>>>>>>>
>>>>>>>>>>>> Vanessa
>>>>>>>>>>>>
>>>>>>>>>>>> > On Aug 26, 2015, at 8:32 AM, Matthew Brett <
>>>>>>>>>>>> matthew.brett at gmail.com> wrote:
>>>>>>>>>>>> >
>>>>>>>>>>>> > Hi,
>>>>>>>>>>>> >
>>>>>>>>>>>> >> On Wed, Aug 26, 2015 at 4:10 PM, vanessa sochat <
>>>>>>>>>>>> vsochat at stanford.edu> wrote:
>>>>>>>>>>>> >> Hi Group,
>>>>>>>>>>>> >>
>>>>>>>>>>>> >> Ben and I are having some discussion on the higher level
>>>>>>>>>>>> goals of the site,
>>>>>>>>>>>> >> and want to bring everyone in. In summary, we want something
>>>>>>>>>>>> that is easy to
>>>>>>>>>>>> >> contribute content to, and has continuous integration for
>>>>>>>>>>>> previewing
>>>>>>>>>>>> >> updates. I am wondering, what was wrong with the initial
>>>>>>>>>>>> look of the site?
>>>>>>>>>>>> >> Was it that sphinx is hard to update?
>>>>>>>>>>>> >
>>>>>>>>>>>> > Actually, I think that sphinx is a very good option, and most
>>>>>>>>>>>> other
>>>>>>>>>>>> > scientific Python sites use sphinx for their main pages.
>>>>>>>>>>>> >
>>>>>>>>>>>> > The particular template that we were using was a little dated
>>>>>>>>>>>> and
>>>>>>>>>>>> > ugly, but I bet that could be improved.
>>>>>>>>>>>> >
>>>>>>>>>>>> > Most if not all developers are perfectly capable of building
>>>>>>>>>>>> the
>>>>>>>>>>>> > sphinx documentation locally to preview it, but we can also
>>>>>>>>>>>> do what
>>>>>>>>>>>> > other projects are doing, and build / publish the docs in some
>>>>>>>>>>>> > temporary place for each commit, using an entry in the
>>>>>>>>>>>> travis-ci
>>>>>>>>>>>> > matrix of jobs.
>>>>>>>>>>>> >
>>>>>>>>>>>> > I think Ariel was particularly attracted to Jekyll / github
>>>>>>>>>>>> pages,
>>>>>>>>>>>> > because it is very easy to get a rendered version to look at
>>>>>>>>>>>> with a
>>>>>>>>>>>> > git push, and although that is generally desirable, I think
>>>>>>>>>>>> building /
>>>>>>>>>>>> > reviewing locally is at least as important.
>>>>>>>>>>>> >
>>>>>>>>>>>> > So - if it were entirely up to me - I would prefer we go back
>>>>>>>>>>>> to
>>>>>>>>>>>> > sphinx, on the basis that it is a very familiar workflow to
>>>>>>>>>>>> most
>>>>>>>>>>>> > Python developers.
>>>>>>>>>>>> >
>>>>>>>>>>>> > Thanks very much for doing all this work by the way - it's
>>>>>>>>>>>> very
>>>>>>>>>>>> > helpful, and I'm sorry that we are going round and round.
>>>>>>>>>>>> >
>>>>>>>>>>>> > See you,
>>>>>>>>>>>> >
>>>>>>>>>>>> > Matthew
>>>>>>>>>>>> > _______________________________________________
>>>>>>>>>>>> > Neuroimaging mailing list
>>>>>>>>>>>> > Neuroimaging at python.org
>>>>>>>>>>>> > https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>>>>>>>
>>>>>>>>>>>> _______________________________________________
>>>>>>>>>>>> Neuroimaging mailing list
>>>>>>>>>>>> Neuroimaging at python.org
>>>>>>>>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> _______________________________________________
>>>>>>>>>>> Neuroimaging mailing list
>>>>>>>>>>> Neuroimaging at python.org
>>>>>>>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> --
>>>>>>>>>> Vanessa Villamia Sochat
>>>>>>>>>> Stanford University
>>>>>>>>>> (603) 321-0676
>>>>>>>>>>
>>>>>>>>>> _______________________________________________
>>>>>>>>>> Neuroimaging mailing list
>>>>>>>>>> Neuroimaging at python.org
>>>>>>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>
>>>>>>>>> _______________________________________________
>>>>>>>>> Neuroimaging mailing list
>>>>>>>>> Neuroimaging at python.org
>>>>>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>>>>
>>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> --
>>>>>>>> Vanessa Villamia Sochat
>>>>>>>> Stanford University
>>>>>>>> (603) 321-0676
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Vanessa Villamia Sochat
>>>>>>> Stanford University
>>>>>>> (603) 321-0676
>>>>>>>
>>>>>>> _______________________________________________
>>>>>>> Neuroimaging mailing list
>>>>>>> Neuroimaging at python.org
>>>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>>
>>>>>>>
>>>>>>
>>>>>> _______________________________________________
>>>>>> Neuroimaging mailing list
>>>>>> Neuroimaging at python.org
>>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>>
>>>>>>
>>>>>
>>>>> _______________________________________________
>>>>> Neuroimaging mailing list
>>>>> Neuroimaging at python.org
>>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>>
>>>>>
>>>>
>>>> _______________________________________________
>>>> Neuroimaging mailing list
>>>> Neuroimaging at python.org
>>>> https://mail.python.org/mailman/listinfo/neuroimaging
>>>>
>>>>
>>>
>>>
>>> --
>>> Vanessa Villamia Sochat
>>> Stanford University
>>> (603) 321-0676
>>>
>>
>>
>>
>> --
>> Vanessa Villamia Sochat
>> Stanford University
>> (603) 321-0676
>>
>
>
>
> --
> Vanessa Villamia Sochat
> Stanford University
> (603) 321-0676
>
> _______________________________________________
> Neuroimaging mailing list
> Neuroimaging at python.org
> https://mail.python.org/mailman/listinfo/neuroimaging
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/neuroimaging/attachments/20150826/9addd1b9/attachment-0001.html>

More information about the Neuroimaging mailing list