0xcf/decal-web

Course information for the XCF/OCF Unix System Administration DeCal

OCF/XCF Linux SysAdmin DeCal Website

This is the source of the OCF/XCF Unix System Administration DeCal website, currently available at decal.ocf.berkeley.edu.

The current iteration uses Jekyll to produce pages.

Development

decal-web is built for Jekyll, a static site generator. View the quick start guide for more information.

Developing using Docker

This is the reccomended method for development.

1. Install Docker following instructions from here
2. Pull the Docker image

$ docker pull jekyll/jekyll

3. Clone this repository

$ git clone https://github.com/0xcf/decal-web
$ cd decal-web

4. Build the site

$ docker run --rm --volume=$PWD:/srv/jekyll:Z  \
    --volume=$PWD/vendor/bundle:/usr/local/bundle:Z \
    jekyll/jekyll:latest jekyll build

The first volume is necessary to provide the build files to Jekyll but the second volume is optional and used to cache Gems. 5. Serve the site on your local machine

$ docker run --rm --volume=$PWD:/srv/jekyll:Z  \
    --volume=$PWD/vendor/bundle:/usr/local/bundle:Z \
    --publish [::1]:4000:4000 jekyll/jekyll:latest jekyll serve

The website should be served on http://localhost:4000 and will reflect changes that you make.

Developing on Supernova

This method currently does not work.

1. SSH into supernova

$ ssh <ocf-username>@supernova.ocf.berkeley.edu

2. Clone this repository

$ git clone https://github.com/0xcf/decal-web

3. Start the Jekyll server on supernova with:

$ cd decal-web
$ make supernova

The console should ouput a web address (http://supernova.ocf.berkeley.edu:8xxx/). This web-page will update as you make changes, reload your browser tab to preview the changes.

Developing on your local machine

You will need Ruby 2 to build the site (it has been tested on Ruby2.7.4).

• On Ubuntu 20.04, Ruby can be installed using sudo apt install ruby-full.
• If using Arch, follow this guide to install it.
• ruby-install is a helpful script- you can run ruby-install 2.7.4 if Ruby is on the wrong version in your package manager.
• You can also use asdf-vm. After installing Ruby ( asdf install ruby 2.7.2 ), prepend asdf exec to all commands that require it (example: asdf exec bundle exec jekyll serve).

You may also need to install Bundler 2.3.10: gem install bundler:2.3.10

1. Install Jekyll

$ bundle install

2. Start your local Jekyll server. You can also use make local-dev.

$ bundle exec jekyll serve

3. The console should output a server address (localhost:8xxx). Open that address in your browser.
4. Reload your web browser after making a change to preview its effect.

For more information, refer to Just the Docs.

decal-web's Issues

Update a4

Update b10

Update b5

Use gravatars instead of uploaded images

The slack bridge and ocfweb use Gravatars for images. We should do this too. Looks like there is a Jekyll plugin for this, see https://github.com/mrsimo/jekyll-gravatar

b1

Update b6

b10

Update a5

Example:
https://decal.ocf.berkeley.edu/archives/2018-fall/labs/a5

Lab a6 Q3b: no retry:n in Linux /etc/resolv.conf

In checkpoint 2 Q3b*, it turned out that there isn't a retry:n in Linux /etc/resolv.conf. When I did a6 I assumed it was attempts:n**: sets the number of times the resolver will send a query to its name servers before giving up and returning an error to the calling application.

For Solaris, however, there is indeed a retry:n***: Sets the number of attempts made to connect to each name server.

See the linked Oracle manual for more info.

We should probably change retry:n to attempts:n, and update the solutions accordingly.

*: https://decal.ocf.berkeley.edu/labs/a6#checkpoint-2
**: https://linux.die.net/man/5/resolv.conf
***: https://docs.oracle.com/cd/E88353_01/html/E37852/resolv.conf-5.html

Update b2

Update a8

Update b4

Add Linode Sponsorship to website

Footer updates (copyright + Linode)

Update lab 0

• Add some more questions to get a better idea of the general audience that is signing up for the decal
• Make different labs depending on which track people want to sign up for

Add a table of contents for lab pages

Some of the labs have lengthy lecture notes built into the lab, with the actual lab questions at the end of the page. (Example: lab b3) A table of contents to skip to different sections on the page would make navigating these labs easier. We should add an auto-generated table of contents sidebar on each lab page.

b8

Update b3

Update a6

b7

a5

b5

a6

Require the day of the week along with date for lecture date/lab due date

It would be a good guard against typos of the date. We'd probably need a pre-commit check to make sure people have the correct form (Thurs vs Thursday) or something like that though.

a9

Update a7

https://decal.ocf.berkeley.edu/archives/2018-spring/labs/a7

a10

Update calendar and syllabus for 2020

Remove old facilitators off of the website

We can probably hold off on this for a bit, but we should take off everyone that obviously isn't giving a lecture this semester.

Update b1

b2

b4

Update b7

Deploy branches other than master in Jenkins

Separate branches and PRs should be built and deployed somewhere by Jenkins. This would make it easier to sanity check PRs.

Update b8

Add tests for links on homepage

It would be nice to have a test (and pre-commit check) that all links on the homepage are valid and don't 404. This could prevent a lot of potential careless mistakes down the line.

I'm assigning myself on this but if anyone has ideas/thoughts on implementation, feel free to discuss here or make a PR.

Add code syntax highlighting to labs

Update bundler

We need to bump the version of our dependencies to much newer versions.

Update a9

b3

Update b9

b6

Fix build race conditions in Jenkins

Notice builds 30 and 31 on Jenkins. These correspond to pushes that happened within a few seconds of each other. Build 30 started first, but finished after 31, causing the changes of build 31 to get overwritten and the website to display an old version. After noticing this, I manually ran a build to fix the problem-- but there should be a way to ensure this doesn't happen.

@jvperrin, any ideas?

a7

Update a10

a4

Switch Jekyll Theme to "Just The Class"

https://github.com/kevinlin1/just-the-class | Demo

Created by former 61A/B/C TA & currently used by the CS186 website. It looks quite a bit nicer than the plain bootstrap thing we have going on (IMO) and seems to be relatively well-maintained.

It's also just a plain Jekyll template so it doesn't look like it'd be too much of a pain to switch to.

a8

Update a3

b9