AlexsLemonade / reproducible-research

Repository for Reproducible Research Practices Training Workshop
Other
1 stars 2 forks source link

Update setup text handling #194

Closed sjspielman closed 4 days ago

sjspielman commented 6 days ago

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.

sjspielman commented 5 days ago

But I realized that there will be a fair amount of duplication between the general instructions and the open-scpca specific instructions.

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."

jashapiro commented 5 days ago

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."

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.

sjspielman commented 5 days ago

I think I've gotten these consolidated now, let me know what you think!