Merge branch 'main' into dillon_thesis

.github/workflows/jekyll.yml

@@ -31,6 +31,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1 # v1.161.0
         with:
@@ -41,13 +43,16 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install graphicsmagick
+          npm ci
       - name: Checks Ruby Gems
         run: bundle list
+      - name: Checks npm packages
+        run: npm list
       # - name: Setup Pages
       #   id: pages
       #   uses: actions/configure-pages@v4
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
-        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" --config _config.yml,_dev_config.yml
+        run: npx gulp build -j '--config _config.yml,_dev_config.yml'
         env:
           JEKYLL_ENV: production

.github/workflows/static_site_build_e4e_dev.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1 # v1.161.0
         with:
@@ -35,11 +37,14 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install graphicsmagick
+          npm ci
       - name: Checks Ruby Gems
         run: bundle list
+      - name: Checks npm packages
+        run: npm list
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
-        run: bundle exec jekyll build --baseurl "" --config _config.yml,_e4e_dev_config.yml
+        run: npx gulp build -j '--config _config.yml,_dev_config.yml'
         env:
           JEKYLL_ENV: production
 

.gitignore

@@ -1,5 +1,5 @@
-# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,jekyll,windows,visualstudiocode,python
-# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,jekyll,windows,visualstudiocode,python
+# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,jekyll,python,windows,visualstudiocode,node
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,jekyll,python,windows,visualstudiocode,node
 
 ### Jekyll ###
 _site/
@@ -58,6 +58,146 @@ Temporary Items
 # iCloud generated files
 *.icloud
 
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
 ### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -103,7 +243,6 @@ htmlcov/
 .nox/
 .coverage
 .coverage.*
-.cache
 nosetests.xml
 coverage.xml
 *.cover
@@ -117,7 +256,6 @@ cover/
 *.pot
 
 # Django stuff:
-*.log
 local_settings.py
 db.sqlite3
 db.sqlite3-journal
@@ -181,7 +319,6 @@ celerybeat.pid
 *.sage.py
 
 # Environments
-.env
 .venv
 env/
 venv/
@@ -275,7 +412,7 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/linux,macos,jekyll,windows,visualstudiocode,python
+# End of https://www.toptal.com/developers/gitignore/api/linux,macos,jekyll,python,windows,visualstudiocode,node
 *.bib.sav
 *.sql
 cache/

.htaccess

@@ -4,4 +4,4 @@ RewriteCond %{REQUEST_FILENAME} -d
 RewriteRule ^(.*?)/$ /$1.html [L]
 
 RewriteCond %{REQUEST_FILENAME}.html -f
-RewriteRule ^(.*?)/?$ /$1.html [L]
+RewriteRule ^(.*?)/?$ /$1.html [L]

.vscode/launch.json

@@ -8,7 +8,7 @@
             "name": "Jekyll Live Server",
             "type": "PowerShell",
             "request": "launch",
-            "script": "bundle exec jekyll serve --livereload",
+            "script": "npx gulp watch",
             "cwd": "${workspaceFolder}"
         }
 

Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/UCSD-E4E/jekyll-resize
-  revision: d842e783b935dc1641d8eca84a46d2fdfa5c8dad
+  revision: 94608bc31238abb979097d5695053921772ac940
   specs:
     jekyll-resize (1.3.1)
       jekyll (> 3.3, < 5.0)
@@ -42,7 +42,7 @@ GEM
     google-protobuf (4.26.1-x86_64-linux)
       rake (>= 13)
     http_parser.rb (0.8.0)
-    i18n (1.14.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     jekyll (4.3.3)
       addressable (~> 2.4)
@@ -96,17 +96,19 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.6)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rouge (4.2.1)
     safe_yaml (1.0.5)
-    sass-embedded (1.75.0-arm64-darwin)
+    sass-embedded (1.77.2-arm64-darwin)
       google-protobuf (>= 3.25, < 5.0)
-    sass-embedded (1.75.0-x64-mingw-ucrt)
+    sass-embedded (1.77.2-x64-mingw-ucrt)
       google-protobuf (>= 3.25, < 5.0)
-    sass-embedded (1.75.0-x86_64-darwin)
+    sass-embedded (1.77.2-x86_64-darwin)
       google-protobuf (>= 3.25, < 5.0)
-    sass-embedded (1.75.0-x86_64-linux-gnu)
+    sass-embedded (1.77.2-x86_64-linux-gnu)
       google-protobuf (>= 3.25, < 5.0)
+    strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)

README.md

@@ -34,10 +34,18 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
 ## Developer Get Started
 1. Follow the instructions at https://jekyllrb.com/docs/installation/ to install the Jekyll generator on your machine.
 2. Follow the instructions at http://www.graphicsmagick.org/README.html#installation to install GraphicsMagick on your machine.
-3. Run `bundle exec jekyll serve --livereload` in this repository root to deploy a live server to http://localhost:4000
+3. Follow the instructions at https://docs.npmjs.com/downloading-and-installing-node-js-and-npm to install Node.js and npm on your machine
+4. Run `npm ci` in this repository root
+5. Run `bundle install` in this repository root
+6. Run `npx gulp watch` in this repository root to deploy a live server to http://localhost:4000
 
 Dev deployment target: https://ucsd-e4e.github.io/website2.0/
 
+## Other gulp commands
+- `npx gulp build` performs a single static build of the site
+- `npx gulp build -j "<INSERT JEKYLL ARGS>"` creates a build of the site with custom jekyll arugments
+
+
 ## Adding Publications
 1. Open [_bibliography/publications.bib](_bibliography/publications.bib) in [JabRef](https://www.jabref.org/).
 2. Add the new publication using the correct classification
@@ -152,6 +160,17 @@ Fill in permalink, title, and category with the same values used in the respecti
 
 Your post feed page on the website will be found at `/insert-project-link/project-updates`
 
+#### OPTIONAL: Add onboarding papers
+- Add your bib file for your project to `_bibliography/onboarding_papers`
+- In `onboarding_papers.md`, add the following to the front matter's paper list:
+
+---
+- bib_file: name_of_bib_file
+  name: Project Name
+  url: /insert-project-link
+---
+
+url MUST be the same as permalink on your project
 
 ## Components (Includes)
 Jeykll allows for components to be embedded in markdown files. See [https://jekyllrb.com/docs/includes/](https://jekyllrb.com/docs/includes/)
@@ -227,3 +246,40 @@ Format:
     enable_nav=true or false 
 %}
 
+## Adding blog posts
+Create a new file in `/_posts` with the following name: `{year}-{month}-{day}-{hyphenated-title}.md`.  For example: `2024-05-10-e4e-releases-new-jekyll-website.md`.
+
+At the top of the file, add the following:
+```
+---
+date: {year}-{month}-{day} {hour}:{minute}-{timezone offset}:00
+layout: blog-post
+title: {title}
+categories:
+ - news-and-updates
+author: {your name}
+featuredImage: {relative path to featured image}
+tags:
+- {additional tags}
+---
+```
+
+For example:
+```
+---
+date: 2024-05-07 21:45-07:00
+layout: blog-post
+title: Ronan Wallace Awarded Fulbright for Floods of Lubra
+categories:
+ - news-and-updates
+author: Nathan Hui
+featuredImage: assets/floods_of_lubra/fieldwork-nepal.jpg
+tags:
+- floods-of-lubra
+- fulbright
+---
+```
+
+Add the contents of your blog post after this preable, using the appropriate components.
+
+Commit this and any included images to a new branch (we recommend using the same format as the blob post file name).  Request a review from one of the website admins and enable auto merge.