### OS Week 02 – Deadline: 15-Sep-2024 23:00 -* [Week 02 Assignment #1: Readings, Watchings, and Demos](W02-01.md) -* [Week 02 Assignment #2: GnuPG](W02-02.md) -* Week 02 Assignment #3: Update "LINKS/". See also [Week 01 Assignments #3](W01-03.md) -* [Week 02 Assignment #4: Review links every week!](W02-04.md) -* [Week 02 Assignment #5: Back up Your SSH and GPG keys!](W02-05.md) -* [Week 02 Assignment #6: Assignment Script](W02-06.md) -* [Week 02 Assignment #7: Finishing](W02-07.md) +* [Week 02 Assignment #1: Readings, Watchings, and Demos](W02-01) +* [Week 02 Assignment #2: GnuPG](W02-02) +* Week 02 Assignment #3: Update "LINKS/". See also [Week 01 Assignments #3](W01-03) +* [Week 02 Assignment #4: Review links every week!](W02-04) +* [Week 02 Assignment #5: Back up Your SSH and GPG keys!](W02-05) +* [Week 02 Assignment #6: Assignment Script](W02-06) +* [Week 02 Assignment #7: Finishing](W02-07) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt @@ -73,11 +73,11 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 03 – Deadline: 24-Sep-2024 23:00 -* [Week 03 Assignment #1: Readings and Demos](W03-01.md) -* Week 03 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05.md) -* [Week 03 Assignment #3: Add/Create An Extra Virtual Disk](W03-03.md) -* [Week 03 Assignment #4: Assignment Script](W03-04.md) -* [Week 03 Assignment #5: Finishing](W03-05.md) +* [Week 03 Assignment #1: Readings and Demos](W03-01) +* Week 03 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05) +* [Week 03 Assignment #3: Add/Create An Extra Virtual Disk](W03-03) +* [Week 03 Assignment #4: Assignment Script](W03-04) +* [Week 03 Assignment #5: Finishing](W03-05) * Recheck folder “TXT/”: * mylog.txt * mypubkey.txt @@ -94,11 +94,11 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 04 – Deadline: 1-Oct-2024 23:00 -* [Week 04 Assignment #1: Readings and Demos](W04-01.md) -* Week 04 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05.md) -* [Week 04 Assignment #3: Assignment Script](W04-03.md) -* [Week 04 Assignment #4: Compiling The Linux Programming Interface (TLPI)](W04-04.md) -* [Week 04 Assignment #5: Finishing](W04-05.md) +* [Week 04 Assignment #1: Readings and Demos](W04-01) +* Week 04 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05) +* [Week 04 Assignment #3: Assignment Script](W04-03) +* [Week 04 Assignment #4: Compiling The Linux Programming Interface (TLPI)](W04-04) +* [Week 04 Assignment #5: Finishing](W04-05) * Recheck folder “TXT/”: * mylog.txt * mypubkey.txt @@ -116,12 +116,12 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 05 – Deadline: 8-Oct-2024 23:00 -* [Week 05 Assignment #1: Readings and Demos](W05-01.md) -* Week 05 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05.md) -* [Week 05 Assignment #3: How Low (Memory) Can You Go?](W05-03.md) -* [Week 05 Assignment #4: Assignment Script](W05-04.md) -* [Week 05 Assignment #5: Memory](W05-05.md) -* [Week 05 Assignment #6: Finishing](W05-06.md) +* [Week 05 Assignment #1: Readings and Demos](W05-01) +* Week 05 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05) +* [Week 05 Assignment #3: How Low (Memory) Can You Go?](W05-03) +* [Week 05 Assignment #4: Assignment Script](W05-04) +* [Week 05 Assignment #5: Memory](W05-05) +* [Week 05 Assignment #6: Finishing](W05-06) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt @@ -138,11 +138,11 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 06 – Deadline: 29-Oct-2024 23:00 -* [Week 06 Assignment #1: Readings and Demos](W06-01.md) -* Week 06 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05.md) -* [Week 06 Assignment #3: Assignment Script](W06-03.md) -* [Week 06 Assignment #4: Fork and Shared Memory](W06-04.md) -* [Week 06 Assignment #5: Finishing](W06-05.md) +* [Week 06 Assignment #1: Readings and Demos](W06-01) +* Week 06 Assignment #2: Back up Your SSH and GPG keys! [See Week 02 #5](W02-05) +* [Week 06 Assignment #3: Assignment Script](W06-03) +* [Week 06 Assignment #4: Fork and Shared Memory](W06-04) +* [Week 06 Assignment #5: Finishing](W06-05) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt @@ -160,10 +160,10 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 07 – Deadline: 05-Nov-2024 23:00 -* [Week 07 Assignment #1: Readings and Demos](W07-01.md) -* [Week 07 Assignment #2: Assignment Script](W07-02.md) -* [Week 07 Assignment #3: Synchronization](W07-03.md) -* [Week 07 Assignment #4: Finishing](W07-04.md) +* [Week 07 Assignment #1: Readings and Demos](W07-01) +* [Week 07 Assignment #2: Assignment Script](W07-02) +* [Week 07 Assignment #3: Synchronization](W07-03) +* [Week 07 Assignment #4: Finishing](W07-04) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt @@ -180,10 +180,10 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 08 – Deadline: 12-Nov-2024 23:00 -* [Week 08 Assignment #1: Readings and Demos](W08-01.md) -* [Week 08 Assignment #2: Assignment Script](W08-02.md) -* [Week 08 Assignment #3: LFS 12.1 Chapter 01-05](W08-03.md) -* [Week 08 Assignment #4: Finishing](W08-04.md) +* [Week 08 Assignment #1: Readings and Demos](W08-01) +* [Week 08 Assignment #2: Assignment Script](W08-02) +* [Week 08 Assignment #3: LFS 12.1 Chapter 01-05](W08-03) +* [Week 08 Assignment #4: Finishing](W08-04) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt @@ -202,10 +202,10 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 09 – Deadline: TBA. -* [Week 09 Assignment #1: Readings and Demos](W09-01.md) -* [Week 09 Assignment #2: Assignment Script](W09-02.md) -* [Week 09 Assignment #3: LFS 12.1 Chapter 06-07](W09-03.md) -* [Week 09 Assignment #4: Finishing](W09-04.md) +* [Week 09 Assignment #1: Readings and Demos](W09-01) +* [Week 09 Assignment #2: Assignment Script](W09-02) +* [Week 09 Assignment #3: LFS 12.1 Chapter 06-07](W09-03) +* [Week 09 Assignment #4: Finishing](W09-04) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt @@ -222,10 +222,10 @@ The Deadline is 7 (seven) days after the assignment was announced. [ℼ](#)
### OS Week 10 – Deadline: TBA. -* [Week 10 Assignment #1: Readings and Demos](W10-01.md) -* [Week 10 Assignment #2: Assignment Script](W10-02.md) -* [Week 10 Assignment #3: LFS 12.1 Chapter 08](W10-03.md) -* [Week 10 Assignment #4: Finishing](W10-04.md) +* [Week 10 Assignment #1: Readings and Demos](W10-01) +* [Week 10 Assignment #2: Assignment Script](W10-02) +* [Week 10 Assignment #3: LFS 12.1 Chapter 08](W10-03) +* [Week 10 Assignment #4: Finishing](W10-04) * Recheck folder "TXT/": * mylog.txt * mypubkey.txt diff --git a/docs/template.md b/docs/template.md index d5e01bb..926f617 100644 --- a/docs/template.md +++ b/docs/template.md @@ -6,6 +6,27 @@ hide: - toc --- +## Table of Contents + +1. [How to Prepare the Source Code](#how-to-prepare-the-source-code) + +2. [How to Install Requirements for MkDocs](#how-to-install-requirements-for-mkdocs) + +3. [How to Run MkDocs in a Web Browser](#how-to-run-mkdocs-in-a-web-browser) + 3.1 [Common Options for `mkdocs serve`](#common-options-for-mkdocs-serve) + +4. [How to Set Up GitHub Actions for Automated MkDocs Deployment](#how-to-set-up-github-actions-for-automated-mkdocs-deployment) + 4.1 [Preparing Your MkDocs Project for GitHub Actions](#preparing-your-mkdocs-project-for-github-actions) + 4.2 [Example CI Workflow Configuration](#example-ci-workflow-configuration) + 4.3 [Deployment Steps Explained](#deployment-steps-explained) + +5. [How to Change Header Color and Theme Using MkDocs Material](#how-to-change-header-color-and-theme-using-mkdocs-material) + +6. [How to Add Weekly Assignments and Any Other Materials in General](#how-to-add-weekly-assignments-and-any-other-materials-in-general) + 6.1 [Adding Weekly Assignments](#adding-weekly-assignments) + 6.2 [Adding Other Materials](#adding-other-materials) + 6.3 [Linking One Page to Another](#linking-one-page-to-another) + ## How to Prepare the Source Code 1. **Download the Source Code:** @@ -19,75 +40,59 @@ hide: ## How to Install Requirements for MkDocs -To set up MkDocs and `mkdocs-material` theme, run these commands: +To set up MkDocs and the `mkdocs-material` theme, run the following commands in your CLI: ```bash pip install mkdocs pip install mkdocs-material ``` -## How to Run MkDocs in a Web Browser - -After installation, you can start the MkDocs development server to preview your documentation locally. - -The command `mkdocs serve` launches a built-in server for easy preview and development. - -```bash -mkdocs serve [OPTIONS] -``` - -### Common Options for `mkdocs serve` - -| Option | Type | Description | Default | -|---------------------------------|----------------------|--------------------------------------------------------------------------------------------------|--------------------| -| `-a`, `--dev-addr` | text | IP address and port to serve documentation locally (default: `localhost:8000`). | None | -| `--no-livereload` | boolean | Disable live reloading in the development server. | False | -| `--dirty` | boolean | Only rebuild files that have changed. | False | -| `-c`, `--clean` | boolean | Build the site without effects of `mkdocs serve`; performs a pure build, then serves it. | False | -| `--watch-theme` | boolean | Watch the theme for live reloading. Ignored if live reload is off. | False | -| `-w`, `--watch` | path | Additional directories or files to watch for live reloading (can be specified multiple times). | `[]` | -| `-f`, `--config-file` | filename | Specify a custom MkDocs config file (filename or `-` to read from stdin). | None | -| `-s`, `--strict / --no-strict` | boolean | Enable strict mode, causing MkDocs to abort on warnings. | None | -| `-t`, `--theme` | choice (mkdocs \| readthedocs) | Specify the theme for building documentation. | None | -| `--use-directory-urls` | boolean | Use directory URLs when building pages (enabled by default). | None | -| `-q`, `--quiet` | boolean | Suppress warnings. | False | -| `-v`, `--verbose` | boolean | Enable verbose output. | False | -| `--help` | boolean | Display help information for `mkdocs serve`. | False | - ---- + ## How to Set Up GitHub Actions for Automated MkDocs Deployment ### Preparing Your MkDocs Project for GitHub Actions -To automate the deployment of your MkDocs project using GitHub Actions, you'll need to set up a specific directory structure and configuration files within your repository. Here's a step-by-step guide to get you started: +SKIP STEP 2-4 BECAUSE IT IS ALREADY GIVEN IN THE SOURCE CODE -1. **Create your GitHub repository:** - If you haven't already, create a new repository on GitHub to host your MkDocs project. +1. **Create Your GitHub Repository** + Start by creating a GitHub repository to host your MkDocs project if you haven’t already. + [Create New Repository on GitHub](https://github.com/new) 2. **Create the `.github` Directory:** - - Navigate to the root of your MkDocs project and create a new folder named `.github`. This directory will house the GitHub Actions workflows and other GitHub-specific configurations. + - Navigate to the root of your MkDocs project and create a new folder named `.github`. This directory will house the GitHub Actions workflows and other GitHub-specific configurations. 3. **Add a `workflows` Directory:** - - Inside the `.github` folder, create another folder named `workflows`. This is where all workflow configuration files will be stored. + - Inside the `.github` folder, create another folder named `workflows`. This is where all workflow configuration files will be stored. 4. **Create the CI Workflow File:** - * Within the `workflows` folder, create a file named `ci.yml`. This YAML file will define the Continuous Integration (CI) workflow that GitHub Actions will execute. + - Within the `workflows` folder, create a file named `ci.yml`. This YAML file will define the Continuous Integration (CI) workflow that GitHub Actions will execute. 5. **Configure the CI Workflow:** - * Open the `ci.yml` file and add the necessary steps to install MkDocs, build the site, and deploy it to GitHub Pages. See Example CI Workflow Configuration below. - -6. **Commit and Push Changes:** - * Once you've set up the CI workflow, commit the changes to your repository and push them to GitHub. This will trigger the CI workflow and deploy your MkDocs site. - -7. **Monitor the Workflow:** - * After pushing the changes, navigate to the "Actions" tab on your GitHub repository to monitor the progress of the CI workflow. You should see the workflow running and deploying your MkDocs site. - -8. **Access Your Deployed Site:** - * Once the workflow has completed successfully, you can access your deployed MkDocs site by visiting the GitHub Pages URL associated with your repository. To do this, open the "Settings" tab of your repository, scroll down to the "GitHub Pages" section, and find the URL under "Your site is published at." - -9. **Add Deployed Site Link to Repository Details:** - * To make it easier for visitors to access your deployed MkDocs site, consider adding the GitHub Pages URL to the repository details or the README file. To add the URL to the Repository Details, search for the "About" section on the right side of your repository page and click the gear icon to edit the details. You can then add the GitHub Pages URL under "Website." + - Open the `ci.yml` file and add the necessary steps to install MkDocs, build the site, and deploy it to GitHub Pages. See Example CI Workflow Configuration below. + [Example CI Workflow Configuration](#example-ci-workflow-configuration) + +6. **Commit and Push Changes:** + - Once your CI workflow is configured, commit your changes and push them to GitHub. + +7. **Set Up GitHub Pages Deployment:** + - Go to your repository’s settings, open the **Pages** section, and set the source to **Deploy from a branch**. +
+ - Set the deployment branch to `gh-pages`.
+ 
+ - Save your changes.
+ 
+
+8. **Access Your Deployed Site:**
+ - After the workflow completes successfully, refresh the GitHub Pages section and visit the GitHub Pages URL to access your MkDocs site.
+ 
+
+9. **Add the Deployed Site Link to Repository Details:**
+ - To make it easy for visitors to find your site, add the GitHub Pages URL to the repository details or the README file.
+ 
+ - In the "About" section, click the gear icon to add the URL under "Website" and save your changes.
+ 
+ - Save your changes.
### Example CI Workflow Configuration
@@ -135,9 +140,37 @@ jobs:
- **Install MkDocs Material:** Installs the MkDocs Material theme and other required Python packages.
- **Deploy to GitHub Pages:** Builds and deploys your MkDocs site to GitHub Pages using a force push to overwrite existing content.
-To change the header color using **MkDocs Material** without custom CSS, you can leverage the built-in `palette` feature in the `mkdocs.yml` configuration file. This method allows you to set primary and accent colors for the entire site, including the header.
+## How to Run MkDocs in a Web Browser
+
+After installation, you can start the MkDocs development server to preview your documentation locally.
+
+The command `mkdocs serve` launches a built-in server for easy preview and development.
+
+```bash
+mkdocs serve [OPTIONS]
+```
+
+### Common Options for `mkdocs serve`
+
+| Option | Type | Description | Default |
+|---------------------------------|----------------------|--------------------------------------------------------------------------------------------------|--------------------|
+| `-a`, `--dev-addr` | text | IP address and port to serve documentation locally (default: `localhost:8000`). | None |
+| `--no-livereload` | boolean | Disable live reloading in the development server. | False |
+| `--dirty` | boolean | Only rebuild files that have changed. | False |
+| `-c`, `--clean` | boolean | Build the site without effects of `mkdocs serve`; performs a pure build, then serves it. | False |
+| `--watch-theme` | boolean | Watch the theme for live reloading. Ignored if live reload is off. | False |
+| `-w`, `--watch` | path | Additional directories or files to watch for live reloading (can be specified multiple times). | `[]` |
+| `-f`, `--config-file` | filename | Specify a custom MkDocs config file (filename or `-` to read from stdin). | None |
+| `-s`, `--strict / --no-strict` | boolean | Enable strict mode, causing MkDocs to abort on warnings. | None |
+| `-t`, `--theme` | choice (mkdocs \| readthedocs) | Specify the theme for building documentation. | None |
+| `--use-directory-urls` | boolean | Use directory URLs when building pages (enabled by default). | None |
+| `-q`, `--quiet` | boolean | Suppress warnings. | False |
+| `-v`, `--verbose` | boolean | Enable verbose output. | False |
+| `--help` | boolean | Display help information for `mkdocs serve`. | False |
+
+---
-### Steps to Change Header Color and Theme Using MkDocs Material
+### How to Change Header Color and Theme Using MkDocs Material
* **Open Your `mkdocs.yml` Configuration File:**
- In your MkDocs project folder, locate and open the `mkdocs.yml` file.
@@ -250,7 +283,7 @@ theme:
To create links between pages, use the following markdown syntax:
```markdown
- [Link Text](path/to/page.md)
+ [Link Text](path/to/pageNameWithoutDotmd)
```
> **Note**: Do not include `docs` in the path, as it may prevent the link from working.