Update setup text handling #194
Conversation
There was a problem hiding this comment.
Thanks for doing this! I think it looks good overall, but I would probably simplify to remove the rrp file, and just inline that text, as it is always included.
Keeping the OpenScPCA content in a separate file seems good though.
A couple other little suggestions as well
There was a problem hiding this comment.
I made a few more suggestions about arrangement. But I realized that there will be a fair amount of duplication between the general instructions and the open-scpca specific instructions. Do we want to remove the parts that are duplicated, like WSL and R/RStudio from the OpenScPCA instructions? Or replace them with a reminder that "you should have already..."?
|
|
||
| ### Only staying for "Reproducible Research Practices"? |
There was a problem hiding this comment.
This may be odd for the TOC. Maybe just bold? or I am sure there is someway to exclude it from the TOC
There was a problem hiding this comment.
probably just make it bold allejo/jekyll-toc#3
|
|
||
| <!-- | ||
| If you are only staying for the first half of the workshop and _not_ for the portion about OpenScPCA, you can follow these setup instructions. | ||
| _Otherwise, please proceed to the next section and follow all other instructions._ |
There was a problem hiding this comment.
I think having the "next section" unspecified is probably confusing. Maybe we want ## General software requirements and ## OpenScPCA requirements which you can then refer to directly? Which might mean bumping down all of the headers in the openrrp doc?
sjspielman
changed the base branch from
sjspielman/181-update-wsl-instructions
to
main
I guess I viewed them as totally separate sets of instructions under the assumption that OpenRRP participants wouldn't even follow the RRP-specific instructions in the first place. But, I can rework this so that the OpenRRP section fully complementary to RRP, such that first everyone follows RRP and then optionally one can do the rest of the OpenScPCA installs. This will also lead to reorganization: rather than having a header "only staying for RRP?", we'd end up with "also staying for OpenScPCA? do these things too." |
Co-authored-by: Joshua Shapiro <[email protected]>
That is what I had though we would do at first by substituting the pages entirely rather than trying to do includes. But you left the base RRP instructions there and people will encounter those first, so I would expect a large fraction of people to do them, whether or not they are doing OpenRRP. |
| @@ -112,6 +112,7 @@ natively | |||
| Nextflow | |||
| nonconsensual | |||
| Nüst | |||
| openrrp | |||
There was a problem hiding this comment.
annoyingly this is for the jekyll variable...
|
I think I've gotten these consolidated now, let me know what you think! |
Stacked on #191
Closes #180
Here I'm updating how we handle the setup text (and one small part of the home page) to handle either an RRP or OpenRRP setup. I added a config variable to control that logic, and include either set up of instructions on the setup page. I also decided to set this up such that OpenRRP will show both sets of instructions, to allow for participants who only stay for the first day.