openjournals / jose

The tracking repository for the Journal of Open Source Education

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Discoverability and Keywords

kelle opened this issue · comments

Hey Everybody,

@labarba just told me about this awesome new effort! It's the kind of thing which I've seen attempt to be implemented at many a hack day and I'm very optimistic about this path forward! One thing which I am interested in helping with is the discoverability of content. I think this comes basically down to keywords and indexing. I see this on to-do list in openjournals/jose-old#5 and just wanted to raise my hand as a volunteer for that one. 🙋🏻

I've been thinking about this in the context of astronomy education and am in the very early stages of trying to implement for the Astropy Tutorials. (Indeed, we're going to propose a Google Summer of Code project for this.)

My vision for the end goal is to allow a user to find all content that's been made in conjunction with a particular textbook. Or, they may be looking for all the possible matplotlib lessons, regardless of topic/science domain. OR, they may be looking for all the data viz workbooks for astronomy regardless of programming language or plotting package.

I've been using this Google sheet to start organizing and adding keywords for the existing Astropy Tutorials just to map out what I think is needed and wrap my head around the issues:
https://docs.google.com/spreadsheets/d/1JmOF82Zmrs397wLwAmmL1rgDSsvP6Z4fLMr0hV5ZIb4/edit#gid=1773165275

Based on me working on this with the Astropy Tutorials, I see a need for keywords falling into four categories: "packages", "learning goals", "topic/domain", and "companion content". These are not the best names but are just placeholders as this gets hashed out.

For example, if a lesson focused on making a heat map of stellar density in the Milky Way using Python, the keywords would be something like:
Packages: python, matplotlib
Learning Goals: data visualization, binning
Topic: Astronomy
Companion Content: [some Textbook name and chapter number], [another Textbook and chapter]

And then we'll need a way to generate indexes and a way to search and drill down for content. I have no idea how to implement this! But my vision for how I think it should work is pretty clear.

Hi @kelle, thanks for volunteering!

We have definitely talked about the importance of discoverability at JOSE, and definitely appreciate your thoughts. We are getting closer and closer to accepting submissions, so even if we don't have all the technology in place, it would be good to figure out from the start what sorts of tags/keywords we want to use.