feedback on first read

[MalikaIhle]

Project set up

• [x] ref to FAIR data management workshop should be updated to: https://lmu-osc.github.io/FAIR-Data-Management/
• [x] add one more sentence to describe what renv is used for (especially as it is not covered during the summer school)
• [x] add one sentence to explain what apa quarto is and in which case they need it (will all participants need to use that in the future for their own project? we make them install stuff withou telling the why)
• [x] add a sentence for why they need to install Tex and whether they are likely to use it again in the future
• [ ] there is a bug when I try to hover over Chacon and Straub (2024). -> it moves between the end of line and a new line making it unreadable and unclickable
• [x] note '4' on file path -> I'm not sure how to use it is images\result.png working or do I need to use file.path() somehow?
• [x] please define what linting tools are
• [ ] say more about what quarto use binder does as they never heard of container so far - how is the information that we are trying to record this way retrievable?

Choose a licence

• [x] what does DRM mean in Figure 2? figure 2 is linked prior to this being ever mentioned
• [x] Anti-DRM bullet point: what does DRM stand for?
• [ ] I'm surprised to see MIT licence anywhere while I see it often on software
• [x] you say the flow charts only suggest the most permissive licence - is there any resource in case they do not want to have the most permissive licence?
• [ ] overall quite long, I'm not sure they'll read it all, but I know this topic is complex and we can't simplify it by risk of being incorrect... I need to think if there is a way they for sure read some parts we want them to read. but perhaps this is already done with the choice of boxes and extra figures.

add read me

• [x] typo maybe? 'An overview over the system dependencies of one more multiple R packages'
• [x] explain in one sentence what system dependencies are?
• [x] 'We put all the information obtained about system dependencies and their versions in the README. Sharing the install scripts that were provided by pak is an additional courtesy to your readers.' -> how should this be done so this information is usable easily by others? do you have an example read me somewhere for a regular research project with data analysis and quarto file? perhaps point to your about section that looks like it??
• [x] 'We will cover the archival using the Software Heritage archive and Zenodo.' I suppose this section is still missing.

deployment

• [x] ask @NeuroShepherd to deploy via github action as quarto website and check if formatting still correct everywhere
• [x] ask @NeuroShepherd to add branding (OSC logo, favicon, green top band) through his github action

About

• [x] add 'This work was partly funded by the Berkeley Initiative for Transparency in the Social Sciences (BITSS), managed by the Center for Effective Global Action (CEGA)' ad their logo: https://i0.wp.com/www.bitss.org/wp-content/uploads/2015/10/bitss_logo_footer.png?ssl=1

[MalikaIhle]

I suppose the read me file of this repo should also be revised?

[MalikaIhle]

can you also add an edit this page and report an issue button like we have on others? I think @NeuroShepherd could also do that

[NeuroShepherd]

I can take care of most of the edits to the yaml file

[fkohrt]

@MalikaIhle

note '4' on file path -> I'm not sure how to use it is images\result.png working or do I need to use file.path() somehow?

I have dropped that note, as I believe it is not that important.

you say the flow charts only suggest the most permissive licence - is there any resource in case they do not want to have the most permissive licence?

The advanced flowcharts provide more restrictive (i.e., copyleft) choices, and I have changed the text to explicitly say so.

[fkohrt]

add a sentence for why they need to install Tex and whether they are likely to use it again in the future

I have written the following now:

Also, you need to have a $\TeX$ distribution installed on your computer, which is used in the background to typeset PDF documents.

What do you think can I say about whether they are likely to use it again in the future?

[fkohrt]

there is a bug when I try to hover over Chacon and Straub (2024). -> it moves between the end of line and a new line making it unreadable and unclickable

Unfortunately, I cannot reproduce it. But I guess this should be raised at Quarto's repository anyways.

[fkohrt]

overall quite long, I'm not sure they'll read it all, but I know this topic is complex and we can't simplify it by risk of being incorrect... I need to think if there is a way they for sure read some parts we want them to read. but perhaps this is already done with the choice of boxes and extra figures.

I think I addressed this as part of #13