-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
adding skeleton for showcase #627
Conversation
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Co-authored-by: Mark Carroll <carrollmt@ornl.gov>
I like the idea of this, but the contents of the boxes seem very confusing - there's too little info in each to understand what they are. None of these three things are obvious to me I'm not sure what would be better. Maybe some structured fields? What the work is (a sentence or two), what it's about, where it was published/shared, when it was published/shared, an optional image? It looks like most of this is in showcase.yaml, so I guess the challenge is how to display it. I don't have a good idea how to display this info in a compact way. The right column in https://fair4hep.github.io maybe is closer to what I'm thinking that what the PR has now. Finally, how would this info be added? PRs to the yaml? a form that generates a PR? And do we need to add any instructions for how to do this for future submitters? |
yeah I saw that too - it's a limit of the library (and I couldn't find another one) that grabs metadata for each. It is based on the metadata provided at the page, akin to how links expand for Twitter, Slack, etc. |
I wonder if there are other libraries that could be used instead? |
@danielskatz that just looks like a blog feed, and where the post has some main image specified. We could do that - it's much more work to need to specify the image, but it would be more solid than this discovery approach. If the showcase is just akin to a blog feed we already have that on the site, and really would just add another category for showcase and then have a page to show it. |
Please give a look! I couldn't find one beyond microlink.js. Also - they have docs that you can tweak the metadata via data fields (and I found this didn't work in practice). |
that page is generated by https://github.com/FAIR4HEP/fair4hep.github.io - in case it helps (though it's probably nothing you don't already know) |
The news sidebar is literally just a data file it loops over: https://github.com/FAIR4HEP/fair4hep.github.io/blob/main/_includes/news.html and the headline is hardcoded html in that file for the title and image. https://github.com/FAIR4HEP/fair4hep.github.io/blob/main/_data/news.yml. It's the simplest approach possible, but kind of messy? Minimally if we just copied that we would break the link / image into fields so contributors wouldn't need to write html. I also don't think the single news feed hardcoded like that is enough - we'd want to have searchable tags / an archive, etc. That's just a news feed. |
I knew that would be embarrassing to share ... |
haha sorry I didn't mean to be so harsh. Simple is powerful @danielskatz and sometimes really the best solution! |
y'all for next steps lets be on the lookout for "showcase" interfaces that we like - if you find one please share it here! |
Heyo website group! Here is a skeleton for the showcase - including a main page with link previews and an archive, both under a common menu. I suspect further functionality is wanted (e.g., sort/arrange by tags) so I will open this and leave in your capable hands! cc @danielskatz @mrmundt
Signed-off-by: vsoch vsoch@users.noreply.github.com
Description
Motivation and Context
Checklist:
cc @usrse-maintainers