softwaresaved/cw-ideas

Originally a hack day project from CW21 on collating and analysing collaborative ideas and hack day projects from previous Collaborations Workshops. Contact @marioa

Exploring previous Collaborations Workshop ideas (CW-ideas)

This is a fork of a repo originally produced for a hack day project at the 2021 Collaborations Workshop. The website presents the collaborative ideas and hackday pitches generated at previous Collaborations Workshops and makes them available through an easily browseable and searchable interface.

A live version of the website is hosted at:

• https://softwaresaved.github.io/CW-ideas/.

This repo consists of markdown versions of previous collaborative ideas and hackday pitches, plus the code to host a website to view them using.

To contribute to the repository - either by adding new ideas from previous CWs or to the code to view these ideas - please see the contributing guide.

This repository is licensed under the MIT license, and most of the ideas themselves are CC-BY (explicitly since CW21 - licensing is mentioned in each idea).

The team that created this was: Mario Antonioletti, Heather Turner and Robin Wilson.

Building locally

The repository is automatically built and deployed on every push using GitHub actions, but if you want to build locally for testing or debugging purposes, follow the instructions below:

1. Install Hugo.
2. In the root of the repo, run

   $ hugo server

3. The site will be built, and served on localhost - see the command-line output for the full URL.

Task split during the hack day

• Heather Turner: The brains behind the original idea.
• Robin Wilson: The technical guru.
• Mario Antonioletti: The plodder with superpowers.

Tasks divided orthogonally

• Conversion of past google doc proposals to markdown (Mario and Robin)
• Configuring and setting up Hugo (Robin and Heather)
• Provisioning a GitHub repo (Robin)

Hack day presentation

Available here.

ToDo

• Implementation of ordering: hack-day > hack-ideas > collaborative-ideas in by_type.html and by_year.html at themes/PaperMod/layouts/_default could be done much more elegantly - it's a bit of a hack just now.

cw-ideas's Issues

Team photos and personal information

Need to review whether any personal content should be removed from a public resource. CW21 should be ok by CC-BY licensing but prior workshops may not. Regardless, people may still not want their personal information made public. For example:

• Group pics
• email addresses

Enumerate other missing hack day pitches (and other missing content)

Mark ideas that were taken forward to a hack day

Include extra information about ideas that were fully or partially implemented

From robintw:

For example: draft papers, policy outputs, Github repos etc.

From marioa:

Again, we could include another bit of metadata that points to a repo if they used this.

Warning in the build process

Getting a warning in the build process - need to determine where this is coming from and fix it.

Should we allow attendees to modify and improve their ideas after a workshop?

Suggest changes link leads to a 404

Investigate adding embedded videos of pitches where they exist

Look at the SSI you tube channel:

• https://www.youtube.com/@SoftwareSaved

Licensing of CWs prior to CW21

CW21 explicitly has CC-BY licences but CWs prior to CW do not appear to have an explicit licence. Not sure if ideas might have been implicitly licenced by some attendance agreement.

Change the display order of ideas

Use:

• hack-day
• hack-ideas
• collaborative-ideas

Add missing content from previous CWs

Licensing on README.md not quite correct.

In the README.md it states:

This repository is licensed under the MIT license, and all the ideas themselves are CC-BY (this is mentioned at the bottom of each idea).

This is true for CW21 but may not be true for prior CWs.

Add CW18 hack day pitches

Location:

• https://drive.google.com/drive/u/0/folders/19mVuMBJnOgO8VSP0_YtW6jAfWdRBbB0a

These are in pdf format so will have to go from pdf -> md.

Improve the metadata

Better tags - hand-curated (e.g. adventure based learning - gamification, starting-a-project, bot).

Viewing the images in the markdown

The images point to ../images but they actually live in ../static/images so if someone is viewing just the markdown it will appear as though as all the images are broken - is there a way to link ../images to ../static/images?

Categorise by year and type

Mark ideas that won the hack day

Raw html table not rendering

Doc to markdown renders a table in HTML but this is not displaying in GitHub for:

• https://softwaresaved.github.io/CW-ideas/cw20-storyboarding-sustainability-hack/

Identify prize winners of CW ideas/hacks

Use:

• https://www.software.ac.uk/programmes-and-events/collaborations-workshops

Add more ideas from previous CWs

CW Collaborative and hack ideas

• CW22 Hack day ideas
• CW22 Collaborative ideas
• CW21 Hack day ideas
• CW21 Collaborative ideas
• CW20 Hack day ideas
• CW20 Collaborative day ideas
• CW19 Hack day ideas
• CW19 Collaborative day ideas
• CW18 Hack ideas
• CW18 Collaborative ideas

In some cases a (*) is used to indicate that a title was not provided so one was created.

CW22 Hack ideas

• Developing scenarios to help nurture Inclusive Research Leaders
• Code Review Cupid
• RESPIRATOR (Research Software Performance Indicators Really Acknowledging The Objective Reality)
• Carpentries-style Lesson on R’s Bug Tracking Process
• iFortran Linter
• CFF in the wild - analysing software citation metadata file usage

CW22 Collaborative ideas

