maputnik / osm-liberty

A free Mapbox GL basemap style for everyone
Other
440 stars 99 forks source link

Make the style easier to use #27

Open orangemug opened 6 years ago

orangemug commented 6 years ago

Because osm-liberty uses tilehosting.com for it's data sources for someone to use the style they first have to download the style and edit this line, replacing {key} https://github.com/maputnik/osm-liberty/blob/5ad58cab34196d31c3bda8d3071b201526cc46a6/style.json#L19

That seems like a awkward user experience to me, so I made https://github.com/orangemug/mapbox-gl-tokens which hopefully resolves that issue.

What does everybody think about adding https://github.com/orangemug/mapbox-gl-tokens to the README.md?

pathmapper commented 6 years ago

In general I think it would be a good idea to add the <script/> tag way to use https://github.com/orangemug/mapbox-gl-tokens to the example code in the usage part of the README.md (https://github.com/maputnik/osm-liberty#usage).

But the whole README.md needs an update, because of the missing repo key there is now a need to selfhost OMT or subscribe to a Maptiler plan to have vector tiles available for the style.

I'm not sure if it makes sense to keep the usage part, because without the repo key the usage is not the same as before.

What about the following:

  1. Delete the existing usage part of the README.md.

  2. Provide a preview link of the Liberty style via Maputnik: https://maputnik.github.io/editor/?style=https://rawgit.com/maputnik/osm-liberty/gh-pages/style.json

  3. For further information about usage of styles create a section in the Maputnik Editor Wiki. Such a section could include links to some tutorials on https://openmaptiles.org/docs/ and also an example with https://github.com/orangemug/mapbox-gl-tokens.

From the Liberty style README.md we could link to the Editor Wiki. Also questions like the following could be answered with such a usage Wiki section: https://github.com/maputnik/editor/issues/336

orangemug commented 6 years ago
  1. Delete the existing usage part of the README.md.

Would we need to delete the usage? With https://github.com/orangemug/mapbox-gl-tokens I think it could just change it to be the same usage as outlined in the mapbox-gl-tokens README with a link to https://www.maptiler.com/ to signup and get the your personal token. Thoughts?

  1. Provide a preview link of the Liberty style via Maputnik: https://maputnik.github.io/editor/?style=https://rawgit.com/maputnik/osm-liberty/gh-pages/style.json

Linking to Maputnik with the style in the URL makes a lot of sense to me, this also promotes Maputnik a little more.

  1. For further information about usage of styles create a section in the Maputnik Editor Wiki. Such a section could include links to some tutorials on https://openmaptiles.org/docs/ and also an example with https://github.com/orangemug/mapbox-gl-tokens.

I generally agree with the idea we need more documentation. I common theme for Maputnik seems to be "how do I use this thing..." which I totally understand because it really isn't obvious of it's intended purpose at the moment

From the Liberty style README.md we could link to the Editor Wiki. Also questions like the following could be answered with such a usage Wiki section: maputnik/editor#336

So I'm assuming the aim here is to show how to use Maputnik in a real context, as a base for displaying some sort of data. If so yeah that sounds great!

pathmapper commented 6 years ago

Would we need to delete the usage? With https://github.com/orangemug/mapbox-gl-tokens I think it could just change it to be the same usage as outlined in the mapbox-gl-tokens README with a link to https://www.maptiler.com/ to signup and get the your personal token. Thoughts?

Also fine for me. I was just thinking that without the repro key it's not a ready-to-use basemap anymore, instead it's just a GL style for tiles based on the OMT schema. You're right, it's also a nice demonstration for https://github.com/orangemug/mapbox-gl-tokens!

So I'm assuming the aim here is to show how to use Maputnik in a real context, as a base for displaying some sort of data. If so yeah that sounds great!

Yeah, moving to https://github.com/maputnik/editor/issues/337?