Skip to content

Add submodule again #33

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 9 additions & 7 deletions .github/workflows/jekyll.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ on:

# Allows site to rebuild on submodule changes
repository_dispatch:
types: [dispatch-build]
types: [update]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
contents: write
pages: write
id-token: write

Expand All @@ -37,11 +37,13 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Submodules
- if: ${{ github.event.client_payload.sha != '' }}
run: |
git submodule init
git pull --recurse-submodules
git submodule update --remote --recursive
git submodule update --init --recursive --checkout -f --remote -- "data"
git config --global user.name "Github Action"
git config --global user.email "[email protected]"
git commit -am "Update data submodule to ${{ github.event.client_payload.sha }}"
git push
- name: Setup Ruby
uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
with:
Expand Down Expand Up @@ -70,4 +72,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v2
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "data"]
path = data
url = https://github.com/ucsdwcsng/site-data
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To update the images in the carousel, go to index.md and update the image paths
To change the research areas or their overview gifs, update the coressponding heading, link, and path in the body of index.md.
For now, these research areas are hardcoded, but it could be automated if they change a lot by creating a .yml file.
### Team Page
To update current PhD students, Postdocs, or Collaborators, add (or remove) an entry in /_data/people.yml. Be sure to follow the same format as the existing entries with name, role, and a path to their image. Thes images should be saved to /assets/images/teampic.
To update current PhD students, Postdocs, or Collaborators, add (or remove) an entry in /_data/people.yml. Be sure to follow the same format as the existing entries with name, role, and a path to their image. Thes images should be saved to /data/images/teampic.
To update current Masters and Undergraduate students, add (or remove) an entry in /_data/people_text.yml. Again, be sure to follow the same format as the existing entries. For the `col` field, alternate 1 and 2 for each additional entry to make sure that the names are evenly split across both columns.
To update Alumni, add (or remove) an entry in /_data/alumni.yml. Be sure to alternate the col values for each entry, as described above. For the `role` field, put the degree for all alumni (BS, MS, PhD etc.). For the `year` field, put the graduating year for all alumni. The `now` field can be left empty if unknown, or phrased " [company] [location]" or "[degree] at [school]".
### Research Pages
Expand All @@ -24,20 +24,20 @@ The `sponsors` field is optional, and should include a list of sponsors and thei
```
sponsors:
- name: Qualcomm
picture: /assets/images/qualcomm.jpeg
picture: /data/images/qualcomm.jpeg
```
Finally, use the `carousels` field to add the research page's carousel images using the following format:
```
carousels:
- images:
- image: /assets/images/atkinson.jpeg
- image: /assets/images/rice_chip.jpeg
- image: /assets/images/pcb.jpeg
- image: /assets/images/bearl.jpeg
- image: /data/images/atkinson.jpeg
- image: /data/images/rice_chip.jpeg
- image: /data/images/pcb.jpeg
- image: /data/images/bearl.jpeg
```
To update the site navigation, add/change an entry to `subfolderitems` in _data/navigation.yml.
### Publications
To add a new publication (both to the publications list and as an individual webpage), create a new md file under the [ucsdwcsng/site-publications-pages](https://github.com/ucsdwcsng/site-publications-pages) submodule. Be sure to name the md file with the format `year-month-day-name.md` (ex: 2023-05-24-mmSpoof.md). In the front matter of this md file, add `layout: publication`. The `title` field should have the full name of the publication, which will be displayed as the title of the publication's webpage. The `short_title` field is the shortened name that will be displayed on the list views of the publication. The `tags` field is a space separated list to tag which sublists and research pages this publication should appear in. Be very careful to match the spelling exactly to existing tags, or it will create a new tag for this publication. The `cover` field should have the path to the cover image to be displayed on the publication list. All cover images should be saved to /assets/images/pubpic. The `authors` field should be a string of authors separated by commas (try to write full names and only commas, no "and" to maintain consistency). The `conference` field stores the name of the conference this paper was used in. The `paper` field is required, and should contain a link or path to a pdf of the paper. Most of these pdfs are stored in /files. The optional fields are `github`, which should have a link to the github repo, `dataset`, which should have a link the the dataset, `slides`, which should have a path to a pdf of the slides (most are saved in /files), `extra`, which should have a string about the special highlight of this publication (ex: `extra: "This work won the Qualcomm Innovation Fellowship 2022!"`), and `video`, which should have an EMBED link to a youtube video (not the regular youtube link). Currently, up to two video links are automatically supported, with the field for the second video being `video2` (which will also require a youtube embed link). Up to one additional link is also supported under the field `other`, which will show up in the list of links containing the slides, github, and datasets. The format for adding this extra link is:
To add a new publication (both to the publications list and as an individual webpage), create a new md file under the [ucsdwcsng/site-publications-pages](https://github.com/ucsdwcsng/site-publications-pages) submodule. Be sure to name the md file with the format `year-month-day-name.md` (ex: 2023-05-24-mmSpoof.md). In the front matter of this md file, add `layout: publication`. The `title` field should have the full name of the publication, which will be displayed as the title of the publication's webpage. The `short_title` field is the shortened name that will be displayed on the list views of the publication. The `tags` field is a space separated list to tag which sublists and research pages this publication should appear in. Be very careful to match the spelling exactly to existing tags, or it will create a new tag for this publication. The `cover` field should have the path to the cover image to be displayed on the publication list. All cover images should be saved to /data/images/pubpic. The `authors` field should be a string of authors separated by commas (try to write full names and only commas, no "and" to maintain consistency). The `conference` field stores the name of the conference this paper was used in. The `paper` field is required, and should contain a link or path to a pdf of the paper. Most of these pdfs are stored in /data/files. The optional fields are `github`, which should have a link to the github repo, `dataset`, which should have a link the the dataset, `slides`, which should have a path to a pdf of the slides (most are saved in /data/files), `extra`, which should have a string about the special highlight of this publication (ex: `extra: "This work won the Qualcomm Innovation Fellowship 2022!"`), and `video`, which should have an EMBED link to a youtube video (not the regular youtube link). Currently, up to two video links are automatically supported, with the field for the second video being `video2` (which will also require a youtube embed link). Up to one additional link is also supported under the field `other`, which will show up in the list of links containing the slides, github, and datasets. The format for adding this extra link is:
```
other:
display: "[Kaggle Competition]"
Expand Down
4 changes: 3 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -228,4 +228,6 @@ plugins:
## => Extra stuff for publications
miscs:
- content_type: # type
- content_url: # link
- content_url: # link

collections_dir: data
1 change: 1 addition & 0 deletions _data/news.yml
149 changes: 0 additions & 149 deletions _data/news/news.yml

This file was deleted.

Loading