search

mapzen / documentation

Configuration files, tools, and content to build Mapzen's documentation
https://mapzen.com/documentation
MIT License
25 stars 22 forks source link

Add how to import a YAML for API key protection #331

Closed rmglennon closed 6 years ago

rmglennon commented 6 years ago

This adds a section to the docs on how to protect your API key by importing a key from a separate file.

Seemed better to talk about it like this instead of defining the global in the same scene file. I think this is how you do it, but @meetar @burritojustice, have a look!

rmglennon commented 6 years ago

@meetar - thanks for the review! Have a look at the current edits and see what you think.

Preview https://precog.mapzen.com/mapzen/documentation/rhonda-scene-keys/documentation/overview/api-keys/#protect-your-api-keys

meetar commented 6 years ago

Definitely more comprehensive! I probably should have clarified, those were mostly examples for how to use import generally – I think the last example with the local file will cover 99% of the use cases for obfuscating an API, and I think the others could be covered with a link to https://mapzen.com/documentation/tangram/import/.

rmglennon commented 6 years ago

Thanks for the reviews, @meetar (and for having thorough docs to link to)!