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!: Add support for patterns to sample guide #129

Open grayside opened 1 year ago

grayside commented 1 year ago

Fixes #105.

This is being kept in draft because at this stage it's a prototype for evaluation.

github-actions[bot] commented 1 year ago

🔎 Preview at https://GoogleCloudPlatform.github.io/samples-style-guide/previews/PR-129/

github-actions[bot] commented 1 year ago

🔎 Preview at https://GoogleCloudPlatform.github.io/samples-style-guide/previews/PR-129/

grayside commented 1 year ago

Should we have a "Applies to: all" or "Applies to: Snippets, Patterns so all guidelines are annotated?

I've made that change.

Future refactors might benefit from individual files for each language. I found it hard to see language specific sections clearly when skimming

Let's file that as a separate discussion ;)

Using the emojis in the "Applies to: Snippets ✂︎", would be a helpful visual for skimming the doc

Done. What do you think?

grayside commented 1 year ago

https://twitter.com/sigje/status/1692309591789650070 is holding strong at about 2/3's preferring emoji prefix, so switching that around.

github-actions[bot] commented 1 year ago

🔎 Preview at https://GoogleCloudPlatform.github.io/samples-style-guide/previews/PR-129/

github-actions[bot] commented 1 year ago

🔎 Preview at https://GoogleCloudPlatform.github.io/samples-style-guide/previews/PR-129/

github-actions[bot] commented 1 year ago

🔎 Preview at https://GoogleCloudPlatform.github.io/samples-style-guide/previews/PR-129/