🚚 Move extras from instructor to learner view

bielsnohr · bielsnohr · commit 7c22e7926a05 · 2024-11-26T11:22:39.000Z
diff --git a/config.yaml b/config.yaml
@@ -98,12 +98,22 @@ episodes:
 
 # Information for Learners
 learners: 
+- quiz.md
 - learner-setup.md
-- vscode.md
+- common-issues.md
 - reference.md
+- vscode.md
+- software-architecture-extra.md
+- programming-paradigms.md
+- procedural-programming.md
+- functional-programming.md
+- object-oriented-programming.md
+- persistence.md
+- databases.md
 
 # Information for Instructors
 instructors: 
+- instructor-notes.md
 
 # Learner Profiles
 profiles: 
diff --git a/episodes/00-setting-the-scene.md b/episodes/00-setting-the-scene.md
@@ -154,7 +154,7 @@ intended for people who have already been developing code in Python (or other la
 and applying it to their own problems after gaining basic software development skills.
 So, it is expected for you to have some prerequisite knowledge on the topics covered,
 as outlined at the [beginning of the lesson](../index.md#prerequisites).
-Check out this [quiz](../instructors/quiz.md) to help you test your prior knowledge
+Check out this [quiz](../learners/quiz.md) to help you test your prior knowledge
 and determine if this course is for you.
 
 
@@ -165,7 +165,7 @@ and determine if this course is for you.
 ## Setup, Common Issues \& Fixes
 
 Have you [setup and installed](../learners/setup.md) all the tools and accounts required for this course?
-Check the list of [common issues, fixes \& tips](../instructors/common-issues.md)
+Check the list of [common issues, fixes \& tips](../learners/common-issues.md)
 if you experience any problems running any of the tools you installed -
 your issue may be solved there.
 
diff --git a/episodes/10-section1-intro.md b/episodes/10-section1-intro.md
@@ -62,7 +62,7 @@ Here is an overview of the tools we will be using.
 ## Setup, Common Issues \& Fixes
 
 Have you [setup and installed](../learners/setup.md) all the tools and accounts required for this course?
-Check the list of [common issues, fixes \& tips](../instructors/common-issues.md)
+Check the list of [common issues, fixes \& tips](../learners/common-issues.md)
 if you experience any problems running any of the tools you installed -
 your issue may be solved there.
 
@@ -83,7 +83,7 @@ and isolate our software project from other Python projects we may work on.
 
 ***Note:** some Windows users experience the issue where Python hangs from Git Bash
 (i.e. typing `python` causes it to just hang with no error message or output) -
-[see the solution to this issue](../instructors/common-issues.md#python-hangs-in-git-bash).*
+[see the solution to this issue](../learners/common-issues.md#python-hangs-in-git-bash).*
 
 ### Integrated Development Environment (IDE)
 
diff --git a/episodes/12-virtual-environments.md b/episodes/12-virtual-environments.md
@@ -213,7 +213,7 @@ $ python --version # on Windows — Windows installation comes with a python.exe
 ```
 
 If you are using Windows and invoking `python` command causes your Git Bash terminal to hang with no error message or output, you may
-need to create an alias for the python executable `python.exe`, as explained in the [troubleshooting section](../instructors/common-issues.md#python-hangs-in-git-bash).
+need to create an alias for the python executable `python.exe`, as explained in the [troubleshooting section](../learners/common-issues.md#python-hangs-in-git-bash).
 
 
 ::::::::::::::::::::::::::::::::::::::::::::::::::
diff --git a/episodes/32-software-architecture-design.md b/episodes/32-software-architecture-design.md
@@ -252,7 +252,7 @@ such as [Excalidraw](https://excalidraw.com/).
 ::::::::::::::::::::::::::::::::::::::::::::::::::
 
 We have been developing our software using the **Model-View-Controller** (MVC) architecture,
-but MVC is just one of the common [software architectural patterns](../instructors/software-architecture-extra.md)
+but MVC is just one of the common [software architectural patterns](../learners/software-architecture-extra.md)
 and is not the only choice we could have made.
 
 ### Model-View-Controller (MVC) Architecture
diff --git a/episodes/35-software-architecture-revisited.md b/episodes/35-software-architecture-revisited.md
@@ -318,16 +318,16 @@ Instead there are two rules which must be followed for these arguments:
 
 ### Additional Reading Material \& References
 
-Now that we have covered and revisited [software architecture](../instructors/software-architecture-extra.md)
-and [different programming paradigms](../instructors/programming-paradigms.md)
+Now that we have covered and revisited [software architecture](../learners/software-architecture-extra.md)
+and [different programming paradigms](../learners/programming-paradigms.md)
 and how we can integrate them into our architecture,
 there are two optional extra episodes which you may find interesting.
 
 Both episodes cover the persistence layer of software architectures
 and methods of persistently storing data, but take different approaches.
-The episode on [persistence with JSON](../instructors/persistence.md) covers
+The episode on [persistence with JSON](../learners/persistence.md) covers
 some more advanced concepts in Object Oriented Programming, while
-the episode on [databases](../instructors/databases.md) starts to build towards a true multilayer architecture,
+the episode on [databases](../learners/databases.md) starts to build towards a true multilayer architecture,
 which would allow our software to handle much larger quantities of data.
 
 ## Towards Collaborative Software Development
diff --git a/episodes/60-wrap-up.md b/episodes/60-wrap-up.md
@@ -139,8 +139,8 @@ and in which order you should consider learning skills.
 
 Below are some additional resources to help you continue learning:
 
-- [Additional episode on persisting data](../instructors/persistence.md)
-- [Additional episode on databases](../instructors/databases.md)
+- [Additional episode on persisting data](../learners/persistence.md)
+- [Additional episode on databases](../learners/databases.md)
 - [CodeRefinery courses on FAIR
   (Findable, Accessible, Interoperable, and Reusable)
   software practices][coderefinery-lessons]
diff --git a/index.md b/index.md
@@ -95,7 +95,7 @@ After going through this course, participants will be able to:
 ## Prerequisites
 
 Before joining this training, participants should meet the following criteria.
-(You can use [this short quiz](instructors/quiz.md) to test your prerequisite knowledge.)
+(You can use [this short quiz](learners/quiz.md) to test your prerequisite knowledge.)
 
 ### Git
 
diff --git a/instructors/instructor-notes.md b/instructors/instructor-notes.md
@@ -6,7 +6,7 @@ title: Instructor Notes
 
 ## Common Issues \& Tips
 
-Check out a [list of issues](../instructors/common-issues.md) previous participants of the course encountered
+Check out a [list of issues](../learners/common-issues.md) previous participants of the course encountered
 and some tips to help you with troubleshooting at the workshop.
 
 
diff --git a/learners/common-issues.md b/learners/common-issues.md
@@ -48,7 +48,7 @@ More details on command line prompt customisation can be found in this
 
 When accessing external services and websites
 (such as GitHub using `git` or to
-[install Python packages with `pip`](../instructors/common-issues.md#connection-issues-when-installing-packages-with-pip-over-vpn-or-protected-networks---proxy-needed)),
+[install Python packages with `pip`](../learners/common-issues.md#connection-issues-when-installing-packages-with-pip-over-vpn-or-protected-networks---proxy-needed)),
 you may experience connection errors
 (e.g. similar to `fatal: unable to access '....': Failed connect to github.com`)
 or a connection that hangs.
diff --git a/learners/databases.md b/learners/databases.md
diff --git a/learners/functional-programming.md b/learners/functional-programming.md
diff --git a/learners/learner-setup.md b/learners/learner-setup.md
@@ -16,7 +16,7 @@ to follow the course.
 ## Common Issues \& Tips
 
 If you are having issues installing or running some of the tools below,
-check a list of [common issues](instructors/common-issues.md) other course participants encountered and some useful tips for using the tools and working through the material.
+check a list of [common issues](learners/common-issues.md) other course participants encountered and some useful tips for using the tools and working through the material.
 
 
 ::::::::::::::::::::::::::::::::::::::::::::::::::
@@ -276,7 +276,7 @@ $ python --version # on Windows — Windows installation comes with a python.exe
 ```
 
 If you are using Windows and invoking `python` command causes your Git Bash terminal to hang with no error message or output, you may
-need to create an alias for the python executable `python.exe`, as explained in the [troubleshooting section](instructors/common-issues.md#python-hangs-in-git-bash).
+need to create an alias for the python executable `python.exe`, as explained in the [troubleshooting section](learners/common-issues.md#python-hangs-in-git-bash).
 
 If all is well with your installation, you should see something like:
 
diff --git a/learners/object-oriented-programming.md b/learners/object-oriented-programming.md
diff --git a/learners/persistence.md b/learners/persistence.md
diff --git a/learners/procedural-programming.md b/learners/procedural-programming.md
@@ -31,8 +31,8 @@ Key features of procedural programming include:
 
 To better understand procedural programming, it is useful to compare it with other prevalent
 programming paradigms such as
-[object-oriented programming](../instructors/object-oriented-programming.md) (OOP)
-and [functional programming](../instructors/functional-programming.md)
+[object-oriented programming](../learners/object-oriented-programming.md) (OOP)
+and [functional programming](../learners/functional-programming.md)
 to shed light on their distinctions, advantages, and drawbacks.
 
 Procedural programming uses a very detailed list of instructions to tell the computer what to do
@@ -43,11 +43,11 @@ structure (rather than iteration).
 Procedural languages treat data and procedures as two different
 entities whereas, in functional programming, code is also treated as data - functions
 can take other functions as arguments or return them as results.
-Compare and contract [two different implementations](../instructors/functional-programming.md#functional-vs-procedural-programming)
+Compare and contract [two different implementations](../learners/functional-programming.md#functional-vs-procedural-programming)
 of the same functionality in procedural and functional programming styles
 to better grasp their differences.
 
-Procedural and [object-oriented programming](../instructors/object-oriented-programming.md) have fundamental differences in their approach to
+Procedural and [object-oriented programming](../learners/object-oriented-programming.md) have fundamental differences in their approach to
 organising code and solving problems.
 In procedural programming, the code is structured around functions and procedures that execute a
 specific task or operations. Object-oriented programming is based around objects and classes,
@@ -58,7 +58,7 @@ objects.
 However, OOP goes further by encapsulating related data and methods within objects,
 enabling a higher level of abstraction and separation between different components.
 Inheritance and polymorphism are two vital features provided by OOP, which are not intrinsically
-supported by procedural languages. [Inheritance](../instructors/object-oriented-programming.md#inheritance) allows the creation of classes that inherit
+supported by procedural languages. [Inheritance](../learners/object-oriented-programming.md#inheritance) allows the creation of classes that inherit
 properties and methods from existing classes – enabling code reusability and reducing redundancy.
 [Polymorphism](../episodes/33-code-decoupling-abstractions.md#polymorphism) permits a single function or method to operate on multiple data types or objects,
 improving flexibility and adaptability.
diff --git a/learners/programming-paradigms.md b/learners/programming-paradigms.md
@@ -14,7 +14,7 @@ keypoints:
 
 ## Programming Paradigms
 
-In addition to [architectural decisions](../instructors/software-architecture-extra.md) on bigger components of your code, it is important
+In addition to [architectural decisions](../learners/software-architecture-extra.md) on bigger components of your code, it is important
 to understand the wider landscape of programming paradigms and languages,
 with each supporting at least one way to approach a problem and structure your code.
 In many cases, particularly with modern languages,
@@ -81,7 +81,7 @@ Functional Programming is a separate paradigm that
 places much stronger constraints on the behaviour of a function
 and structures the code differently as we will see soon.
 
-You can read more in an [extra episode on Procedural Programming](../instructors/procedural-programming.md).
+You can read more in an [extra episode on Procedural Programming](../learners/procedural-programming.md).
 
 ### Functional Programming
 
@@ -116,7 +116,7 @@ we also gain the ability to run many operations in parallel
 as it is guaranteed that each operation will not interact with any of the others -
 this is essential if we want to process this much data in a reasonable amount of time.
 
-You can read more in an [extra episode on Functional Programming](../instructors/functional-programming.md).
+You can read more in an [extra episode on Functional Programming](../learners/functional-programming.md).
 
 ### Object Oriented Programming
 
@@ -144,7 +144,7 @@ Most people would classify Object Oriented Programming as an
 (with the extra feature being the objects), but
 [others disagree](https://stackoverflow.com/questions/38527078/what-is-the-difference-between-imperative-and-object-oriented-programming).
 
-You can read more in an [extra episode on Object Oriented Programming](../instructors/object-oriented-programming.md).
+You can read more in an [extra episode on Object Oriented Programming](../learners/object-oriented-programming.md).
 
 ## Other Paradigms
 
@@ -154,8 +154,8 @@ for much more information see the Wikipedia's page on
 [programming paradigms](https://en.wikipedia.org/wiki/Programming_paradigm).
 
 We have mainly used Procedural Programming in this lesson, but you can
-have a closer look at [Functional](../instructors/functional-programming.md) and
-[Object Oriented Programming](../instructors/object-oriented-programming.md) paradigms
+have a closer look at [Functional](../learners/functional-programming.md) and
+[Object Oriented Programming](../learners/object-oriented-programming.md) paradigms
 in extra episodes and how they can affect our architectural design choices.
 
 
diff --git a/learners/quiz.md b/learners/quiz.md
diff --git a/learners/setup.md b/learners/setup.md
@@ -4,7 +4,7 @@
 
 Please make sure that you have all the necessary software and accounts setup ahead of the workshop
 as described in the [Setup](learners/learner-setup.md) section.
-Also check the list of [common issues, fixes \& tips](instructors/common-issues.md)
+Also check the list of [common issues, fixes \& tips](learners/common-issues.md)
 if you experience any problems running any of the tools you installed -
 your issue may be solved there.
 
diff --git a/learners/software-architecture-extra.md b/learners/software-architecture-extra.md
@@ -37,7 +37,7 @@ but larger scale templates which operate at the level of whole programs,
 or collections or programs.
 Model-View-Controller (which we chose for our project) is one of the best known architecture
 patterns.
-Many patterns rely on concepts from [Object Oriented Programming](../instructors/object-oriented-programming.md).
+Many patterns rely on concepts from [Object Oriented Programming](../learners/object-oriented-programming.md).
 
 There are many online sources of information about design and architecture patterns,
 often giving concrete examples of cases where they may be useful.
