admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

set1

Browse source
This commit is contained in:
Julie Kirsch 2024-11-05 20:12:13 +01:00
parent 2b50697517
commit d677a5a718
6 changed files with 31 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

28
book/_toc.yml
View file

@ -4,23 +4,23 @@ root: intro
parts:
- caption: Getting started!
chapters:
- file: installation-and-setup/user_types
- file: installation-and-setup/git
- file: installation-and-setup/overview
- file: installation-and-setup/user_types.md
- file: installation-and-setup/git.md
- file: installation-and-setup/overview.md
sections:
- file: installation-and-setup/vscode-setup
- file: installation-and-setup/git-setup_local
- file: installation-and-setup/anaconda
- file: installation-and-setup/vscode-setup.md
- file: installation-and-setup/git-setup_local.md
- file: installation-and-setup/anaconda.md
- file: installation-and-setup/git_bash_conda_vs-code.md
- file: installation-and-setup/jupyter-book-setup
- file: installation-and-setup/jupyter-book-setup.md
- file: external/template/README.md
- file: workflows/collaboration
- file: workflows/collaboration.md
sections:
- file: workflows/milestones_issues
- file: workflows/branches
- file: workflows/edit_book
- file: workflows/check_changes_online
- file: workflows/merge_request
- file: workflows/milestones_issues.md
- file: workflows/branches.md
- file: workflows/edit_book.md
- file: workflows/check_changes_online.md
- file: workflows/merge_request.md
- file: installation-and-setup/collab
- file: installation-and-setup/tools
- file: installation-and-setup/creating_content.md
@ -39,7 +39,7 @@ parts:
title: Banner or Announcement
- file: basic-features/hypothesis.md
- file: basic-features/utterances.md
- file: features/overview
- file: features/overview.md
sections:
- file: external/TeachBooks/README.md
- file: external/deploy-book-workflow/README.md

4
book/basic-features/equations.md
View file

@ -37,9 +37,9 @@ Resulting in:
$$
F = m \cdot a
$$ (newtons_second_law_2)
$$ (show_newtons_second_law)
Equation {eq}`newtons_second_law_2` can now be referred to.
Equation {eq}`show_newtons_second_law` can now be referred to.
> **Note**
>

2
book/installation-and-setup/jupyter-book-setup.md
View file

@ -32,7 +32,7 @@ Note: use `--all` for the jupyter-book whenever building a book to make sure the
Once the build process is completed successfully, you will see the file location in your terminal output. Your terminal will look something like this. Simply open this in the browser (you may have to copy/paste).
```{figure} ./figures/Terminal.PNG
```{figure} figures/Terminal.PNG
---
width: 80%
name: terminal

16
book/workflows/branches.md
View file

