admin/smb: add an example of using generic resources

[phlogistonjohn]

Add a godoc example file that tries to explain how to use Generic Resources.

Checklist

• Added tests for features and functional changes
• Public functions and types are documented
• Standard formatting is applied to Go code
• Is this a new API? Added a new file that begins with //go:build ceph_preview
• Ran make api-update to record new APIs

New or infrequent contributors may want to review the go-ceph Developer's Guide including the section on how we track API Status and the API Stability Plan.

The go-ceph project uses mergify. View the mergify command guide for information on how to interact with mergify. Add a comment with @Mergifyio rebase to rebase your PR when github indicates that the PR is out of date with the base branch.

[anoopcs9]

I'm not sure if this is the right place. What if we extend hints.md or even create a separate one for this particular use case with relevant code snippets?

[phlogistonjohn]

I want this to show up in the API docs once we stablise the API. This is the way to do whole file examples as far as I know.

[phlogistonjohn]

https://go.dev/blog/examples

[anoopcs9]

https://go.dev/blog/examples

Thanks, now it makes sense.

[anoopcs9]

lgtm, thanks.

[mergify]

Merge Queue Status

Rule: default

---

• ✅ Entered queue — 2026-02-24 17:24 UTC
• ✅ Checks passed · in-place
• ✅ Merged — 2026-02-24 17:24 UTC · at 050155d3822c12717e0fb3948d8fe5e1d4a8ada8

This pull request spent 23 seconds in the queue, with no time running CI.

Required conditions to merge

• #approved-reviews-by >= 1 [🛡 GitHub branch protection]
  • admin/smb: add an example of using generic resources #1232
• #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
  • admin/smb: add an example of using generic resources #1232
• any of [🛡 GitHub branch protection]:
  • check-success = check
  • check-neutral = check
  • check-skipped = check
• any of [🛡 GitHub branch protection]:
  • check-success = test-suite (pacific)
  • check-neutral = test-suite (pacific)
  • check-skipped = test-suite (pacific)
• any of [🛡 GitHub branch protection]:
  • check-success = test-suite (quincy)
  • check-neutral = test-suite (quincy)
  • check-skipped = test-suite (quincy)
• any of [🛡 GitHub branch protection]:
  • check-success = test-suite (reef)
  • check-neutral = test-suite (reef)
  • check-skipped = test-suite (reef)
• any of [🛡 GitHub branch protection]:
  • check-success = test-suite (squid)
  • check-neutral = test-suite (squid)
  • check-skipped = test-suite (squid)