Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
16 changed files
with
766 additions
and
156 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
mk-docs | ||
arris |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
--- | ||
title: "A guide to the module materials" | ||
--- | ||
|
||
# A Guide to Module Materials | ||
|
||
While we will be using Aula to drive the module materials, all of the content | ||
written is also available on GitHub Pages. | ||
<!-- Because AULA doesn't even support Fucking Section headings --> | ||
Here is a quick overview of the conventions I will use here, where I get a few more formatting options. | ||
|
||
!!! important "Accessibility" | ||
|
||
One reason I have used the GitHub / Markdown approach in the past, is to help students with | ||
accessibility issues. For example, I find it really hard to work outside of "Dark Mode". | ||
|
||
If you want to talk to me about this, please do, there is a heck of a lot we can do with | ||
formatting that can help address any requirements you have. | ||
|
||
## Dark and Light Mode: | ||
|
||
Personally, I hate light mode, the contrast seems to make things much harder to | ||
read, but I also appreciate it not for everyone. Therefore, I have written a plugin for mkdocs that means you also have the option to read | ||
text in a format that works for you. | ||
|
||
!!! info | ||
|
||
I am using localstorage on your browser to remember your preferences, | ||
this means that no details get sent to the server. | ||
|
||
Feel free to use the View Page Source (++ctrl+u++) or Inspect Element (++rbutton+q++) to check my working | ||
|
||
## Footnotes | ||
|
||
Will be used either to: | ||
|
||
- refer to other material (like a citation) | ||
- As a note on something[^hidden-notes] | ||
|
||
## Breakout Boxes | ||
|
||
Throughout the text I will be using breakout boxes. | ||
I will use this as a way to highlight important points or make tasks clear. | ||
|
||
I also use notes to replace the side-tracks that I tend to go down when | ||
giving lectures... | ||
|
||
!!! discuss | ||
|
||
A question to think about and discuss on the Aula | ||
It will usually come with a ```#tag``` | ||
|
||
!!! task | ||
|
||
A practical task to complete. | ||
I love learning through doing. So we will have lots | ||
of practical activities to complete. | ||
|
||
There are also different levels of task | ||
|
||
!!! easytask "Easy Task" | ||
|
||
You **should** be able to do this to pass the module | ||
|
||
!!! task "Task" | ||
|
||
Being able to complete this should give you a decent grade. | ||
|
||
!!! hardtask "Hard Task" | ||
|
||
**Optional** harder task for those who want to test their skills | ||
|
||
|
||
|
||
|
||
!!! note | ||
|
||
Something interesting that I would add as a side note in | ||
lectures. (It replaces me side-tracking myself). | ||
|
||
|
||
!!! example | ||
|
||
An example of whatever we have been talking about. | ||
|
||
!!! warning | ||
|
||
Lets you know something is important. | ||
Its probably a good idea to pay attention. | ||
|
||
|
||
!!! info | ||
|
||
Another way of talking about something interesting. Usually technical. | ||
|
||
!!! tip | ||
|
||
A Tip, or other thing that might be worth knowing | ||
|
||
|
||
## Spotted a Bug or Typo | ||
|
||
Well done. Writing this module was hard because of how much content | ||
went into it, and the nature of the topic. Just like writing code, | ||
it's not possible to be 100% bug-free and although I try to catch any problems, | ||
inevitably some will slip through the gaps[^custom-dict] | ||
|
||
The "minimising" step here is to try to get multiple people reading the | ||
material in advance of the module start, using a spell-checker, and | ||
developing in an environment that allows for version control, | ||
separation of content and presentation, reducing duplication and the | ||
chance for drift, etc. [^toolchain] | ||
|
||
As for catching bugs that make it through that process: you're the | ||
beta tester. If you find a bug, typo, factual error or even just have | ||
a good idea for improvement, let me know. Drop me a message at | ||
([aa9863@coventry.ac.uk](mailto:aa9863@coventry.ac.uk)). Unless you | ||
prefer to remain anonymous, you will be credited as a contributor to | ||
the page. | ||
|
||
[^toolchain]: Markdown, MKDocs, Git | ||
[^custom-dict]: You do not want to see the custom dictionary to get rid of the | ||
"red squiggles", spell checkers do not like assembly code. | ||
[^hidden-notes]: There may even be notes that are less visible. You are hackers, you know the drill. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: "Teaching and Learning" | ||
--- | ||
|
||
|
||
# How You will get Taught | ||
|
||
Due to the Plague[^not-that-plague] the module will be mostly online. | ||
While this is good in a couple of ways: You get to study when you want, no | ||
trekking into the Uni at 9AM, or having to buy extortionate Starbucks coffee. It | ||
does mean that you are more responsible for your own learning. | ||
|
||
Module materials will be delivered through the following: | ||
|
||
## Offline Pre-Reading | ||
|
||
Each week you will have some offline pre-reading work. | ||
This will usually consist of some reading materials (hosted here), | ||
videos. and depending on the topic, a demo task to help you work through the | ||
concepts. | ||
|
||
!!! tip "Reading the Pre-Reading" | ||
|
||
It's going to make your life so much easier if you read the materials before the "lecture" takes place (or at least in the same week as the materials). | ||
It means, at the least, you can ask questions relevant to bits you dont understand in the Lecture session. | ||
|
||
Also, there's a lot to cover, stuff builds on other topics, and trying to cram in the last few weeks probably isn't going to work[^hate-failing] | ||
|
||
## Online "Lecture" | ||
|
||
We will also have an online Lecture / Lab session. | ||
|
||
In these sessions we will have: | ||
|
||
- A recap of the week's materials, as a short[^short-lecture] lecture. | ||
- Q&A Session on the topics | ||
- Walkthrough / Practical tasks related to the work we do. | ||
|
||
|
||
!!! important | ||
|
||
I will be recording the lectures, so you can go back over them later | ||
|
||
However, the notes about doing things in the relevant week still stand. There's 11 weeks of materials, | ||
I suspect we will be having 2 hour lectures, cramming 22+ hours of videos into one week of learning isn't going to be pleasant. | ||
|
||
|
||
[^not-that-plague]: [Sadly not this Plague](https://youtu.be/LkqKFamTkME) | ||
[^short-lecture]: For a given value of short. | ||
[^hate-failing]: I hate failing people, it always makes me feel guilty.[^fail-note] | ||
[^fail-note]: However, that doesn't mean you can expect to pass without doing | ||
some work. While I am happy to help explain things, being asked to pull your arris | ||
out of the fire by covering the whole module in the last two weeks tends to put me | ||
in a bad mood. |
Oops, something went wrong.