Doss-Gollin lab site
This is the source code for the Doss-Gollin Research Group's web site. Code is forked from the Andersen Lab.
This is intended to be a living document, and lab members are strongly encouraged to suggest improvements to this lab guide. Don't hesitate to reach out for help on Slack if you're stuck -- contributing to the website is a great learning experience!
Getting Started
- Watch this YouTube Walkthrough I made to help you!
- See https://guides.github.com/activities/forking/ for a helpful guide to git workflow
Clone the repository to your machine
- Fork the repository on GitHub
- Clone your forked repository
git submodule update --init --recursive
to get submodules up and running
Then you have two choices
- Docker installation option (runs slow but less can go wrong): run
make install
. This will use Docker to install the packages you need. (Note, you need to run Docker Desktop for this to work). - Native Ruby installation (runs faster but can be a bit tricky to install properly): run
bundle install
to install required packages. If you don't have bundle set up, you will need to install it (typewhich bundle
to see if you have it already)
Preview the site on your computer
- Follow the steps above to clone the repository to your machine
- Open the website in your text editor (ie, VS Code) and make any desired changes
Then you have two choices
- If you chose the Docker installation option above, run
make devserver
- If you chose the native Ruby installation option above, run
bundle exec jekyll serve -w
Update the web site
Once you have made changes and are ready to share them:
- Stage and commit your changes
- Push changes (they will go to your fork of the repository on GitHub)
- Create a pull request. Add a title and description to explain what changes you are making and why!
If you get stuck with this: ask for help! You're not born knowing.
Common Changes
There are a few things that many members may want to do
Add yourself to the 'People' page
- Pick a user ID for yourself; we'll call it your "anchor" (James uses
jdossgollin
). - Upload a picture: find a square image of yourself, preferably JPG, and copy it to
_assets/img/people/<your_anchor>.jpg
. - Open
_data/people.yaml
in your text editor. Use James's information as a template (or use someone else's) and add your own information. To leave a field blank, just delete it!