diff --git a/book/workflows/check_changes_online.md b/book/workflows/check_changes_online.md index bc0e134..d80f047 100644 --- a/book/workflows/check_changes_online.md +++ b/book/workflows/check_changes_online.md @@ -2,14 +2,16 @@ Now that you've pushed your changes online, it's time to check the change in the online build book to make sure that your changes are processed correctly. For this step it is assumed you're using TeachBook's GitHub actions or TeachBook's GitLab pipeline. - `````{tab-set} ````{tab-item} In GitLab + At the moment this is not possible, but the workflow will soon be the same as for GitHub. ```` ````{tab-item} In GitHub + - Wait for the action to finish (GitHub Desktop shows progress if its part of a pull request, VS Code shows progress with the GitHub Actions addon) - Visit the website of your build book + ```{error} To be written ``` ````` diff --git a/book/workflows/edit_book.md b/book/workflows/edit_book.md index 8c1d917..75c6363 100644 --- a/book/workflows/edit_book.md +++ b/book/workflows/edit_book.md @@ -21,7 +21,7 @@ In GitLab, you can directly make changes in the files on the remote repositery. Example Image -3. In the new window, you can start typing your content. Once you are done, commit the new file to the repositery by clicking the blue button `Commit changes`. +3. In the new window, you can start typing your content. Give your file a name and make sure to use the markdown extension: `Chapter1.md`. Once you are done, commit the new file to the repositery by clicking the blue button `Commit changes`.
Example Image @@ -38,6 +38,14 @@ In GitLab, you can directly make changes in the files on the remote repositery.
Example Image
+ +6. In case you added a new file, you also need to include it table of contents of your book! The table of contents is specified in a file called `toc.yml` and it is already included in your repositery if you used the teachbooks template. + +
+ Example Image +
+ +You can edit it and commit the changes in the same manner as with markdown (.md) files. ```` ````{tab-item} ... GitHub @@ -51,7 +59,7 @@ In GitHub, you can directly make changes in the files on the remote repositery. Example Image
-3. In the new window, you can start typing your content. Once you are done, commit the new file to the repositery by clicking the green button `Commit changes`. +3. In the new window, you can start typing your content. Give your file a name and make sure to use the markdown extension: `Chapter1.md`. Once you are done, commit the new file to the repositery by clicking the green button `Commit changes`.
Example Image @@ -68,6 +76,14 @@ In GitHub, you can directly make changes in the files on the remote repositery.
Example Image
+ +6. In case you added a new file, you also need to include it table of contents of your book! The table of contents is specified in a file called `toc.yml` and it is already included in your repositery if you used the teachbooks template. + +
+ Example Image +
+ +You can edit it and commit the changes in the same manner as with markdown (.md) files. ```` ````` ```````` @@ -133,6 +149,12 @@ After committing, click the 🔄 button to push our changes to the remote reposi
Example Image
+ +Alternatively, you can also click on `Push origin` in the top bar. + +
+ Example Image +
```` ````` `````` @@ -158,44 +180,61 @@ If you collaborate with colleagues on this branch, you can get the updates from ```` ````{tab-item} ... GitHub Desktop -1. Obtain updates from colleagues from GitLab/GitHub (pulling). This synchronizes the remote repositery with your local repositery on your machine. Click on `Fetch` in the top bar. +1. Obtain updates from colleagues from GitLab/GitHub (pulling). This synchronizes the remote repositery with your local repositery on your machine. Click on `Fetch` in the top bar. Then on the same place, click on 'Pull'.
Example Image
-2. When multiple people work on one chapter, it is possible that conflicts will arise. This means that two users might have cheanged the same sections. GitHub Desktop will recohnize this Solve potential incompatible changes (merging conflicts) +2. When multiple people work on one chapter, it is possible that conflicts will arise. This means that two users might have cheanged the same sections. GitHub Desktop will recognize this Solve potential incompatible changes (merging conflicts) + +3. Make some changes to a file in for example VS Code and save them. + +4. The staging GitHub Desktop assumes you want to stage all files. These files will show up on the left side bar when you open GitHub Desktop. You can unselect some of them (unstaging them) by clicking on the *check*. + +
+ Example Image +
+ +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 Repositery`. + +6. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repositery. After committing, the following screen will pop up. Click on `Push Origin`. + +
+ Example Image +
+ +Alternatively, you can also click on `Push origin` in the top bar. + +
+ Example Image +
```` ````` - - `````` ``````` - ```````` ````````{tab-item} User type 5 - ```````{tab-set} ``````{tab-item} ... brand new version (branch) -**... by making changes on a single / multiple file(s), checking changes locally, selecting changes to be added to the Git-timeline (staging), adding those to the Git-timeline (committing) and adding those changes to GitLab/GitHub (pushing) with ...** +(**... by making changes on a single / multiple file(s), checking changes locally, selecting changes to be added to the Git-timeline (staging), adding those to the Git-timeline (committing) and adding those changes to GitLab/GitHub (pushing) with ...**) + +**... by (1) making changes on a single or multiple file(s)
+ (2) checking changes locally, + (2) selecting changes to be added to the Git-timeline (staging)
+ (3) adding changes to the Git-timeline (committing) and
+ (4) adding changes to GitLab/GitHub (pushing) with ...** `````{tab-set} ````{tab-item} ... Git in VS Code +1. Make some changes to a file in for example VS Code and save them. -```{error} To be written -``` -Make some changes in for example VS Code and save them. - -build book locally and eventually startup python server... -```{error} To be written -``` - -Select files ready to be added to Git-timeline (staging) +2. Select the files ready to be added to Git-timeline (staging) For demonstration purposes, we have created a new Markdown file called `new-chapter.md`, which we want to add to the book. Since this is a new file, Git has no knowledge about its existence yet. I.e., the file is *untracked*. To add new files to our repository, we need to *stage* and *commit* them. To do this, open the Source Control menu in the left side bar. Our new file should appear in this menu: @@ -206,14 +245,14 @@ The new file appears in the Source Control menu. Notice that there is a green letter U placed besides the file, meaning that our file is untracked. To add a file to the *staging area*, click on the + that appears when you hover over the file. +3. Adding changes to the Git-timeline (committing) + Next, in the field that says "Message", write a short description of the changes you have made. This message is what is called the *Commit Message*. After we've done this, the menu should now look something like this: ```{figure} ../images/git-file-added.png The new file has been staged, and we've written a Commit Message. ``` - - Now, we are ready to add the changes to the repository. This is done by *committing* the staged changes. To do this, simply press the big, blue "Commit" button in the Source Control menu. In the bottom left corner, next to the branch name, click the "Synchronize Changes" button (the one that looks like this: 🔄, highlighted in the image below) to push the changes to GitLab. @@ -222,26 +261,45 @@ In the bottom left corner, next to the branch name, click the "Synchronize Chang After committing, click the 🔄 button to push our changes to the remote repository. +4. build book locally and eventually startup python server... + +```{error} To be written +``` ```` + ````{tab-item} ... GitHub Desktop -```{error} To be written -``` -Make some changes in for example VS Code and save them. +1. Obtain updates from colleagues from GitLab/GitHub (pulling). This synchronizes the remote repositery with your local repositery on your machine. Click on `Fetch` in the top bar. Then on the same place, click on 'Pull'. -The staging GitHub Desktop assumes you want to stage all files. You can unselect some of them (unstaging them)... -```{error} To be written -``` +
+ Example Image +
-Add changes to Git-timeline locally (committing) +2. When multiple people work on one chapter, it is possible that conflicts will arise. This means that two users might have cheanged the same sections. GitHub Desktop will recognize this Solve potential incompatible changes (merging conflicts) -```{error} To be written -``` +3. Make some changes to a file in for example VS Code and save them. -Add changes to GitHub/GitLab (pushing) +4. The staging GitHub Desktop assumes you want to stage all files. These files will show up on the left side bar when you open GitHub Desktop. You can unselect some of them (unstaging them) by clicking on the *check*. -```{error} To be written -``` +
+ Example Image +
+ +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 Repositery`. + +6. Now we need to add changes to GitHub/GitLab. This is called pushing to the local repositery. After committing, the following screen will pop up. Click on `Push Origin`. + +
+ Example Image +
+ +Alternatively, you can also click on `Push origin` in the top bar. + +
+ Example Image +
+ +Python stuff? ```` ````` @@ -267,15 +325,8 @@ text.. ```{error} To be written ``` ```` - ````` - - `````` ``````` - - - ```````` - ````````` \ No newline at end of file diff --git a/book/workflows/figures/Push_GitHubDesktop2.PNG b/book/workflows/figures/Push_GitHubDesktop2.PNG new file mode 100644 index 0000000..fbca26f Binary files /dev/null and b/book/workflows/figures/Push_GitHubDesktop2.PNG differ