Static website with GH-Pages

pgRouting / osm2pgrouting

Import tool for OpenStreetMap data to pgRouting database

https://pgrouting.org

GNU General Public License v2.0

288 stars 112 forks source link

Static website with GH-Pages #248

Open dkastl opened 5 years ago

dkastl commented 5 years ago

As described in https://github.com/pgRouting/admin/pull/26#event-1988262325 we could also create a static website for the osm2pgrouting under osm.pgrouting.org.

[x] DNS settings for subdomain
[ ] Create branch or directory for Github Pages: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
[x] Create CNAME file as in https://github.com/pgRouting/workshop/blob/gh-pages/CNAME

cayetanobv commented 5 years ago

@dkastl @cvvergara created CNAME and docs folder: https://github.com/pgRouting/osm2pgrouting/pull/251

What tool should we use to write osm2pgrouting docs: sphinx, mkdocs, others...?

dkastl commented 5 years ago

It's good to have something consistent, not a different tool in every repository. But personally I would prefer Markdown, because the files render nicely in the Github repository view already and can be edited there directly by anyone.

cvvergara commented 5 years ago

even that I like consistencies, we need to use what is best for the purpose pgRouting is very complex for using markdown sphinx is very complex for documenting osm2pgrouiting ;)