Standardize pipelines README files post-RFC-927

lsst · May 31, 2023 · eff50fa · eff50fa
1 parent 54405ca
commit eff50fa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/pipelines/README.md b/pipelines/README.md
@@ -1,12 +1,12 @@
 # Pipeline Definitions
 
 This directory contains pipeline definition YAML files which are used when processing data with the LSST Science Pipelines.
-The pipelines defined here are science ready and come in two flavors: generic (top-level) and camera-specific (within sub-directories).
-Use of camera-specific pipelines is encouraged where possible as they are optimized for the particular characteristics of that camera.
 
-The pipelines defined here tend to import other pipelines, including ingredient pipelines in the [\_ingredients](_ingredients) directory.
-To expand a pipeline YAML and resolve such imports for the purposes of visualizing it, the `pipetask build` command can be used.
-For example, to visualize the step 1 subset of the [LATISS DRP pipeline](https://github.com/lsst/drp_pipe/blob/main/pipelines/LATISS/DRP.yaml) pipeline, run:
+The pipelines defined here come in three flavors: camera-specific (within named directories), camera-agnostic (top-level, if any), and building-block ingredients (within the [\_ingredients](_ingredients) directory).
+Pipelines within the ingredients directory are meant to be imported by other pipelines, and are not intended to be used directly by end-users.
+
+The `pipetask build` command can be used to expand a pipeline YAML and resolve any imports for the purposes of visualizing it.
+For example, to visualize the `step1` subset from the [LATISS DRP pipeline](https://github.com/lsst/drp_pipe/blob/main/pipelines/LATISS/DRP.yaml) pipeline, run:
 
 ```bash
 pipetask build \

diff --git a/pipelines/_ingredients/README.md b/pipelines/_ingredients/README.md
@@ -1,7 +1,8 @@
 # Pipeline Definition Ingredients
 
 This directory contains ingredient pipeline definition YAML files.
+
 The pipelines defined here are intended to be used as building blocks for more complex pipelines.
 As such, they are not intended to be used directly by end-users for science purposes.
 
-Science ready pipeline definitions are located in the [pipelines](..) directory.
+User-facing pipeline definitions are located in the [pipelines](..) directory.