Skip to content
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

Create "project showcase" template #830

Open
tdjames1 opened this issue Oct 23, 2024 · 23 comments
Open

Create "project showcase" template #830

tdjames1 opened this issue Oct 23, 2024 · 23 comments
Labels
enhancement New feature or request

Comments

@tdjames1
Copy link
Contributor

tdjames1 commented Oct 23, 2024

Should/could include:

  • Project title
  • Pretty picture
  • Keywords (topics/technologies)
  • Group/academic unit
  • Quote from PI
  • Short summary
  • Longer description (for display on click through)
  • Link to software
  • Link to publication
  • Link to project grant/funding award

Any other details?

@tdjames1 tdjames1 added the enhancement New feature or request label Oct 23, 2024
@ns-rse
Copy link
Contributor

ns-rse commented Oct 23, 2024

Would a section for linking the project grant/funding award be overkill?

@ubdbra001
Copy link
Member

Would a section for linking the project grant/funding award be overkill?

Don't think so, potentially helps researchers who would be interested in including an RSE get an idea of where they can find money to do so

@EdwinB12
Copy link
Member

Good idea Neil, think that can help rationalise the process for an academic

@EdwinB12
Copy link
Member

@tdjames1 - Should we add something like "Picture"? Think we should try to encourage a photo for the project to make it look pretty (although not all projects lend themelves to picture I guess)

@ptheywood
Copy link
Member

@tdjames1 - Should we add something like "Picture"? Think we should try to encourage a photo for the project to make it look pretty (although not all projects lend themelves to picture I guess)

It's the second item in the original post:

  • Pretty picture

@EdwinB12
Copy link
Member

Oh bloody hell, I checked like 3 times before posting that, sorry!!

@tdjames1
Copy link
Contributor Author

Only pretty pictures allowed 😉

@ubdbra001
Copy link
Member

ubdbra001 commented Oct 29, 2024

Something like this?

title: blah
rses: []
completed: true 
start_date: 29-10-2023
end_date: 29-10-2024
image: only-pretty.png
keywords: []
dept:
pi_name:
pi_quote: none
funding_sources: []
short_summary: "Lorem ipsum odor amet, consectetuer adipiscing elit. 
  Tempus fusce magnis cursus vitae aliquet mattis arcu.
  Eu conubia diam habitant aliquam platea sollicitudin.
  Viverra auctor vivamus blandit volutpat taciti ex quam nunc.
  Placerat duis porttitor, interdum donec sapien proin consequat vehicula magnis.
  Vulputate amet sed convallis viverra ad vehicula."
long_decription: "Lorem ipsum odor amet, consectetuer adipiscing elit.
  Porta neque sit facilisis curabitur maecenas interdum natoque donec vitae.
  Turpis ad urna nascetur ridiculus enim sociosqu.
  Potenti ipsum diam lectus suspendisse ligula?
  Mattis tortor tincidunt primis dignissim pretium dapibus leo ultricies tortor.
  Est in consectetur eleifend, habitasse fringilla id.
  Luctus facilisis aenean conubia penatibus sollicitudin urna.
  Alibero vivamus semper cursus ut ipsum.
  
  Justo porttitor conubia efficitur orci curabitur tempor; class tristique varius.
  Congue eros nisi non libero praesent malesuada.
  Justo leo lectus; magna ac magnis integer.
  Consectetur pellentesque tempor laoreet felis praesent lacus?
  Nisl urna enim vel euismod habitasse a.
  Libero quisque lectus dolor maecenas mattis quam malesuada.
  Rhoncus consequat pulvinar mauris faucibus ultrices sit in varius."
software_link: www.example.com
publication_links: []

One yaml file for each project/case study, and then use a loop and template to populate the page?

Edit: Updated with Edwin's suggestions.

@EdwinB12
Copy link
Member

This looks excellent to me, guess RSE Involved too? And maybe a date?

@Robadob
Copy link
Member

Robadob commented Oct 29, 2024

doi/publications could be useful in some cases.

@ubdbra001
Copy link
Member

This looks excellent to me, guess RSE Involved too? And maybe a date?

RSE(s) are a good shout.
What kind of date were you thinking: start and/or end?

@ubdbra001
Copy link
Member

doi/publications could be useful in some cases.

Space for this in the last item, set as an array in case there are multiple published works from a project.

@EdwinB12
Copy link
Member

Both? This would give an idea of duration too. Guess it would have to support "Ongoing" or "present" too

@Robadob
Copy link
Member

Robadob commented Oct 29, 2024

doi/publications could be useful in some cases.

Space for this in the last item, set as an array in case there are multiple published works from a project.

derp missed that, sorry

@ubdbra001
Copy link
Member

Okay, updated the template.

@EdwinB12
Copy link
Member

We should have a collaborate field too I think. Somewhere to put industry names, or other stakeholders :)

@ns-rse
Copy link
Contributor

ns-rse commented Oct 30, 2024

We should have a collaborate field too I think. Somewhere to put industry names, or other stakeholders :)

Would that perhaps fall under the funding_sources field?

@EdwinB12
Copy link
Member

I would argue funders and stakeholders can be very different?

For a lot of our work, its just working with a PI, with one source of funding. But some have multiple PIs with multiple Stakeholders who are different entities to the funder.

I think its also good to celebrate collaboration with external partners

@Robadob
Copy link
Member

Robadob commented Oct 30, 2024

Funder sounds like a grant, collab is a person

@EdwinB12
Copy link
Member

person or organisation?

@ns-rse
Copy link
Contributor

ns-rse commented Oct 30, 2024

My reasoning was that most Stakeholders external to the University will have skin in the game though and have provided funding, ergo they could be listed as funders.

Projects could be done in collaboration with individuals from other Universities and funded by a separate body (or stakeholder!).

image

@Robadob
Copy link
Member

Robadob commented Oct 30, 2024

Funder: grant and/or company/organisation
Collab: people that actually worked on the project in some capacity (e.g. who would be named in publication), probably attributed to where they work if not Shef.

@tdjames1
Copy link
Contributor Author

Could also list PI under collaborators to reduce number of fields to fill/display.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants