user types in margins

book/installation-and-setup/anaconda.md

@@ -1,9 +1,11 @@
-# Managing code-related software: Anaconda
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 5.
 ```
+````
+
+# Managing code-related software: Anaconda
 
 Before you can start using python in your book, you need Anaconda. 'Anaconda's conda tool simplifies package and environment management across operating systems' (Anaconda.com), such as windows or MacOS. It makes getting started with python a lot easier because it already has a lot of useful python packages pre-installed. Unfortunately, each of these packages are themselves require a number of different packages to function properly. Do you like installing all of them? You shouldn't---but where do you get them come from? Many of those packages are packages required by only a few specific packages. These packages are called _dependencies_, and are necessary to make your Python packages function as expected. When you run install a specific package, `conda` (part of Anaconda) checks all of the dependent packages that are needed and makes sure they are also provided in the `environment` (collection of software with a specific version) that is being created. In reality, this is simply a folder on your computer with all of the `*.py` files stored in it. This _package management_ is what `conda` and `pip` are really doing when you use them to install a package. It also checks that it has a suitable _version_ of each dependency; this is why it sometime takes a long time to install a package Unfortunately, this means that as you add more packages to a particular environment, it gets more and more difficult to make sure everything works well together. Luckily, there is a practical solution: create new environments for specific projects to make sure the proper packages can function properly!
 

book/installation-and-setup/collab.md

@@ -1,9 +1,11 @@
-# Organize editing team, collaboration and visibility
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 4-5.
 ```
+````
+
+# Organize editing team, collaboration and visibility
 
 ## Roles and responsibilities
 To ensure smooth collaboration, it is essential to define the roles and responsibilities within your team. Firstly, designate who will be in charge of team organization ('administrators') who should be at least user type 4. Additionally, assign 'maintainers' responsible for combining content, also requiring at least user type 4. 'Editors' should be identified for editing and reviewing content, requiring at least user type 3.

book/installation-and-setup/git-setup_local.md

@@ -1,9 +1,11 @@
-# Git: GitHub Desktop / Git in VS Code
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 4 and 5.
 ```
+````
+
+# Git: GitHub Desktop / Git in VS Code
 
 In this section you will learn how to install Git locally. Courses on Git usually make use of the command line interface to do run Git, but this introduces a steep learning curve. Instead, using Git from VS Code / GitHub Desktop is much more visual (i.e., more "clicky"), and therefore easier to use for those inexperienced with the command line.
 

book/installation-and-setup/git.md

@@ -1,9 +1,11 @@
-# Collaboration tool: Git
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 3-5.
 ```
+````
+
+# Collaboration tool: Git
 
 You will need to interact with Git to collaborate on a TeachBook, even if you are working by yourself! You've been introduced to it in the [exercises in the template](../intro/template.md) and you'll be guided through all of the steps in detail in [](../workflows/collaboration.md), but what is this "thing" that sounds suspiciously like something only a computer scientist would want to use?
 

book/installation-and-setup/git_bash_conda_vs-code.md

@@ -1,9 +1,11 @@
-# Combining Git Bash, VS Code and Conda
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 5.
 ```
+````
+
+# Combining Git Bash, VS Code and Conda
 
 ## Conda in Git Bash
 Git Bash is a shell (also referred to as "the terminal") that is automatically installed with git. It provides Unix-like commands on a Windows OS, and is recommended for working with open source projects like Jupyter (for example `pip install`, building Jupyter books, using Git Bash in VS Code, etc). To do this, `conda` needs to be setup properly; this is described here:

book/installation-and-setup/jupyter-book-setup.md

@@ -1,9 +1,11 @@
-# Build your book: JupyterBook
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 5.
 ```
+````
+
+# Build your book: JupyterBook
 
 <a href="https://jupyterbook.org/"><img  style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the these features and adds [additional features](../features/overview.md). One of those additional features, for example, is the workflow to GitHub Pages. 
 

book/installation-and-setup/overview.md

@@ -1,9 +1,11 @@
-# Install & authenticate required software
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 4-5.
 ```
+````
+
+# Install & authenticate required software
 
 Now that the types of users have been explained, you might have an idea which type corresponds to you! 
 

book/installation-and-setup/tools.md

@@ -1,9 +1,11 @@
-# Which git provider to choose
-
+````
 ```{admonition} User types
 :class: tip
 This page is useful for user type 4-5.
 ```
+````
+
+# Which git provider to choose
 
 The setup of tools and URLs is dependent on agreements you've made on [collaboration](./collab.md).
 

book/installation-and-setup/versioning.md

@@ -1,9 +1,11 @@
-# Versioning and URLs
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 4-5.
 ```
+````
+
+# Versioning and URLs
 
 Online books can be easily updated, however, this might confuse readers. Therefore, it's good practice to be aware of this and, where needed, provide an explicit version to the readers.
 

book/installation-and-setup/vscode-setup.md

@@ -1,9 +1,11 @@
-# Editing text: VS Code
-
+````{margin}
 ```{admonition} User types
 :class: tip
 This page is useful for user type 4 and 5.
 ```
+````
+
+# Editing text: VS Code
 
 VS Code is a text editor with some extra features, such as integrated source control and a file browser. Moreover, extensions are available to add functionality to VS Code.