Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Improve Contributing section in readme #99

Merged
merged 3 commits into from
Aug 28, 2021

Conversation

riQQ
Copy link
Contributor

@riQQ riQQ commented Apr 28, 2021

This makes it more obvious that the API key needs to be provided when using Tangram Play. See also the instructions provided at #87 (comment).

@riQQ riQQ force-pushed the add-api-key-comment branch 2 times, most recently from 0773e91 to d418611 Compare April 28, 2021 21:06
@ENT8R
Copy link
Collaborator

ENT8R commented Apr 29, 2021

Thank you for your proposal!

While I think that the addition to the readme makes perfectly sense, I don't really think that it is necessary to add another hint in the style files as there is already a hint where all constants/global variables are defined:

global:
api_key: false # intended to be overwritten by StreetComplete

After all, the website at https://streetcomplete.github.io/streetcomplete-mapstyle/ offers more or less the same functionality to edit a style (via the pencil icon in the top left corner) even without requiring to use an API key.

Was it difficult for you to figure out how to edit the styles?

@riQQ
Copy link
Contributor Author

riQQ commented Apr 29, 2021

It took my a while to figure it out for Tangram Play.

I only discovered the link to https://streetcomplete.github.io/streetcomplete-mapstyle/, after I already setup Tangram Play with the API key. Maybe this should be the prefered way of editing for the Contributing section in the readme with an annotation that it doesn't need an API key for jawg.io.

What do you think about that?

@ENT8R
Copy link
Collaborator

ENT8R commented Jun 6, 2021

Your suggestion sounds great! Would you like to modify this PR to implement this suggestion?
I'm sorry I didn't respond earlier, but as the Jawg style is not the only map style, I also wanted to offer a solution to link to the other map styles. I did this now with dafd6d1, so the different styles can be directly linked:

https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg&style=light
https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg&style=dark
https://streetcomplete.github.io/streetcomplete-mapstyle/?provider=jawg&style=satellite

@riQQ riQQ force-pushed the add-api-key-comment branch from d418611 to 6f62c9d Compare June 27, 2021 13:39
Add hint to add jawg.io API key when using Tangram Play.
@riQQ riQQ force-pushed the add-api-key-comment branch from 6f62c9d to 410ac30 Compare June 27, 2021 13:40
@riQQ
Copy link
Contributor Author

riQQ commented Jun 27, 2021

@ENT8R updated the PR. Can you take another look, please?

riQQ and others added 2 commits June 27, 2021 19:36
Co-authored-by: ENT8R <[email protected]>
It's better if the default changes later.

Co-authored-by: ENT8R <[email protected]>
@riQQ
Copy link
Contributor Author

riQQ commented Jun 27, 2021

@ENT8R thanks for catching the error and the suggested improvement. I implemented your suggestions.

@riQQ riQQ changed the title Add commented out api_key setting in styles Improve Contributing section in readme Aug 10, 2021
@riQQ riQQ requested a review from ENT8R August 28, 2021 12:26
Copy link
Collaborator

@ENT8R ENT8R left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I somehow forgot about this PR, thank you for bringing it back to my attention

@ENT8R ENT8R merged commit 7755a6c into streetcomplete:jawg Aug 28, 2021
ENT8R added a commit that referenced this pull request Aug 28, 2021
ENT8R added a commit that referenced this pull request Aug 28, 2021
ENT8R added a commit that referenced this pull request Aug 28, 2021
@riQQ riQQ deleted the add-api-key-comment branch August 28, 2021 13:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants