search

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

feat: Remove references to specific credential types. #109

Closed amanda-tarafa closed 1 year ago

amanda-tarafa commented 1 year ago

Closes #84 Closes #85

amanda-tarafa commented 1 year ago

@piaxc Please let me know if these changes addres your concerns raised in #84 and #85. I still think we should provide guidance on snippets that may require specific credentials, but tat guidance should be about client initialization and not about specific credential obtention.

Note I've only updated C# code, if this proposal seems fine I'll update the code for other languages. The PR will remain a draft until then.

grayside commented 1 year ago

In #107 @rogerthatdev introduced using shortcodes to include code examples from dedicated files. I propose we move the code touched by this guideline to separate files, and change unmodified languages to something of a TODO. We could then file issues for each one, and merge the proposal based on the guideline readiness rather than blocking on 6 additional contributions.

amanda-tarafa commented 1 year ago

@grayside @piaxc this is ready for review.

We'd need to gather the documentation links for the other languages but that can be done independently.