infra: Change rendering engine from Docusaurus to Jekyll

- Remove `chapters/` hierarchy, `config.yaml` and `gen-view.py`.
- Re-split lab content into individual labs under `labs/lab-<number>/`.
- Add `_config.yaml` Gemfile for Jekyll.
- Update `Makefile` and `Dockerfile` to build the container and serve
  the website with Jekyll.
- Update the information in the global `README.md`.
- Replace topic/chapter labels with lab-based ones.
- Update PR rendering for Jekyll.

Author: Alex-deVis

.github/workflows/os-runner.yml

@@ -17,7 +17,7 @@ jobs:
       contents: read
 
     steps:
-      - name: Checkout 
+      - name: Checkout
         uses: actions/checkout@v3
 
       - name: Set up QEMU

.github/workflows/pr-deployment.yml

@@ -19,11 +19,6 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.head_ref }}
 
-      - run: |
-          cd repo
-          REF=$(echo ${{ github.event.number }} | sed 's/\//\\\//g')
-          sed -i "s/baseUrl: \/operating-systems\//baseUrl: \/operating-systems\/$REF\//" config.yaml
-
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
 
@@ -34,15 +29,15 @@ jobs:
           file: ./repo/Dockerfile
           push: false
           load: true
-          tags: operating-systems/docusaurus:latest
+          tags: operating-systems-${{ github.event.number }}:latest
           cache-from: type=gha
           cache-to: type=gha
 
       - name: Load Image
         run: |
           mkdir -p ${{ github.event.number }}
           docker image list
-          docker run -v $GITHUB_WORKSPACE/repo:/content -v $GITHUB_WORKSPACE/${{ github.event.number }}:/output operating-systems/docusaurus:latest
+          docker run -v $GITHUB_WORKSPACE/repo:/usr/src/app operating-systems-${{ github.event.number }}:latest
 
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus

.gitignore

@@ -76,109 +76,15 @@ dkms.conf
 # reveal-md slides output folder
 _site/
 
-# Temporary files
-*.swp
-*.swo
-*~
-slides.md
-
-# .gif files generated with ffmpeg
-*-generated.gif
-
-# JavaScript files
-
-# compiled output
-/dist
-/tmp
-/out-tsc
-
-# 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
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# IDEs and editors
-.idea
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-# misc
-.sass-cache
-connect.lock
-typings
-
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# next.js build output
-.next
-
-# Lerna
-lerna-debug.log
-
-# System Files
-.DS_Store
-Thumbs.db
-
-# Docusaurus build files
-.output/
-.view/
-
-# VSCode
-.vscode/
+# Builder output folder
+/.output/
+
+# Ruby files for the local Jekyll server
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/
+*.lock

Dockerfile

@@ -1,22 +1,16 @@
-FROM ghcr.io/open-education-hub/openedu-builder:0.6.1
+FROM ruby:3.0-slim
 
