Skip to content

First draft of nicely styled team page:#690

Merged
davidorme merged 55 commits intodevelopfrom
688-update-project-team
Jun 19, 2025
Merged

First draft of nicely styled team page:#690
davidorme merged 55 commits intodevelopfrom
688-update-project-team

Conversation

@davidorme
Copy link
Copy Markdown
Collaborator

@davidorme davidorme commented Jan 21, 2025

Description

This PR does two things:

  • removes the team listing from README.md and replaces it with a pointer to a new team page on the website.
  • adds that new page on the website. This contains some lightly styled cards within photos and short bio.

We've set the website builder to build the changes on the branch for this pull request and you can see the results of building the new page here: https://virtual-ecosystem.readthedocs.io/en/688-update-project-team/project_team.html

We now need all team members to commit changes to this PR to add their details and fill out the page. You will need to:

  • Install Git on your computer, if you do not already have it: https://git-scm.com/downloads

  • Clone the virtual_ecosystem repository. This will create a new directory on your computer so you first need to decide where you want to put it. Open a terminal in that root directory and run:

    git clone https://github.com/ImperialCollegeLondon/virtual_ecosystem.git
  • You should now have a virtual_ecosystem folder. In your terminal, change directory into that terminal and then run:

    git switch 688-update-project-team

    You should now be looking at the specific versions of the files that are being edited on this request.

  • If you want to include a photo - you don't have to - edit a photo of yourself. We're after small photos (roughly 200 x 300 pixels or that sort of shape and size. Within the virtual_ecosystem repo, you need to save it in the folder docs/source/_static/images/people under your name.

  • Within the virtual_ecosystem repo, open the file docs/source/project_team.md. This is a file written in the Markdown format that our documentation system converts into HTML. You will need to edit your entry (like the one shown below) in three ways:

    • If you want to link to a personal website, change project_team.html to https://your.homepage.url
    • If you added a photo, change _static/images/people/photo_placeholder.png to _static/images/people/your_photo_name.jpg
    • Change the text `Lorem ipsum ... egestas.``` to a short bio for yourself.
:::{grid-item-card} Dr. Taran Rallings
:margin: 2 2 0 0
:link: project_team.html

```{image} _static/images/people/photo_placeholder.png
:alt: Dr. Taran Rallings
:class: team-photo
```

Lorem ipsum odor amet, consectetuer adipiscing elit. Velit dolor tellus ligula ligula
montes tellus eget. Accumsan platea blandit porta imperdiet curabitur varius himenaeos
egestas.
:::
  • Now you need to commit those changes. There are three steps that need to be run from the command line in the virtual_ecosystem repo:

    1. Your photo isn't currently being managed by git so add it: git add docs/source/_static/images/people/your_photo_name.jpg
    2. Add the changes to the markdown file: git add docs/source/project_team.md
    3. Now run `git commit -m "Adding team details for your name here"
  • Lastly - those changes are only on your computer. You now need to run git push to send the details to GitHub.

Fixes #688 (issue)

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@davidorme davidorme linked an issue Jan 21, 2025 that may be closed by this pull request
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.96%. Comparing base (2c08828) to head (167e1b3).
Report is 72 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #690   +/-   ##
========================================
  Coverage    93.96%   93.96%           
========================================
  Files           75       75           
  Lines         5828     5828           
========================================
  Hits          5476     5476           
  Misses         352      352           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jacobcook1995
Copy link
Copy Markdown
Collaborator

I think this looks nice! I personally think that having longer descriptions probably removes the need for separating out into groups, but it depends what others think

@davidorme
Copy link
Copy Markdown
Collaborator Author

I think it probably makes sense to break up the grid a little and have:

Project leadership: Rob and Liv
Code development: David, Jacob, Vivi, Taran, Sally (and maybe Alex and Diego)
Data science and model parameterisation: Bai, Hao Ran, Nick, Lela (and maybe Sam)

@jacobcook1995
Copy link
Copy Markdown
Collaborator

I think it probably makes sense to break up the grid a little and have:

Project leadership: Rob and Liv Code development: David, Jacob, Vivi, Taran, Sally (and maybe Alex and Diego) Data science and model parameterisation: Bai, Hao Ran, Nick, Lela (and maybe Sam)

We also need to work out where Anna best fits as well

@hrlai
Copy link
Copy Markdown
Collaborator

hrlai commented Feb 14, 2025

I couldn't switch branch and when I do git branch only the dev branch showed up...

> git switch 668-update-project-team
fatal: invalid reference: 668-update-project-team
> git branch
* develop

I tried git fetch --all but still the same. Not sure if it's related to access permission (possibly because:)

> git fetch origin/688-update-project-team
fatal: 'origin/688-update-project-team' does not appear to be a git repository
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

@davidorme
Copy link
Copy Markdown
Collaborator Author

davidorme commented Feb 14, 2025

I couldn't switch branch and when I do git branch only the dev branch showed up...

What does this show? It should list all remote branches

git branch -r

And does this do anything:

git fetch origin 688-update-project-team 

@hrlai
Copy link
Copy Markdown
Collaborator

hrlai commented Feb 14, 2025

git branch -r

does show all the branches, and

git fetch origin 688-update-project-team 

gave

From https://github.com/ImperialCollegeLondon/virtual_ecosystem
 * branch              688-update-project-team -> FETCH_HEAD

But I still get

> git switch 668-update-project-team
fatal: invalid reference: 668-update-project-team

@hrlai
Copy link
Copy Markdown
Collaborator

hrlai commented Feb 15, 2025

Sorry I deleted to last comment because it was misleading. I was trying various thing, but when I tried git switch 668-update-project-team after refreshing the repo (redoing a clean clone), it works now!

@davidorme davidorme requested review from jacobcook1995 and removed request for TaranRallings, jacobcook1995, sallymatson and vgro April 11, 2025 15:36
@davidorme
Copy link
Copy Markdown
Collaborator Author

davidorme commented Apr 11, 2025

@sallymatson Does this completed page look ok for now?

@davidorme davidorme requested review from sallymatson and removed request for jacobcook1995 April 11, 2025 15:37
@davidorme davidorme requested review from jacobcook1995 and removed request for sallymatson June 18, 2025 11:30
@davidorme
Copy link
Copy Markdown
Collaborator Author

@jacobcook1995 This just dropped off the radar. I'm updating to develop and then I think we can merge it

Copy link
Copy Markdown
Collaborator

@jacobcook1995 jacobcook1995 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Think it makes sense just to merge it (as people have had time to give feedback), and then if anything still needs to be fixed that can be done in a separate PR

@davidorme davidorme merged commit fba3717 into develop Jun 19, 2025
16 checks passed
@davidorme davidorme deleted the 688-update-project-team branch June 19, 2025 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Project Team