Electronics Lab Website for CU Boulder Physics

The website is built off of the main branch.

Contributing to the Site

1. Create a new branch to contribute to the site.
2. Work in and commit to your new branch.
3. When finished, create a pull request for review.

When you commit, please create helpful messages/descriptions (e.g., "Update Lab1 Prelab").

Hosting the Website Locally

Since GitHub Pages will only build off of the main branch, you will need to host the website locally and develop in your new branch. The site is set up to run in a Docker container so all dependencies are consistent across all development environments.

Prerequisites

• Docker installed on your system.
• VSCode with the Dev Containers extension installed.

Steps

1. Pull all updates to your local repository.
2. Run docker-compose build then docker-compose up. You should now have a container running (you can verify in Docker Desktop).
3. Open the local repository folder in VSCode.
4. Press Ctrl+Shift+P, and choose "Dev Containers: Attach to Running Container...".
5. Open a web browser and confirm the site is hosted locally by visiting: http://localhost:4000/PHYS-3330/

Editing Lab Guides

The "raw" lab guide markdown files are located in the raw-content directory. Jekyll is configured to ignore this directory, as there are additional steps required to generate the content for the site (discussed below). The files in the raw-content directory are what should be edited (not the html files in the _includes directory).

The html files in the _includes directory are generated by running the raw-content\mdtohtml.sh script.

New Lab Guide Development

The lab guide files, raw-content\labX-raw.md, $X=1,2,...,10$, are the "live" guides that are linked to on the website. So don't edit these unless we need to make a typo change, etc. For new lab guides (or for developing new versions), follow the "old/new" naming convention that currently exists.