googleapis / googleapis/librarian

librarian: when designing repo consolidation, where should samples go?

Open
#3,044 0 comments 0 reactions 0 assignees View on GitHub
priority: p3
Dominant language
Go
Stars
45
Forks
61
Avg merge
18h 32m
Merged PRs (30d)
175

Description

We have *at least* 4 possible kinds of sample code. (I know of 4 for .NET...)

- Product-written code, typically in a separate language-specific repo, e.g. http://github.com/GoogleCloudPlatform/dotnet-docs-samples; these are included in product docs
- Autogenerated monolithic snippets, e.g. https://github.com/googleapis/google-cloud-dotnet/tree/main/apis/Google.Cloud.SecretManager.V1/Google.Cloud.SecretManager.V1.Snippets
- Autogenerated file-per-method snippets, e.g. https://github.com/googleapis/google-cloud-dotnet/tree/main/apis/Google.Cloud.SecretManager.V1/Google.Cloud.SecretManager.V1.GeneratedSnippets
- Handwritten language-specific code included in our reference docs, e.g. https://github.com/googleapis/google-cloud-dotnet/tree/main/apis/Google.Cloud.Firestore/Google.Cloud.Firestore.Snippets which includes code shown in https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Firestore/latest/datamodel; in .NET these are written in the form of integration tests

Some languages may have other kinds of sample code, or not have as many kinds as this.

We need to work out where it will all live in the future, and whether we want it all.

Contributor guide

Open the contributing guide

Research direction

Start by inventorying the four sample locations described in the issue, including dotnet-docs-samples and the SecretManager and Firestore snippet paths. Compare how each language handles product, generated, and reference samples; done means a documented decision about which categories to retain and where they should live.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
developer-experience, documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.