cage icon indicating copy to clipboard operation
cage copied to clipboard

canonical examples are pathological

Open seamusabshere opened this issue 8 years ago • 4 comments

all the pretty tree views in the docs only show 1 service - frontend

it would be illuminating to

  1. have a few more
  2. have names that indicate they are specific to your project and not canonical - "alice", "bob" instead of "frontend"
  3. have a couple canonically named placeholders - postgres (or db), redis

seamusabshere avatar Oct 24 '16 14:10 seamusabshere

We could add more complicated examples in the docs. We have a full set of examples in the examples folder, for example, showing off many variations of how to use cage.

But I'd like to keep the output of cage new as simple as possible, and focusing on getting people to run cage new foo; cd foo; cage up --init as soon as possible. Thoughts?

emk avatar Oct 24 '16 15:10 emk

Does Rails pretty much assume a Redis server by default these days, for example? If so, we could rename db to placeholders and add a redis pod.

Many cage projects will be small, in the real world, at least at first.

emk avatar Oct 24 '16 15:10 emk

err... rename db to placeholders?

i would say the minimum rails app these days is:

  • rails app
  • db (probably postgres)
  • cache (probably redis, maybe memcached)

seamusabshere avatar Oct 24 '16 16:10 seamusabshere

If we're going to provide both db and redis in the default code skeleton, then we should place them both in a single file named pods/placeholders.yml or something like that, instead of making more single-server pods, or putting redis in db.

emk avatar Oct 24 '16 17:10 emk