Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

decouple website from documentation #180

Closed
tomkralidis opened this issue Aug 21, 2013 · 6 comments
Closed

decouple website from documentation #180

tomkralidis opened this issue Aug 21, 2013 · 6 comments
Milestone

Comments

@tomkralidis
Copy link
Member

The pycsw website is currently blended into the Sphinx documentation setup. As a result, we carry the website along with every release, etc.

The website should be decoupled from the documentation such that only pure software documentation goes in https://github.com/geopython/pycsw/tree/master/docs, and managed as part of a separate repo/build process.

@tomkralidis
Copy link
Member Author

cc @rclark

FYI I've pushed a Pelican-based first pass setup to https://github.com/geopython/pycsw.org/tree/pelican, based on the Bootstrap template at http://getbootstrap.com/examples/justified-nav/. Totally open to new ideas/design, so what's there is not final by any means.

Thinking out loud:

  • homepage should give a quick overview of what you can do, and how easy/fast/lightweight/flexible it is
  • social links
  • mobile friendly
  • nice to have a "Deploy in 4 minutes" type button on the homepage to get people moving fast.

@rclark
Copy link

rclark commented Aug 23, 2013

I forked pycsw.org and built your front-page as a starter in Jekyll: http://rclark.github.io/pycsw.org/

If you want to pursue Jekyll as an option, you could house it in either of the repositories on a "gh-pages" branch and GitHub will serve it automatically. If you create a branch in either place I can fork it and start sending pull requests.

I can also take my existing fork of pycsw.org and flesh it out a bit more if you'd like to see that first.

@tomkralidis
Copy link
Member Author

FYI see associated mailing list discussion at http://osgeo-org.1560.x6.nabble.com/new-website-development-tp5073682.html for decisions/progress.

Of note, moving forward the website is now managed as a branch in https://github.com/geopython/pycsw/tree/website

tomkralidis added a commit that referenced this issue Aug 28, 2013
@tomkralidis
Copy link
Member Author

Almost there. To do:

  • figure out live deployment data management
  • make front page snazzy
  • ensure tests pass per .travis.yml
  • setup annoucements as blogposts

@rclark I like the GitHub GeoJSON approach. Is there anyway we could make this automated as a build step against the wiki page somehow?

There's value is having https://github.com/geopython/pycsw/wiki/Live-Deployments as a wiki page because I see it as a live working document which is easy to maintain, and easy for a script to parse, etc. as per https://github.com/geopython/pycsw/blob/master/docs/build_map.py.

Or am I thinking about this the wrong way? I'd rather lift the Leaflet requirement of the current approach of the live site, provided it's against data that's easy to manage and in a single spot.

@tomkralidis
Copy link
Member Author

This is ready to go. Next steps:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants