GoogleCloudPlatform / samples-style-guide

Guidelines on writing effective Google Cloud samples.
https://googlecloudplatform.github.io/samples-style-guide/
Apache License 2.0
11 stars 19 forks source link

Clarify guidance in authentication section #84

Closed piaxc closed 1 year ago

piaxc commented 2 years ago

Thank you for taking the time to advocate for samples practice improvements!

Description

In the authentication section of the Samples Style Guide, it says this:

"If the code snippet is platform specific, explicitly show how to use that platform’s credentials."

It's not clear what "platform-specific" means, and how to explicitly use that platforms credentials. What is a platform in this context?

Please clarify.

Impact

Any support around authentication is helpful, as it is a problematic area.

I'm hoping we can just stick to "Use ADC" and leave it at that.

Challenge

kurtisvg commented 2 years ago

@grayside Did you have thoughts on what constitutes a platform specific scope?