search

gocd / docs.go.cd

GoCD user documentation
https://docs.gocd.org
Apache License 2.0
41 stars 137 forks source link

"config" repos vs. material repos #74

Open jblaine opened 7 years ago

jblaine commented 7 years ago

As a newcomer to GoCD, acting in a sysadmin/operations role, I was reading about how it implements its pipeline configuration from code. The official documentation kept showing, but not explaining why, a separate "configs only" git repository was being used for the "config" repo (that is, separate from the "material" repo). I was nearly completely turned off on GoCD by the usage of separate "config" repos appearing to be a hard requirement, as no other option was pointed out as possible.

The following enormous closed Github issue is the first place I ever saw it mentioned that using the material repository as the "config" repo was possible (or at least it is part of the detailed proposal..): https://github.com/gocd/gocd/issues/1133

I think the documentation would benefit from spelling this out more clearly, perhaps indicating what the pros and cons of "config repo" vs. "config in material repo" are.

I'm not qualified on the topic for a PR submission.

arvindsv commented 7 years ago

@jblaine So, are you saying that this documentation needs to explicitly call out that the config repo material can be the same as a "normal" material, which has some source code in it?