-# Install ffmpeg
-RUN apt-get update && \
-    apt-get install -y ffmpeg curl make
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    zlib1g-dev \
+    && rm -rf /var/lib/apt/lists/*
 
-# Install markdown-pp
-RUN pip install MarkdownPP
+WORKDIR /usr/src/app
 
-# Install node LTS (16)
-RUN curl -fsSL https://deb.nodesource.com/setup_lts.x | bash - && \
-    apt-get install -y nodejs
+COPY Gemfile Gemfile.lock ./
+RUN gem install bundler
+RUN bundle install
 
-# Install reveal md
-RUN npm install -g reveal-md
+EXPOSE 4000
 
-# Install docusaurus
-RUN npm install [email protected]
-
-WORKDIR /content
-
-ENTRYPOINT ["oe_builder"]
+CMD ["bundle", "exec", "jekyll", "serve", "--host", "0.0.0.0"]

Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'jekyll-titles-from-headings'
+gem 'jekyll-seo-tag'
+gem 'jekyll-remote-theme'
+gem 'github-pages', group: :jekyll_plugins

Makefile

@@ -1,46 +1,20 @@
-REPO_NAME = operating-systems
-IMAGE_NAME = $(REPO_NAME)/docusaurus:latest
-CONTAINER_NAME = open-edu-hub-$(REPO_NAME)-bash
-OUTPUT_DIR = $$PWD/.output/$(REPO_NAME)
+IMG_NAME=$(shell basename $(CURDIR))
+CONT_NAME=$(IMG_NAME)
 
-.PHONY: all buildimg build serve run_bash enter_bash stop_bash clean cleanall
-
-all: build
-
-buildimg:
-	docker build -f ./Dockerfile --tag $(IMAGE_NAME) .
-
-build: buildimg
-	@echo "Building content. This will take a while (several minutes) ..."
-	@echo "After the build, run"
-	@echo ""
-	@echo "       make serve"
-	@echo ""
-	@mkdir -p $(OUTPUT_DIR)
-	docker run --rm -v $$PWD/:/content -v $(OUTPUT_DIR):/output $(IMAGE_NAME)
+build:
+	docker build -t $(IMG_NAME) .
 
 serve:
-	@echo "Point your browser to http://localhost:8080/$(REPO_NAME)"
-	@cd $(OUTPUT_DIR)/.. && python3 -m http.server 8080
-
-run_bash: buildimg
-	@mkdir -p $(OUTPUT_DIR)
-	docker run -d -it --entrypoint /bin/bash --name $(CONTAINER_NAME) -v $$PWD/:/content -v $(OUTPUT_DIR):/output $(IMAGE_NAME)
-
-enter_bash:
-	docker exec -it $(CONTAINER_NAME) /bin/bash
-
-stop_bash:
-	-test "$(shell docker container inspect -f '{{.State.Running}}' $(CONTAINER_NAME) 2> /dev/null)" = "true" && docker stop $(CONTAINER_NAME)
+	docker run --rm -p 4000:4000 -v $$PWD:/usr/src/app $(IMG_NAME)
 
-clean: stop_bash
-	-docker container inspect $(CONTAINER_NAME) > /dev/null 2>&1 && docker rm $(CONTAINER_NAME)
-	-sudo rm -fr $(OUTPUT_DIR)
+stop:
+	@docker ps -q --filter "name=$(CONT_NAME)" | grep -q . && docker stop $(CONT_NAME) \
+	|| echo "No running container to stop."
 
-cleanall: clean
-	-docker inspect --type=image $(IMAGE_NAME) > /dev/null 2>&1 && docker image rm $(IMAGE_NAME)
+clean: stop
+	docker rmi $(IMG_NAME)
+	rm -rf _site
 
-# Linters
 .PHONY: lint typos
 lint: typos
 

README.md

@@ -1,3 +1,7 @@
+---
+nav_order: 1
+---
+
 # Operating Systems (OER)
 
 [![copying.md](https://img.shields.io/static/v1?label=license&message=CCBY-SA4.0&color=%23385177)](https://github.com/open-education-hub/operating-systems/blob/master/COPYING.md)
@@ -13,36 +17,28 @@ They are to be used by teachers, trainers, students and hobbyists who want to le
 
 ## Using the Content
 
-Content is located in the `content/` folder.
-It currently consists of 5 chapters:
-
-* [Software Stack](content/chapters/software-stack/)
-* [Data](content/chapters/data/)
-* [Compute](content/chapters/compute/)
-* [Input/Output](content/chapters/io/)
-* [Application Interaction](content/chapters/app-interact/)
-
-Each chapter has its own folder.
-Content for each chapter is split in two subfolders:
-
-* `lecture/`: content to be presented and discussed as part of lectures
-* `lab/`: content to be worked on as practical activities during labs / seminars
-
-Lecture content is expected to be presented and followed.
-Lab content is expected to be used as practice work.
-
-## Chapter Contents
-
-Lecture content consists of slides and demos.
-Slides are written in [GitHub Markdown](https://guides.github.com/features/mastering-markdown/) and use [reveal-md](https://github.com/webpro/reveal-md) and [reveal.js](https://revealjs.com/) to render HTML output.
-Lecture slides are built from the `slides.md` file using the `make` command (and the `Makefile`).
-Demos are snippets of code and support files that showcase concepts and ideas related to the lecture.
-Demos are located in the `demo/` folder.
-Each demo has its own folder with source code, `Makefile` or other build files (if required) and support files.
-
-Lab content consists of lab text and lab activities.
-Lab text is placed in the `README.md` file.
-Each lab activity has its own folder with source code, `Makefile` or other build files (if required) and support files.
+The content is built using [Jekyll](https://jekyllrb.com/) and is hosted on [GitHub Pages](https://pages.github.com/).
+It consists of 5 main sections:
+
+* Software Stack
+    * [Lab 1 - Operating System Perspective](labs/lab-01/)
+    * [Lab 2 - Library Perspective](labs/lab-02/)
+* Data
+    * [Lab 3 - Memory](labs/lab-03/)
+    * [Lab 4 - Investigate Memory](labs/lab-04/)
+    * [Lab 5 - Memory Security](labs/lab-05/)
+* Compute
+    * [Lab 6 - Multiprocess and Multithread](labs/lab-06/)
+    * [Lab 7 - Copy-on-Write](labs/lab-07/)
+    * [Lab 8 - Synchronization](labs/lab-08/)
+* Input/Output
+    * [Lab 9 - File Descriptors](labs/lab-09/)
+    * [Lab 10 - Inter-Process Communication](labs/lab-10/)
+    * [Lab 11 - IO Optimizations](labs/lab-11/)
+* Application Interaction
+    * [Lab 12 - Application Interaction](labs/lab-12/)
+
+Each chapter has a dedicated assignment in the [`assignments/`](assignments/) folder.
 
 ## Contributing
 

_config.yaml

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: CC BY-SA 4.0
+
+title: Operating Systems
+remote_theme: just-the-docs/just-the-docs
+repository: cs-pub-ro/operating-systems
+
+exclude:
+  - README.md
+  - REVIEWING.md
+  - config.yaml
+  - chapters/
+  - .git/
+  - .vscode/
+  - .github/
+  - content/
+  - util/
+  - landing-page/
+  - .view/
+  - .output/
+
+plugins:
+  - jekyll-titles-from-headings
+  - jekyll-seo-tag
+
+callouts:
+  warning:
+    title: warning
+    color: yellow
+  tip:
+    title: tip
+    color: green

assignments/README.md

@@ -0,0 +1,24 @@
+---
+title: Assignments
+nav_order: 3
+has_children: true
+---
+
+# Assignments
+
+The assignments are a way to test your understanding of the course material.
+Each assignment is a small project that encompasses the concepts you have learned in the labs.
+
+Each assignment compreises of:
+
+- a description of the assignment in the `README.md` file
+- a `src/` directory that contains the code skeleton for the assignment
+- a `tests/` directory that contains the test cases for the assignment
+- optionally a `utils/` directory that contains utility functions that should not be changed
+
+You can find the assignments in the `assignments` directory.
+
+## Building and Testing the Assignments
+
+Each assignment has its own Makefile to automate the building and testing process.
+For more details on how to use it, check the `README.md` file in the assignment directory.