@ -211,8 +211,8 @@ The branch selection menu, where our new branch has shown up. From this menu you
Since you are working in a repository with multiple colleagues, it is good practice to make sure your local repository is up to date. This is especially important when you want to work in an existing branch. In that case you want to make sure that the existing branch shows in your local repository. Therefore, you first need to pull all the changes from the remote repository to your local repository. Simply click the Icon with the two arrows.
```{figure} ../figures/Pull_VS.PNG
:name: Pull_VS
```{figure} figures/Pull_VS.PNG
name: Pull_VS
Location of the branch menu.
```
@ -226,17 +226,21 @@ The next step is to *check out* our new branch in GitHub Desktop. *Checking out*
In GitHub Desktop, the top bar has a menu called `Current Branch`. By clicking on it you can see all the branches you created on the remote repository.
```{figure} ../figures/CheckOutBranch_GitHubDesktop.PNG
```{figure} figures/CheckOutBranch_GitHubDesktop.PNG
Branches overview
```
2. Check out the branch by simply clicking on it. The following window will pop up.
```{figure} ../figures/CheckOutBranch_GitHubDesktop2.PNG
```{figure} figures/CheckOutBranch_GitHubDesktop2.PNG
Leave changes
```
Leave your changes (stashed) on your working branch, in this case I was working in the branch called `collaboration git`.
3. Check that the branch is indeed checked out by looking at the branch menu at the the top left again; the current branch should say the name.
4. Update your repository**
4. Update your repository
Since you are working in a repository with multiple colleagues, it is good practice to make sure your local repository is up to date. This is especially important when you want to work in an existing branch. In that case you want to make sure that the existing branch shows in your local repository. Therefore, you first need to pull all the changes from the remote repository to your local repository.
@ -249,7 +253,7 @@ This synchronizes the remote repository with your local repository on your compu
``````
```````
**Now that you have created and checked out your new branch, you can start {ref}`making and committing changes <stage-commit-push>`.**
**Now that you have created and checked out your new branch, you can start [making and committing changes](edit_book.md).**
````````
`````````

6
book/workflows/merge_request.md
View file

@ -15,7 +15,7 @@ We're finished with our chapter, and now it's time to include all of our commits
2. Go the repository overview on GitLab. In the left menu bar, go to "Merge requests". On the Merge requests page, click "New merge request".
3. You can now choose a source branch and a target branch. Since we want to merge our changes from `chapter-2` *into* `main`, `chapter-2` is the source branch and `main` is the target branch ({numref}`gitlab-merge-request`) . Once you've selected the correct branches, click "Compare branches and continue".
3. You can now choose a source branch and a target branch. Since we want to merge our changes from `chapter-2` *into* `main`, `chapter-2` is the source branch and `main` is the target branch. Once you've selected the correct branches, click "Compare branches and continue".
```{figure} ../images/gitlab-merge-request.png
name: gitlab-merge-request
@ -23,7 +23,7 @@ name: gitlab-merge-request
Creating a new merge request to merge `chapter-2` into `main`.
```
4. On the next page, you can give your merge request a name, and provide a description of your changes ({numref}`gitlab-merge-request-description`). If somebody has to review your changes, you can add them in the "Reviewer menu". They will then be notified via email that they need to review your work. Finally, watch out for the option "Delete source branch when merge request is accepted". If you want to keep working on the same branch, even after your previous work has been merged, make sure you untick the box! Once everything is filled in, click "Create merge request".
4. On the next page, you can give your merge request a name, and provide a description of your changes. If somebody has to review your changes, you can add them in the "Reviewer menu". They will then be notified via email that they need to review your work. Finally, watch out for the option "Delete source branch when merge request is accepted". If you want to keep working on the same branch, even after your previous work has been merged, make sure you untick the box! Once everything is filled in, click "Create merge request".
```{figure} ../images/gitlab-merge-request-description.png
name: gitlab-merge-request-description
@ -49,7 +49,7 @@ Once you are done, click on `Commit to source branch`. Do this for all conflicte
In case you have cloned the repositery you can also resolve the conflicts locally using VS Code for example. You can read more about for [GitHub Dekstop](edit_book.md#... GitHub Desktop) or [VS Code](edit_book.md#... VS Code)
6. On the page of our merge request ({numref}`gitlab-finished-merge-request`), we're greeted with some more information. On top, you can read the description we just provided when creating the merge request. We can also see an "Approve" button, which you may or may not see, depending on your repository rights. Next, we can see a green checkmark, with a "Merge" button. This is good news: our changes do not conflict with existing files on the `main` branch, and we can merge our changes directly by clicking the button (if applicable: only after somebody else approved the request).
6. On the page of our merge request, we're greeted with some more information. On top, you can read the description we just provided when creating the merge request. We can also see an "Approve" button, which you may or may not see, depending on your repository rights. Next, we can see a green checkmark, with a "Merge" button. This is good news: our changes do not conflict with existing files on the `main` branch, and we can merge our changes directly by clicking the button (if applicable: only after somebody else approved the request).
```{figure} ../images/gitlab-finished-merge-request.png
name: gitlab-finished-merge-request

4
book/workflows/new_branch_github.md
View file

@ -1,9 +1,7 @@
How to branch is demonstrated in the figure below, all steps are elaborated on in the following step-by-step tutorial.
```{figure} figures/branching-github-ezgif.com-optimize.gif
---
name: branching_demo
---
Demonstration, video available [here](https://youtu.be/3ceMSLQpD70)
```