Skip to content

How To Make CCL Website Changes

Jump to bottom
jgoeders edited this page Nov 26, 2019 · 12 revisions

Adding Students

  1. Edit the _data/students.yaml file.

Each student should have a name and image:

  - name: Andrew Keller
    image: andrew_keller.jpg

The spacing is important. Make sure it matches the other students. The ordering doesn't matter, the students will be sorted by name.

  1. Upload the student's image to the images/students folder.

Adding News Items

  1. Edit the _data/news.yaml file.

Each event should be formatted as follows. The spacing is important, make sure it is exactly as shown. The ordering of event's doesn't matter, they will be sorted by date.

- event_name: LANSCE Radiation Testing
  date: 2019-10-1
  description: >
    Students from the CCL travelled to LANSCE...
  images: 
    - news_2019/lansce1.jpg 
    - news_2019/lansce3.jpg 
    - news_2019/lansce2.jpg

The date must be in YYYY-MM-DD format. The day is not shown on the page, so it doesn't matter, although you can use it to sort events within the same month.

Each event needs an event_name and date. The description and images are optional. If you include images, it looks best with 2 or 3.

The news page is configured to only show the 10 most recent events.

  1. Upload the images to the images/news_<year> folder.

Adding papers

  1. Edit the _data/papers.yaml file.

You should include the following fields:

- title: Unified On-Chip Software and Hardware Debug for HLS-Accelerated Programs
  authors: Matthew Ashcraft, Jeffrey Goeders
  conference: International Conference on Field-Programmable Technology (FPT)
  year: 2018
  abstract: >
    Modern high-level synthesis (HLS)-based tools allow for the creation of complex systems ...
  url: ashcraft_fpt18.pdf

For the conference field, just include the conference name (like above), not 23rd Annual or 2018 International.... The ordering of papers in the file doesn't matter. They will be grouped by year and sorted by title.

  1. Upload your paper pdf to the assets folder.

Adding Projects

  1. Edit the _data/projects.yaml file.

You should include the following fields:

- name: COAST (COmpiler-Assisted Software fault Tolerance)
  description: >
    COAST is a set of compiler tools that provides automated software protection from single-event effects.  Users can ...
  url: https://github.com/byuccl/coast

The projects page is not sorted. It will follow the same ordering as the YAML file.

  1. You can optionally add images using the same syntax as the news items. These images should be uploaded to the images/projects folder.

Checking that the website works

After you save/commit your changes, the website will automatically build. Your changes will be available at https://byuccl.github.io/ soon after you save. In Chrome you may need to press Ctrl+F5 to fully refresh the page.

If you don't see your changes, check the latest commits. Your change should have a green checkmark next to it. If it has a red X, look at your changes and see if you can spot the error.

If the website updates correctly, it will be available at https://ccl.ee.byu.edu/ after about 2 minutes. You can check the progress of the website copy on the actions tab.

Local Development

If you want to test out the website locally, you can use git to clone this repo, then run jekyll serve to build and run a local webserver for the website. You can open the website locally at http://localhost:4000/. Anytime you modify a file, Jekyll will automatically update the local website.

You can install Jekyll using apt install jekyll (I've tested on Ubuntu and WSL).

Changing the HTML of the website

If you want to make changes to the website layout (not just the YAML data files), please create a pull request.

Clone this wiki locally