New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DM-39205: Add READMEs for ingredients and pipelines dirs #65
Conversation
5c48cfd
to
c4b7ece
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, Lee! Only minor comment would be for you to consider whether you want to give a concrete example that can be copied from the README and run, or whether you want to have a generic PATH/TO/MY/PIPELINE
path here.
Happy to put in a concrete pipeline YAML if you think it would improve the legibility here. My concern with doing so is that it may go out of sync with future stack versions if the example we choose is moved, but keen to hear your thoughts. I also don't know the best example to choose, so recommendations welcome. |
I thought about the possibility of it going out of sync, but by phrasing it as an example, we could perhaps hope that the reader would generalize it to a different path. The example I'd go for is |
My only concern with If you really do want a specific pipeline YAML here in this example, my feeling is that we need something a little more complex (i.e., containing imports) but not too complex. RC2_SUBSET would be nice as it's a tutorial pipeline. However, that pipeline suffers from the fact that it's the only pipeline that can't be built in its entirety without raising an error (two subsets output the same dataset type), which may lead to some additional confusion. If I had to choose, I'd perhaps go for pipelines/LATISS/DRP.yaml#step1. It's a relatively simple pipeline, not too many input dataset types (an important consideration if users are building pipeline graph PDFs for visualization purposes), and is likely to remain in this location for the foreseeable future. |
Your suggestion seems fine to me! |
Also, feel free to completely ignore this and go ahead with as it is currently. |
While you are at it, could you add a commit that updates the COPYRIGHT year to say 2021-2023 please? |
c4b7ece
to
ed4288d
Compare
No description provided.