add /api/graphgist or /api/load endpoint to load content from various sources

neo4j-contrib / graphgist-cms

http://graphgist.neo4j.com/

67 stars 24 forks source link

add /api/graphgist or /api/load endpoint to load content from various sources #14

Closed jexp closed 9 years ago

jexp commented 9 years ago

copy from neo4j.org repo
add etag support (esp. for github gists and repos)
make the caching skippable with a query parameter
source support for github, github gists, dropbox, any URL, pastebin, etherpad (copy the missing pieces from http://gist.asciidoctor.org -> https://github.com/asciidoctor/docgist/blob/master/js/gist.js)
perhaps add support for cache-headers?
make the local rendering use this endpoint
if all works, make gist.neo4j.org use this endpoint too
https://github.com/jexp/neo4j-org/blob/master/helpers/load_gist.js
app.js (neo4j.org) api endpoint https://github.com/jexp/neo4j-org/blob/master/app.js#L460

cheerfulstoic commented 9 years ago

Copied from neo4j.org repo. etags supported. Can skip with a query param. Next step is to get back to the client-side

jexp commented 9 years ago

Did you check if the additional options from docgist are included (like loading from etherpad or pastebin or copy.com?)

cheerfulstoic commented 9 years ago

Finally got graphgists rendering. See here for an example:

http://graphgist.herokuapp.com/#/gists/ca811daa580aee95bd07

Next to supporting different sources

jexp commented 9 years ago

The one you shared looks like an internal lookup id (for the database) or?

Looks great, even already works with github gist and other id's.

Not sure about hash vs ? as separator do you know the implication for caches and google etc?

Now you can change the links from the detail page to use this renderer, or?

cheerfulstoic commented 9 years ago

No, the ID seems to be a github gist: https://api.github.com/gists/ca811daa580aee95bd07

Maybe it's private?

The hash separator is for Angular and it makes sense, I think, for single-page app behavior.

For SEO, I think it's fine. See this page: http://stackoverflow.com/questions/13499040/how-do-search-engines-deal-with-angularjs-applications

For caching, I think what's important for caching in single page apps like an Angular app is caching of the javascript / endpoints. We've actually got a lot of javascript files in there now which we might want to do something about

I can easily change the links. Do we just want to drop the summary pages?

cheerfulstoic commented 9 years ago

I think that's it for this one.