Design folder to hold examples. about ponzu

[nilslice]

Thanks for writing this out, @joeblew99 - I agree there should be more examples of code and process as part of the project. I wonder if it makes more sense to provide these in documentation though rather than inside the repository?

I plan on releasing a full site & documentation pages for Ponzu once we hit a 1.0 (hopefully by end of March). This site would have all of the project details, a better Quickstart example, and other examples of projects and how-to's which I think would be a great place for the kind of thing you wrote. It would probably mirror some new repo like github.com/ponzu-cms/docs or github.com/ponzu-cms/examples (or both) so anyone could contribute these ideas.

Do you think that there is significant benefit in putting these kinds of files directly into the project source, versus on an external documentation site?

P.S. I made some minor edits to the script you shared, so in case someone were to see this via Google search or something it was all correct.

[joeblew99]

I would put the setup scripts in the same repo for core examples that show of step by step the techniques.
There is nothing preventing others from making examples too in other repos.
I found it very easy.
I was tempted to make it a proper DSL like goa a bit, but just found it fine for now to make a .sh script.
You could also make it a golang script too.

Yeah i realised later i had a few boo boohs :)

[nilslice]

@joeblew99 - thanks for your patience on this issue.. finally launching my project tonight so the dust has started to settle :)

Check out the latest master branch.. Do you want to go ahead and put your PR together for the examples directory? Within the examples directory, there should be a directory for each "example", but examples shouldn't be full Ponzu projects.. just a few files with a README.md explaining what the example is demonstrating. I will add an example of implementing the api.Externalable interface (which I am planning to rename), and expect that with more major community contributions, an example is part of their PR.

I also added a README.md to the root examples directory so people are aware of what to expect from them... also, a LICENSE file to include the same BSD-3 license so example code can be used as freely as Ponzu core.

Thanks!

[nilslice]

/cc @kkeuning - if you get a moment, would you mind adding an example for api.Updateable like the one I included for api.Externalable into the new examples directory? See the conversation in this thread for some detail.

https://github.com/ponzu-cms/ponzu/tree/master/examples

[nilslice]

~ #97 adds this