Fix Version/s: None
Component/s: Stack Documentation and UX
This ticket follows
DM-10637, the addition of a Getting Started tutorial series based on DMTN-023, and is a means for reviewing that work before it is merged.
Draft content root: https://pipelines.lsst.io/v/DM-11391/getting-started/index.html
This looks great. I've put many comments on the PR...feel free to ignore the purely stylistic ones as you see fit. I do wonder about the plan the various "FIXME"s as some of them do seem like show-stoppers.
Thanks for your comments Lauren MacArthur. I think one of the big sticking points is the Butler repo setup.
Regarding the FIXMEs, I'm starting to wonder if, for the sake of a "Getting started" tutorial. if it might be better to provide the reader with a ready-to-go Butler repo (everything is pre-ingested) so that we can avoid a bunch of these issues? Of course, we'll have to provide another tutorial on repo setup and provide Butler documentation in general, but setting up a repo might be too advanced for an initial encounter with the stack (this tutorial series doesn't have to be everything for everyone).
If the user doesn't know how to set up a proper repo following this tutorial, you had better remove your final comment;
By now you’re ready to start experimenting with the LSST Science Pipelines for your own projects.
DM-12450 and DM-12531 (implementing RFC-407 and RFC-409) involve a pretty major behavioral change in how command-line tasks behave w.r.t. existing data products and existing configuration/schemas/versions. I've updated DMTN-023 accordingly (on tickets/ DM-12531), but didn't actually see the old behavior described here at all - I think that just means it was out of scope for this document, and will be worked into some other new long-term home on another ticket. Please let me know if that's incorrect.
Thanks for the very helpful comments Lauren MacArthur!
Here's the new review ticket for the Getting Started tutorial series. Thanks Lauren MacArthur!