search

umap-project / umap

uMap lets you create maps with OpenStreetMap layers in a minute and embed them in your site.
https://umap-project.org
Other
1.15k stars 220 forks source link

Documentation #81

Closed yohanboniface closed 6 years ago

yohanboniface commented 10 years ago

Originally reported by: BitBucket: almereyda, GitHub: almereyda

The documentation of uMap is rather poor or nonexisting. Which clusters need to be covered?

So far I can identify:

Sources of information currently are:

yohanboniface commented 10 years ago

Original comment by Yohan Boniface (BitBucket: yohanboniface, GitHub: yohanboniface):

There are two kinds of docs, the one for developpers, the one for users. I think the OSM wiki is the best place for this latest, because it's community driven. About the developers doc, this is clearly missing. I want to make the statics install easy, and then spend time on documentation, because I don't want to make people think it's easy to install while it's not (it's easy if you are a python/django dev, like it takes me 10 minutes in a new server; but it's a pain if you don't know the python/django specifics).

Now, you are more than welcome to give a hand on this :)

yohanboniface commented 10 years ago

Original comment by Michael Fairchild (BitBucket: fairchild, GitHub: fairchild):

Hi, i just ran across umap, and it looks like a great fit for my needs. I was able to get it running locally, but not clear how to get the tiles working. The last bit of the read me may be intended for this, telling user to go to admin and add "almost one tile layer". Some more detail or screenshots further explaining this could be helpful I'd be glad to contribute, once I figure out how to get from from git clone to creating a map on a new server. thanks

thoka commented 8 years ago

How about moving the install docs to the (github) wiki and let the crowd improve it ?