pyOpenSci / pyopensci.github.io

This is the website for pyOpenSci. Contributions welcome!!
https://www.pyopensci.org
Other
36 stars 61 forks source link

Blog post package category #439

Open eliotwrobson opened 1 month ago

eliotwrobson commented 1 month ago

Seems like we should have a specific category for blog posts like this that are about reviewed packages, right?

Might be nice to add something like a peer-reviewed or pyopensci-package or something to the categories list in the frontmatter, and it also might be nice to have a separate key like

packages:
- automata
- another_pkg

To list the packages that a given blog post mentions, so that in the future we might be able to do stuff like automatically add backlinks to review issues, and more generally index when we write about different packages (even if we dont have the stuff in place for that right now)

Originally posted by @sneakers-the-rat in https://github.com/pyOpenSci/pyopensci.github.io/issues/433#issuecomment-2209666483

lwasser commented 1 month ago

This is a really good idea @eliotwrobson ✨ thank you! i wonder if we want to think about the following structure:

  1. We can add a category that is something like "reviewed-package" or "pyos-accepted"? that would allow a user to filter by the category of "blog posts about packages accepted by pyos).

  2. We could also either add package specific front-matter like you suggest but perhaps add the package name as a tag which tends to have a looser ontology?
    We could then use that for in the future - to link to the review, package stats (which is in our future plans), and related blog posts. We already have this package yaml that is CIgenerated file.

Summary

category:
  - accepted-package
tag:
   - automata #(package name here)

Then we can automate creating a new page for each package from the packages.yml file. This page can contain links to things related to that package.

thoughts?

sneakers-the-rat commented 1 month ago

looking at the blog, it seems like category is basically used as tag, right?

edit: oops premature send.

eg. at the bottom of this post I see categories listed (though they aren't clickable, we can fix that too!) but not tags.

The reason to use a separate key like packages is to be able to tell the packages apart from other tags, like in this case one might want to use the tags automata, cellular automata, turing machine, pushdown automata and so on, but then one couldn't tell if another package was about the concept of automata vs. the package automata. Don't worry, not asking to implement a general semweb triple system here, just this one special key because we are talking about a set of blog posts, many of whom will be about python packages :)

edit2: another thing is that ppl might not think to put the other packages they are writing about in the tags since that's not usually what goes in tags, by having a specific packages key that is a sign to list any packages mentioned :)

lwasser commented 1 month ago

ok - im convinced. So a packages: key would be very specific and allow us to tag posts that relate to specific packages in our ecosystem

categories in theory is for the types of post like

"blog post", event, etc

tags can be more general. - @sneakers-the-rat is that what you are suggesting above? i do see the category element in our blog posts as high level categories. we may not have been using them consistently enough that way which is because i haven't created an ontology for the site yet but i hope to use the categories section to be able to clearly separate types of posts (events from blog posts from ....)

in that case pyos-accepted would be a tag?

sneakers-the-rat commented 1 month ago

I think the categories v tags distinction is up to u :) I def see the difference and can also implement tag and category browsing pages bc Jekyll is good with that.