Making the Rails starter kit work out of the box

[rudyrigot]

At the moment, the RoR starter kit doesn't work out of the box, because prismic.yml.sample first needs to be renamed into prismic.yml. It makes a lot of sense to make sure people change the configuration of their API endpoint, but that's not the way we documented the starter kits to work, notably in our "Getting started" video.

What we say in the video and documentation is that the starter kits all work out-of-the-box, but use the "Les Bonnes Choses" API, which needs changing.

To make sure people would know how to do this, I updated the README of the starter kit as well.

Let me know if I did right, or if we need to change the documentation.

[dohzya]

This change makes the projet work out-of-the-box but will be really annoying for anyone who want to update its own project using the sample. This may not be a problem if we consider the sample as a scaffold only (start with it then change it yourself). An other solution could be to have 2 branches: 1 (develop?) for the generic modifications and 1 (master) for the out-of-the-box stuff. But it may be overkill to do this workflow just for a simple configuration file…

Conclusion: I don't know, pick the approach you prefer :-) don't hesitate to merge the PR if you choose the scaffolding).

[rudyrigot]

Two branches kinda sounds overkill indeed. Another road: having a prismic.yml committed with the configuration pointing on LesBonnesChoses, but have it in gitignore anyway? That way, people retrieve it the first time, but the subsequent updates would go smoothly. What do you think about that?

[guillaumebort]

Starter projects should be considered as pure scaffolding. They should work out of the box with the LBC official repository.

[guillaumebort]

So I merge it.

[dohzya]

Ok @guillaumebort this way is perfectly clear :-) @rudyrigot FYI ignoring a file only avoid to version it in Git; ignoring an already versioned file has no incidence at all :-)