mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 14:55:51 +00:00
Merge branch 'release' into languages
This commit is contained in:
Tom van Woudenberg
commit
eefe5cc97c
7 changed files with 11 additions and 28 deletions
|
|
@ -11,10 +11,6 @@ only_build_toc_files: true
|
|||
html:
|
||||
favicon : "images/favicon.ico"
|
||||
baseurl : "https://teachbooks.io/manual/"
|
||||
# START REMOVE-FROM-PUBLISH
|
||||
comments:
|
||||
hypothesis: true
|
||||
# END REMOVE-FROM-PUBLISH
|
||||
|
||||
sphinx:
|
||||
extra_extensions:
|
||||
|
|
@ -23,6 +19,7 @@ sphinx:
|
|||
- download_link_replacer
|
||||
- jupyterbook_patches
|
||||
- teachbooks_sphinx_grasple
|
||||
- sphinx_image_inverter
|
||||
config:
|
||||
html_js_files:
|
||||
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Below you see an example of this feature!
|
|||
|
||||
## Example discussion
|
||||
<script src="https://utteranc.es/client.js"
|
||||
repo="TeachBooks/utterances_manual"
|
||||
repo="TeachBooks/manual"
|
||||
issue-term="pathname"
|
||||
theme="github-light"
|
||||
crossorigin="anonymous"
|
||||
|
|
|
|||
|
|
@ -12,11 +12,13 @@ Truss structures are structures assembled of straight elements connected in node
|
|||
Examples of these structures are commonly found in rail bridges like the one below:
|
||||
|
||||
```{figure} theory_questions_images/pic0.jpg
|
||||
:class: dark-light
|
||||
:width: 400
|
||||
```
|
||||
Furthermore, these structures are commonly found in building as well, both invisible and visible:
|
||||
|
||||
```{figure} theory_questions_images/pic1.jpg
|
||||
:class: dark-light
|
||||
:width: 400
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The setup of tools and URLs is dependent on agreements you've made on [collabora
|
|||
Provide explanation on how you organize the book-editing and how you'd like to receive feedback in both the readme as the published book. The use of the [issue button](https://jupyterbook.org/en/stable/basics/repository.html#add-a-button-to-open-issues) is advised for the published book.
|
||||
|
||||
## Branches for separate versions
|
||||
We recommend using at least two separate branches, one which is released to students, the other on for development. If you're planning adapting the book every year, you should set up your branches in such a way that students will always receive the version they should expect.
|
||||
We recommend using at least two separate branches, one which is released to students, the other one for development. If you're planning adapting the book every year, you should set up your branches in such a way that students will always receive the version they should expect.
|
||||
|
||||
Firstly, create a release branch which contains the students' version of this year. This branch could be named `release`, `main`, or `<current academic year>`. It is recommended to set this branch as the `PRIMARY BRANCH` when using the [GitHub workflow](gh-workflow-settings). This ensures that students are redirected to a consistent URL, even when new versions of the book are added later. If you plan on maintaining only one public version, it is advisable to set `BEHAVIOR_PRIMARY` from the default `redirect` to `copy`. This ensures that the primary branch is copied to the root, making the URL more compact.
|
||||
|
||||
|
|
@ -93,4 +93,4 @@ Here's a table summarizing the information:
|
|||
| GitHub Desktop | Well integrated 😎 | Basic integration 🙂 |
|
||||
| Utteranc.es | Can be linked to same repository 🏷️ | Requires GitHub repository next to GitLab repository 🏷️🏷️|
|
||||
|
||||
If you have doubt about this choice, we advise you to start on GitHub. Moving/duplicating your content to GitLab or hosting to a custom URL is always possible at a later stage.
|
||||
If you have doubt about this choice, we advise you to start on GitHub. Moving/duplicating your content to GitLab or hosting to a custom URL is always possible at a later stage.
|
||||
|
|
|
|||
|
|
@ -83,6 +83,7 @@ name: Clone_GitHub
|
|||
Clone using SSH
|
||||
```
|
||||
|
||||
``````
|
||||
``````{tab-item} ... GitHub through GitHub Desktop
|
||||
|
||||
1. Open the repository that you would like to clone. In the top bar on the right, you will a green button called `<> Code`.
|
||||
|
|
|
|||
|
|
@ -197,17 +197,11 @@ After committing, click the 🔄 button to push our changes to the remote reposi
|
|||
|
||||
3. Add changes to Git-timeline locally (committing). In the field that says `Summary(Required)`, write a short description of the changes you have made. This message is what is called the *Commit Message*. After we've done this, click the blue button `Commit to repository`.
|
||||
|
||||
4. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repository. After committing, the following screen will pop up. Click on `Push Origin`.
|
||||
4. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repository. After committing, click on `Push origin` in the top bar.
|
||||
|
||||
<figure align="center">
|
||||
<img src="figures/Push_GitHubDesktop.PNG" alt="Example Image" width="650">
|
||||
</figure>
|
||||
|
||||
Alternatively, you can also click on `Push origin` in the top bar.
|
||||
|
||||
<figure align="center">
|
||||
<img src="figures/Push_GitHubDesktop2.PNG" alt="Example Image" width="650">
|
||||
</figure>
|
||||
````
|
||||
`````
|
||||
``````
|
||||
|
|
@ -313,18 +307,12 @@ Choose one of the options to resolve the merge conflict. You now have updated yo
|
|||
|
||||
5. Add changes to Git-timeline locally (committing). In the field that says `Summary(Required)`, write a short description of the changes you have made. This message is what is called the *Commit Message*. After we've done this, click the blue button `Commit to repository`.
|
||||
|
||||
6. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repository. After committing, the following screen will pop up. Click on `Push Origin`.
|
||||
6. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repository. After committing, click on `Push origin` in the top bar.
|
||||
|
||||
<figure align="center">
|
||||
<img src="figures/Push_GitHubDesktop.PNG" alt="Example Image" width="650">
|
||||
</figure>
|
||||
|
||||
Alternatively, you can also click on `Push origin` in the top bar.
|
||||
|
||||
<figure align="center">
|
||||
<img src="figures/Push_GitHubDesktop2.PNG" alt="Example Image" width="650">
|
||||
</figure>
|
||||
|
||||
````
|
||||
````{tab-item} ... using 'VS Code in your browser'
|
||||
|
||||
|
|
@ -686,16 +674,10 @@ If your book includes interactive element a webserver is required to host the bo
|
|||
|
||||
6. Add changes to Git-timeline locally (committing). In the field that says `Summary(Required)`, write a short description of the changes you have made. This message is what is called the *Commit Message*. After we've done this, click the blue button `Commit to repository`.
|
||||
|
||||
7. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repository. After committing, the following screen will pop up. Click on `Push Origin`.
|
||||
7. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repository. After committing, click on `Push origin` in the top bar.
|
||||
|
||||
<figure align="center">
|
||||
<img src="figures/Push_GitHubDesktop.PNG" alt="Example Image" width="650">
|
||||
</figure>
|
||||
|
||||
Alternatively, you can also click on `Push origin` in the top bar.
|
||||
|
||||
<figure align="center">
|
||||
<img src="figures/Push_GitHubDesktop2.PNG" alt="Example Image" width="650">
|
||||
</figure>
|
||||
````
|
||||
````{tab-item} ... using 'VS Code in your browser'
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue