samples icon indicating copy to clipboard operation
samples copied to clipboard

Support listing of external samples

Open mchmarny opened this issue 3 years ago • 5 comments

There is a number of Dapr samples all over GitHub. Given the existing disclaimer about each sample being maintainer by its author, the dapr/samples repo should allow for listing of external samples, ones located in user's repo.

Here are some arguments for this approach:

  • Maintainability over time
  • Users clone only the repo for the sample they want to use (not repo of many samples)
  • Ability to support integrations (e.g. Dockerfile or GitHub actions in root)

This approach would still allow for curated list of samples and the dapr/samples repo would still be the go-to place for listing of Dapr demos/samples.

Few popular examples of this approach:

  • https://github.com/steren/awesome-cloudrun
  • https://github.com/akullpp/awesome-java
  • https://github.com/vuejs/awesome-vue
  • https://github.com/avelino/awesome-go
  • https://github.com/enaqx/awesome-react
  • https://github.com/sindresorhus/awesome-nodejs

mchmarny avatar Aug 30 '20 21:08 mchmarny

Yes, this is the intent of the External Samples section in the main README

orizohar avatar Sep 02 '20 20:09 orizohar

I've PR go templates to this section. We should probably list a few other external samples. May be worth review these

mchmarny avatar Sep 03 '20 13:09 mchmarny

I agree with the External Samples section and letting contributors link to examples that exist outside the repo. Although we may need to pen some guidance on how a contributor will decide where to place his/her code. I envision confusion on where samples should be placed and what's best practice.

AaronCrawfis avatar Sep 21 '20 18:09 AaronCrawfis

Also should the primary list of samples be in the samples README or the Dapr docs (& the upcoming docs.dapr.io site)? I vote to make the samples README be a pointer to the docs site so that it's on a site that better support readability for long lists and users can easily search for products/services and discover samples using that search box

AaronCrawfis avatar Sep 21 '20 18:09 AaronCrawfis

should the primary list of samples be in the samples README or the Dapr docs

Interesting question

mchmarny avatar Sep 21 '20 19:09 mchmarny

Added external samples section

msfussell avatar Jan 26 '24 05:01 msfussell