search

swift-server / swift-aws-lambda-runtime

Swift implementation of AWS Lambda Runtime
https://swiftpackageindex.com/swift-server/swift-aws-lambda-runtime
Apache License 2.0
1.15k stars 104 forks source link

move samples as a subdirectory of this project? #71

Closed tomerd closed 4 years ago

tomerd commented 4 years ago

right now we have: https://github.com/swift-server/swift-aws-lambda-examples https://github.com/swift-server/swift-aws-lambda-deubgging-example

maybe moving to an "Examples" subdirectory would make it easier to find than separate repos? we do that in some of our other projects

tomerd commented 4 years ago

@fabianfett @yim-lee @ktoso wdyt?

ktoso commented 4 years ago

I'd +1 just a Samples/ directory "while you can", it has added benefits of discoverability and if someone needs to check specific version of API the samples are in alignment then (if they checkout v1.0 etc).

In Akka we've always had this struggle between keeping them in the repo and outside, but inside was quite beneficial and we've only spun them out once it was faaaar to many of them. Even then, it's useful to only have one spot, like: https://github.com/akka/akka-samples

In general: +1 to keep in project repo while their count in there is managable 👍

fabianfett commented 4 years ago

I'm +1 for this as well. We should make sure though that every Sample has it's own good Readme and that we link from the main Readme to a Samples Readme that explains different deployment options (like sam) and gives hints what each Sample is about.

yim-lee commented 4 years ago

+1, with CI of course