[pycsw-devel] new website development

Tom Kralidis tomkralidis at hotmail.com
Mon Aug 26 08:20:27 PDT 2013 

By 'docs' in .rst, this refers to the existing software documentation. IMHO by going with Jekyll we will move the website related content to Markdown. 

P.S. Norman Vine (in IRC) just pointed us to hyde as a Python alternative http://hyde.github.io), fwiw. 

Sent from my iPhone

On 2013-08-26, at 11:15, "Ryan Clark" <ryan.clark at azgs.az.gov> wrote:

> - Jekyll reads your working directory and generates a set of static files in a folder called _site. So you can simply transfer that folder to the OSGeo server.
> 
> - Files like .pdfs, css, images just get copied directly into the _site folder along with the built html files. So there should be no issue maintaining static files.
> 
> - Yes, if you don't want the page accessible at geopython.github.io/pycsw you would just use a branch that is not called gh-pages. 
> 
> I'm a little concerned about the docs though. I understand the rationale of keeping those in .rst but I don't know if there's a way to get Jekyll to work with those files. I need to look into that a bit.
> 
> 
> ____________________
> 
> Ryan Clark
> Arizona Geological Survey
> ryan.clark at azgs.az.gov
> (520) 302-4871
> facebook.com/ModernGeologist
> @worbly
> 
> 
> 
> 
> 
> 
> 
> 
> 
> On Aug 26, 2013, at 4:08 AM, Tom Kralidis <tomkralidis at hotmail.com>
>  wrote:
> 
>> Sorry sent too soon. 
>> 
>> Ryan: great work here. Agree with Angelos that we need the deployment target to be OSGeo for now. 
>> 
>> - what would the workflow look like to maintain this? A build step to gen the pages then transfer to the target site? I'm guessing doing this with GitHub makes it seamless
>> 
>> - how do we store static files like PDFs or LaTeX? We need to store stuff like this for our publications
>> 
>> - i really like the idea of the website being a branch in the code repository. Given our need to publish to OSGeo infrastructure for now, do we call this branch 'gh-pages'? Will this trigger GitHub to publish the site to geopython.github.io/pycsw? I'd like the site to only be at pycsw.org (docs can/should be spread to multiple places). If yes, do we call the branch 'website' or something?
>> 
>> - looks like things render according to filename extension (.md, .html)?
>> 
>> Looking forward to launching the new site for foss4g!
>> 
>> Sent from my iPhone
>> 
>> On 2013-08-25, at 9:28, "Angelos Tzotsos" <gcpp.kalxas at gmail.com> wrote:
>> 
>>> Hi Ryan,
>>> 
>>> Having seen your initial work on http://rclark.github.io/pycsw.org/ I am starting to get convinced about the Jekyll + Markdown combo.
>>> 
>>> As long as pycsw documentation stays in Python world (i.e. rst) I am +1 on moving the web site to Jekyll.
>>> 
>>> This does not mean I did not like the prototype made by Tom.
>>> 
>>> One more comment: the main pycsw.org web site must remain at OSGeo infrastructure in my opinion (we are under incubation), so GitHub can definitely hold your development version before deploying to OSGeo servers.
>>> 
>>> Thoughts?
>>> 
>>> Best,
>>> Angelos
>>> 
>>> 
>>> 
>>> 
>>> On Fri, Aug 23, 2013 at 9:10 PM, Ryan Clark <ryan.clark at azgs.az.gov> wrote:
>>>> I would say the big benefit to GitHub pages is that they provide your server hosting. Maybe that's not an issue. I think there's also a nice simplicity in keeping the website / documentation code literally in the same repository as the code itself -- just on a separate branch. Again, that may or may not be an issue.
>>>> 
>>>> Either way, I'd like to try and help with the website / templating / design. Have you already started some of this work in a separate repository?
>>>> 
>>>> Thanks!
>>>> ____________________
>>>> 
>>>> Ryan Clark
>>>> Arizona Geological Survey
>>>> ryan.clark at azgs.az.gov
>>>> (520) 302-4871
>>>> facebook.com/ModernGeologist
>>>> @worbly
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> On Aug 23, 2013, at 7:03 AM, Tom Kralidis <tomkralidis at hotmail.com> wrote:
>>>> 
>>>>> Looks like it. Since the existing content is rST, I thought that would be easier. Are there advantages to using Jekyll + GitHub pages? I'm still in the template/design stage, so there's time to change engines.
>>>>> 
>>>>> ________________________________
>>>>>> From: ryan.clark at azgs.az.gov 
>>>>>> To: gcpp.kalxas at gmail.com 
>>>>>> CC: tomkralidis at hotmail.com; pycsw-devel at lists.osgeo.org 
>>>>>> Subject: Re: [pycsw-devel] new website development 
>>>>>> Date: Fri, 23 Aug 2013 12:53:05 +0000 
>>>>>> 
>>>>>> This kind of documentation would be a great target for Jekyll + GitHub  
>>>>>> pages. I guess you would have to use markdown though? 
>>>>>> 
>>>>>> 
>>>>>> On Aug 23, 2013, at 2:38 AM, "Angelos Tzotsos"  
>>>>>> <gcpp.kalxas at gmail.com<mailto:gcpp.kalxas at gmail.com>> wrote: 
>>>>>> 
>>>>>> Hi Tom, 
>>>>>> 
>>>>>> This is a very good idea for all the reasons you mentioned. 
>>>>>> +1 
>>>>>> 
>>>>>> BTW, I am preparing an HTML5 presentation for FOSS4G 2013 and I am  
>>>>>> wondering where this would live and be maintained. 
>>>>>> 
>>>>>> If the web-site code lives in a new git repository, then I guess it  
>>>>>> would be natural to add resources there, right? 
>>>>>> 
>>>>>> Best, 
>>>>>> Angelos 
>>>>>> 
>>>>>> 
>>>>>> On Thu, Aug 22, 2013 at 2:48 AM, Tom Kralidis  
>>>>>> <tomkralidis at hotmail.com<mailto:tomkralidis at hotmail.com>> wrote: 
>>>>>> Hi all, 
>>>>>> 
>>>>>> The Sphinx documentation in [1] powers the pycsw.org<http://pycsw.org>  
>>>>>> website and associated documentation. 
>>>>>> 
>>>>>> Sphinx docs were initially setup to manage both to make things easy,  
>>>>>> however given project maturation, our OSGeo incubation process, I think  
>>>>>> it's a good time to decouple the website content from pure software  
>>>>>> documentation and manage them separately.  Rationale/benefits: 
>>>>>> 
>>>>>> - web content is growing (OSGeo incubation will soon lead us to  
>>>>>> PSC/RFC's and so on, community, FAQ) 
>>>>>> - website is due for a nice redesign (the docs don't need as much flare) 
>>>>>> - website announcements are natural for a blog setup 
>>>>>> - the website's lifecycle shouldn't/won't have to move along with  
>>>>>> software release 
>>>>>> 
>>>>>> I've opened a ticket for this [2]. 
>>>>>> 
>>>>>> Comments? Ideas? Objections? 
>>>>>> 
>>>>>> It would be great to have some help especially in the website/template  
>>>>>> design, so if anyone has a flare for web design/UI, any contributions  
>>>>>> are more than welcome. 
>>>>>> 
>>>>>> I'm initially thinking for the design to be implemented using Bootstrap  
>>>>>> [3], and setup using Pelican [4] (n.b. we don't have to redo the web  
>>>>>> content which is already in rST). 
>>>>>> 
>>>>>> ..Tom 
>>>>>> 
>>>>>> [1] https://github.com/geopython/pycsw/tree/master/docs 
>>>>>> [2] https://github.com/geopython/pycsw/issues/180 
>>>>>> [3] http://getbootstrap.com 
>>>>>> [4] http://docs.getpelican.com 
>>>>>> _______________________________________________ 
>>>>>> pycsw-devel mailing list 
>>>>>> pycsw-devel at lists.osgeo.org<mailto:pycsw-devel at lists.osgeo.org> 
>>>>>> http://lists.osgeo.org/mailman/listinfo/pycsw-devel 
>>>>>> 
>>>>>> 
>>>>>> 
>>>>>> --  
>>>>>> Angelos Tzotsos 
>>>>>> Remote Sensing Laboratory 
>>>>>> National Technical University of Athens 
>>>>>> http://users.ntua.gr/tzotsos 
>>>>>> _______________________________________________ 
>>>>>> pycsw-devel mailing list 
>>>>>> pycsw-devel at lists.osgeo.org<mailto:pycsw-devel at lists.osgeo.org> 
>>>>>> http://lists.osgeo.org/mailman/listinfo/pycsw-devel   
>>>>>>  
>>> 
>>> 
>>> 
>>> -- 
>>> Angelos Tzotsos
>>> Remote Sensing Laboratory
>>> National Technical University of Athens
>>> http://users.ntua.gr/tzotsos
> 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/pycsw-devel/attachments/20130826/3fba479b/attachment-0001.html>

More information about the pycsw-devel mailing list