Added user type indication to installation pages

This commit is contained in:
Tom van Woudenberg 2024-04-11 09:31:23 +02:00
parent 5b126cfc06
commit 6a3f7c2710
10 changed files with 52 additions and 0 deletions

View file

@ -1,4 +1,10 @@
# Getting Anaconda to work in terminal
```{admonition} User types
:class: tip
This page is useful for user type 5-6.
```
(vscode-setup-bash)=
````{tab} Windows - Git Bash (preferred)

View file

@ -1,5 +1,10 @@
# Anaconda
```{admonition} User types
:class: tip
This page is useful for user type 5-6.
```
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. You can download the installation files [here](https://www.anaconda.com/download).
When installing Anaconda, keep in mind the following:

View file

@ -1,5 +1,10 @@
# Creating python environments
```{admonition} User types
:class: tip
This page is useful for user type 5-6.
```
A python virtual environment is, like the name might suggest, a reserved space within the computer that contains downloaded python packages. Each environment is like a clean slate and the packages and dependencies of one environment have no ifluence on other environments. In that sense, it makes sense to create a new (working) environment every time you start a new project.
## Set-up environments

View file

@ -1,5 +1,10 @@
# What is Git and GitLab?
```{admonition} User types
:class: tip
This page is useful for user type 3-6.
```
In this section you will learn how to perform basic Git actions in the online interface of GitLab.
## What is Git?

View file

@ -1,5 +1,10 @@
# How do I use Git locally?
```{admonition} User types
:class: tip
This page is useful for user type 4-6.
```
In this section you will learn how to perform basic Git actions in VS Code / GitHub Desktop. Courses on Git usually make use of the command line interface to do these actions, 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.
## GitHub Desktop

View file

@ -1,5 +1,10 @@
# Jupyter Book
```{admonition} User types
:class: tip
This page is useful for user type 5-6.
```
Jupyter Book is just a regular Python package, so it can be installed by using `pip` or `conda`:
```

View file

@ -1,5 +1,10 @@
# VS Code
```{admonition} User types
:class: tip
This page is useful for user type 4-6.
```
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.
## Installation

View file

@ -1,4 +1,10 @@
# Navigate to your working directory
```{admonition} User types
:class: tip
This page is useful for user type 5-6.
```
You will need to know this to set up environments from a text-based file.
The essential command is `cd FILE_PATH`, which will navigate the terminal window to the directory at `FILE_PATH`. Note that although `cd` works on both Windows and Mac, many command line commands are different between the two.

View file

@ -1,5 +1,10 @@
# Collaborative book-editing
```{admonition} User types
:class: tip
This page is useful for user type 3-6.
```
As previously mentioned there are multiple platforms that can host Git repositories which are extremely useful for collaboration on text-based files. Here we will elaborate on two: GitLab and GitHub both in the online environment and locally.
Globally, the steps involved are as follows:

View file

@ -1,5 +1,10 @@
# Your first TeachBook using template
```{admonition} User types
:class: tip
This page is useful for user type 3-6.
```
This page shows you how as an example how to start your own Jupyter Book and hosting that book online. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book.
`````{tab-set}