golioth / golioth-zephyr-sdk

Golioth SDK For Zephyr
https://www.golioth.io
Apache License 2.0
68 stars 19 forks source link

Extract Samples into separate repository/repositories #34

Closed 0Grit closed 2 years ago

0Grit commented 3 years ago

Our goal is to enable developers to trust our IoT clients and services so they can focus on the application specific detail of their work.

Their applications depend on the client not the other way around. Therefore I propose we pull out the samples directory into either it's own repository or multiple repositories. (1 per example)

The samples can then act as a working template for the developer to start from and eventually fork.

mniestroj commented 3 years ago

I agree with idea of creating application template(s). If feasible, I would try to reduce that to 1-2 application repositories.

However I would still recommend keeping most samples as part of this repository, because:

0Grit commented 3 years ago

Then maybe we just give end to end examples their own repositories?

beriberikix commented 3 years ago

Then maybe we just give end to end examples their own repositories? 💯 on board with that!

0Grit commented 2 years ago

@ChrisGammell @alvarowolfx sounds related to recent slack discussions.

vitprajzler commented 2 years ago

Haven't we already gone through this in the separate sample repository?

I share Marcin's concern about maintainability. I don't want to create a maintenance burden while the team is still quite small.

I'd say the dedicated repository for all samples would be a good compromise between maintainability and improved developer experience.

@mniestroj, could you help me understand what the maintenance effort would be for the single dedicated repository with samples?

mniestroj commented 2 years ago

Some related work/issues with splitting all samples into separate repository:

Let's start with benefits of splitting samples into separate repository, as I don't see any of those. Having a separate template or reference application repository (like https://github.com/golioth/app-hello-golioth) that uses SDK makes perfect sense, but what we have inside samples/ right now are just very basic API usage examples, so that potential user does not have to search through another repo(s) in order to roughly evaluate those.

0Grit commented 2 years ago

I now see the purpose of the samples inside of our SDK as a very narrow scope way to show individual functionality in close proximity to the sources.

My original intent in this issue was not tuned to that fact and cast a net over all the samples. Thank @mniestroj thank you for guiding me to this understanding. It can now be closed.