Documentation distinguishing between .yml file pairs (file and file_config)

[OliviaLynn]

It would be nice if [the documentation] also explained the roles of the two .yml files with nearly the same name (and/or renamed one to disambiguate).

(from LSSTDESC/rail#15 (comment))

Putting this suggestion here, as I expect this to apply to pipelines in general (assuming they will all take on the pipeline.yml and pipeline_config.yml pattern).

[aimalz]

I think this would be resolved by the convention of *_pipe.yml to mirror *_config.yml (and just discovered a note to self to do this for the Golden Spike anyway).

[eacharles]

This comes from ceci, we should probably follow their conventions.On Aug 1, 2023, at 6:21 PM, Alex Malz ***@***.***> wrote: I think this would be resolved by the convention of *_pipe.yml to mirror *_config.yml (and just discovered a note to self to do this for the Golden Spike anyway). —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[joezuntz]

ceci takes these two files, but they can be called anything you like. I tend to call them pipeline.yml and config.yml though I know the latter in particular is not very descriptive. You could call it something else if you prefer.

There is documentation on the meaning of these two here:

https://ceci.readthedocs.io/en/latest/config.html#pipeline-yaml-files
https://ceci.readthedocs.io/en/latest/config2.html#config2