Fall 2024 Cheatsheets Final Presentation and Poster

[beydlern]

The cheatsheets for our group that encompasses the relevant tasks of our M1 and M2 and Dao's M3.

[carlosparadis]

@beydlern For folder organization you will want to use the diagram that Mark did. What you used is generally used for the project configuration file. The inconsistency will confuse people. You want to use a smaller version of that (borrow from the previous template) to showcase how jira and mbox can have project keys. It doesn't need comprehensive. Cheatsheets here are to pass the concept, not be documentation because it would get outdated.

Refactoring session should be something like "Accessing Project Configs". Refactoring is what anyone does when they change code to improve its quality without changing functionality. That applies to anything, so not descriptive of the section.

Rather than call the other section OpenHub, which not many people will know what it is, you can say something along the lines of "Selecting Projects" , and then mention OpenHub API in the text below. Again, go for what anyone can understand from the section, and why they would read it, which is the purpose of the functionality in general.

Config Ties to Execs -> Change to something like Using Kaiaulu from CLI and in the text below motivate the execs give parts of the most commonly used features without needing to know R. Remember configs are required for exec scripts.

I guess Parallelization is fine as a section name.

Take another pass, add some more, and we iterate again. We want to iterate as many times possible. These can take time.

[beydlern]

@carlosparadis
I discussed with the group and we incorporated your suggestions. Formatting, choice of wording, and coloring is tentative. What type of color scheme did you want for the cheatsheets (we looked at the previous cheatsheets, but weren't able to determine a consistent color scheme, e.g. functions and files)?

[carlosparadis]

You can just use one of the cheatsheets that have color and replicate them.

[carlosparadis]

@beydlern i thought we agreed last meeting the title would not be modular parallelization but rather something of the effect "Analyzing a Project"?

Could you place the current ppt on a docs and send me over email so I can edit? You should still make the edits offline that i make there just to make sure it doesnt break format from google sheets to ppt

[carlosparadis]

Will also note that starting with "the modular parallelization tool" would not make sense: The tool is Kaiaulu, the cheatsheet is to explain some of the features and how things are done. This makes it sound like you worked on a third party tool to interface with Kaiaulu.

[beydlern]

@carlosparadis
The presentation has been shared on google slides.

[carlosparadis]

Thanks @beydlern. What happened to the other cheat sheet? Is it ready for revision?

[beydlern]

@carlosparadis
I'm assuming you're referencing Dao's M3 cheat sheet? I'll get back to you on this ASAP when it is shared with me.

[carlosparadis]

@beydlern yes that's what I was wondering about. Would be nice to do the same thing I just did with you still today on her changes. Also, I am done with the review pass. See my comment on the title for details.

Did anyone start on the poster yet? I know the poster has a more rigid template so I am less worried, but i'd still like to make sure Kaiaulu parts are portrayed properly.

p.s.: minor reminder that when you generate the PDF for your poster, you want to make sure you didn't forget any red lining from microsoft word appearing on them. It is a pesky detail that sometimes you only find out when it is too late (already printed).

[carlosparadis]

red lining* i actually meant microsoft power point: You know, grammar errors or words it does not know about.

[carlosparadis]

One final note: please remember to edit the file name according to project-analysis rather than the modular parallelization part.

[carlosparadis]

Noticed one more thing: Exec section on the upper right: Add some label to the empty folder that appears as output. Maybe "Analysis Output"?

[beydlern]

@carlosparadis
An email with the link to the current, work in progress, poster will be sent to you shortly. I'll take into account the "squiggly lines" for grammar and spelling to not appear in our PDF and PNG versions for the cheat sheets.

[beydlern]

@carlosparadis
Here is the most recent group cheat sheet version with all of the revisions you asked for along with a PDF version.

[carlosparadis]

@beydlern thanks

1. the alignment of the Getting Started section needs to be fixed (pushed to the left). Right click the text, select format and look at the exact x position it is versus the Folder Organization section, and match it accordingly. Do the same for the middle and right column of the cheatsheet so you can sure they are precisely aligned.

I am finding a bit weird Command Line Interface is out of alignment with the other sections too. Was that the case in previous cheatsheets? Would be nice if they were all aligned horizontally (Getting Started, Accessing Configs from Notebooks, Command Line Interface). Try to stay consistent to the older ones.

implementation needs to be updated, instead of all the dependent Notebooks

replace with:

implementation needs to be updated, instead of all the dependent Notebooks and Exec Scripts.

(color Exec Scripts)

openhub_project_search.Rmd is a Notebook that interfaces
with OpenHub API to facilitate locating open-source projects
for studies

replace with

openhub_project_search.Rmd is a Notebook that showcases how Kaiaulu interfaces with OpenHub API to facilitate locating open-source projects for studies

(the clarification here is that the Notebook is not the all encompassing code, but rather explains how the tool does that hence the word showcase)

3. Respect column borders

Try to reduce the size of the bottom left image and the paralellization diagram (bottom right) to try to respect the borders. Try to go to the limit you think is readable, just to give a bit more space between the columns.

[beydlern]

@carlosparadis
Your requested changes were implemented in this commit.