• Easy Open Source Bio-Graphs
• Interdisciplinary Glossary of Glossaries
• Squashing conceptual bugs when computational bugs have been exterminated
• Interdisciplinary Researchers ‘R’ Us
• Weather Log
• Key Performance Indicators for Research Software Engineering Output
• Path to Open Platforms - new chapter for the Turing Way
• The Code Review Cupid - a matchmaking service for connecting coders
• Hi-Brid!
• Choose your own research-software adventure

CW21 hack day ideas

• HowDescribedIs
• Escape room: Translating between RSEs and Arts & Humanities Researchers
• Tools to recognise underlying software infrastructure visible and funded
• Credit All
• Running a dugnad in a research group
• Exploratory analysis of past Collaborative Ideas
• Hello world (of CI/CD)
• Coding Confessions
• Using Raspberry Pis to deliver Carpentries training in remote locations
• Enabling analysis of research software: Creating an enhanced research software corpus

CW21 collaborative ideas

• Macavity
• DEPTH: Developer error/problem treasure hunt!
• User centred design principles for research apps / citizen science
• Koko
• Software citation videos (to understand why and how to make your software citable)
• Improving data visualization literacy
• End of Life Plans for Software
• Leo
• How to encourage and ensure software maintenance gets sufficiently funded
• Bursting the Bubble: Teaching PIs the value of good code
• Open Source Covid Analysis of References (OSCAR)

CW20 Hack ideas

• How Wrong Is The Research Code Base?
• How do we facilitate effective collaboration in a virtual event (*)
• Let’s make some better manuscript templates for the Journal of Open Research Software
• Ticket to Data Wall Garden
• Equitable Collaboration guide for distributed/online teams and communities in The Turing
• Storyboarding Sustainability

CW20 collaborative ideas

• Adding Behaviour Driven Development to Exploratory Research Notebooks
• Conferencing 3.0: ensuring equality for in-person and online participants
• Online Community Cookie Cutter c³
• Does grade inflation exist?
• Dealing with Legacy Code
• Message in e-Bottle: work more effectively with ephemeral teams across timezones
• RSE2_D2
• State of the Art
• Storyboarding Sustainability
• The Turing Way

CW19 Collaborative (and hack?) ideas

• A "Cite this" button for GitHub Hackday Pitch Stephan Druskat
• Terminal History Sharing Hackday Pitch Jason Gates
• Automating Screenshots for Documentation Hackday Pitch Colin Sauze
• GitHub annotator/failure map Hackday Pitch Ilektra Christidi
• Software reporting guidelines Hackday Pitch Alexander Konovalov
• Creating a Lessons Roadmap and Proficiency Framework for Software and Data Training Hackday Pitch Neil Chue Hong
• Slack overflow: getting permanent docs from instant messaging Hackday Pitch ben krikler
• R2D?.. (Ready to Deposit?) Hackday Pitch Patrick McCann
• Improving The Turing Way Hackday Pitch Kirstie Whitaker
• Netflix of libraries Hackday Pitch ben Krikler
• Code-literate peer-review for everyone Hackday Pitch Alessandro Felder
• Maintainable Tutorials Made Quickly Hackday Pitch Adam Jackson
• Is your online training material accessible? Hackday Pitch David Perez-Suarez
• Checklists for open reproducible research Hackday Pitch Anna Krystalli
• Hover Eels Hackday Pitch Niall Beard
• Col-Laboratory Hackday Pitch Niall Beard
• DUQI (Documentation Utility & Quality Interrogator) Hackday Pitch Rebecca J Arnold
• CarpenTREE
• Reproducibility and Collaboration Challenges in interactive / exploratory research (*)
• RSE Careers (*)
• Infrastructure to support following up after a workshop/training session (*)
• Best Practice Checklist (*)
• Identify new roles within Academia (*)
• The Research Data Sandbox
• What is my contribution? (*)
• DUQI (Document Utility and Quality Interrogator) - proposal
• How to map out software and data skills lessons like Duolingo - proposal
• How do you motivate researchers to adopt better software practices?
• Interoperability & Continuous Integration
• Libflix (*)
• The Doctor button

The above has not been properly designated - some are hack ideas while others are collaborative ideas.

CW18 Hack-ideas:

• Aligning the Citation File Format and CodeMeta
• Automated Network Map construction
• Carpentries platform to support translations
• Choose-a-Visualisation
• Code is Science Manifesto
• Geospatial metadata sharing
• Keeping up with the Joneses: Providing evidence for software and data citations in published papers
• Productivity Approximator

CW18 collaborative ideas

• Guidelines for research library users and providers
• ASAP - Automated Software-Assisted Provisioning
• SCAT (STEM Career Advising Tool)
• Sustainability Deniers
• Teaching programming to researchers across all research domains
• Keeping up with the Joneses: Providing evidence for software and data citations in published papers
• Code review across projects for software sustainability
• AutoSoftCat
• Crediting Super Awesome Documentation to get Research Software Certification
• Translating between programming languages (*)
• How to manage expectations while juggling different projects with overlapping deadlines and competing resources?
• Downloading and filtering datasets (*)
• Streamlining JupyterLab as a teaching tool