search

astropy / learn-astropy-librarian

The content crawler that supplies Learn Astropy's web search.
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

Sort tutorial keywords into types with a keyword vocabulary #5

Closed jonathansick closed 3 years ago

jonathansick commented 4 years ago

In our search interface, we want to have separate filters for different types of keywords: Astropy package, Python package, science, and task. However, in our source documents we don't separate these keywords; they're all listed together. The purpose of this PR is to add a way to classify keywords into one of the four types.

To do this, we have a YAML document that's part of learn-astropy-librarian, at astropylibrarian/data/keywords.yaml. For us to recognize a keyword, it needs to be listed in this file. The alternative would be to change our metadata format inside to tutorials to provide this classification; which would be a more decentralized approach. This, on the other hand, centralizes keyword curation which might actually be a good thing.

jonathansick commented 3 years ago

I'm assigning this to you again @adrn . LIke #4 it's an old PR I'd like to get merged for new development. This one needs to be merged after #5 (I can rebase) since it builds on commits from that PR.

adrn commented 3 years ago

Ok, ready for rebase!

jonathansick commented 3 years ago

Thanks @adrn, this one is ready to go now too.