GoogleCloudPlatform / GoogleCloudPlatform/samples-style-guide

Proposal: Guidance on link within samples

Open
#89 6 comments 0 reactions 1 assignee Claimed by @lesv View on GitHub
guideline: needs work priority: p2 type: feature request
Dominant language
HTML
Stars
13
Forks
17
PR merge metrics
No merged PRs in 30d

Description

### Description

At the moment, we have no guidance on providing links to other sources within the samples. While they're extremely valuable to have, it can hinder readability of the entire snippet as there would be horizontal scrollbars and other rendering issues such as rendering a long link on the Sample Browser page (example: https://cloud.google.com/secret-manager/docs/samples/secretmanager-access-secret-version).

### Impact

Having proper guidance will ensure that the samples continue to appear rendering correctly with valuable resources being added.

### Challenge

As this involves the team beyond Samples committee, we might have to reach out to the team governing Sample Browser. Luckily, I'm in that team, so I can bring forward any suggestions from this work to the appropriate personnel and/or make the improvements myself on Sample Browser.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.