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

update user type 3

Browse source
This commit is contained in:
Julie Kirsch 2024-10-26 21:58:13 +02:00
parent 992d070bf6
commit 327d09661d
3 changed files with 27 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

39
book/workflows/edit_book.md
View file

@ -4,7 +4,7 @@ Suppose we are writing a new chapter, or are updating an existing chapter for ou
**Edit files as ...**
`````````{tab-set}
````````{tab-item} ... user type 3 ...
````````{tab-item} ... user type 3 ...
**... by directly adding changes on a single file to the Git-timeline (committing) in ...**
@ -47,9 +47,12 @@ In GitLab, you can directly make changes in the files on the remote repository.
You can edit it and commit the changes in the same manner as with markdown (.md) files.
``````
``````{tab-item} ... GitHub
``````{tab-item} ... GitHub
How to make an edit and make a commit is demonstrated in the figure below, all steps are elaborated on in the following step-by-step tutorial.
`````{tab-set}
````{tab-item} ... using 'Edit in place'
How to make an edit and make a commit is demonstrated in the gif below. Don't worry if the steps are too fast, all steps are elaborated on in the following step-by-step tutorial.
```{figure} figures/user3-collaboration.gif
---
@ -74,9 +77,6 @@ In GitHub, you can directly make changes in the files on the remote repository.
<img src="figures/HubUser3_NewFile2.PNG" alt="Example Image" width="700">
</figure>
`````{tab-set}
````{tab-item} ... using 'Edit in place'
4. In case you want to make changes to an existing file, navigate to the file in your remote repository. Then click the downward pointing arrow on the very left in the top bar. Select the option `Edit in place`.
<figure align="center">
@ -100,11 +100,23 @@ You can edit it and commit the changes in the same manner as with markdown (.md)
````
````{tab-item} ... using 'VS Code in your browser'
Using this feature, you can open VS Code in your browser and edit the files in your repository. By doing this, you completely by-pass the need to open (and install) VS Code and GitHub Desktop on your laptop making it the optimal way to quickly fix something.
Using this feature, you can open VS Code in your browser and edit the files in your repository. By doing this, you completely by-pass the need to open (and install) VS Code and GitHub Desktop on your laptop making it the optimal way to quickly fix something. You can make changes to the files already in the repository but you can also upload new files!
1. Navigate to your main page (`code`) of your repository in GitHub
2. Press the dot key on your keyboard `.` This will open VS Code
3. Navigate to a file and make some changes
1. Navigate to the repository you want to work in and make sure you're in the correct branch
2. Navigate to your main page (`code`) of your repository in GitHub
3. Press the dot key on your keyboard `.` This will open VS Code
4. In case you want to add a new file, navigate to the explorer file (the page icon) and click on the `New File` icon. This will create a new file in the folder that you are in. give it the right extension!
```{figure} ./figures/Online_VS0.PNG
:name: New File
:width: 60%
:align: center
New File
```
5. In case you want to make changes to an existing file, navigate to a file and make some changes
```{figure} ./figures/Online_VS1.PNG
:name: VS Code in Browser
@ -115,8 +127,8 @@ VS Code in Browser
```
In the bottom left you can see the branch you are working in.
4. This feature requires you to use git in VS Code. You can do that in the Source Control tab in the activity bar on the left side of the window (it looks like a branching icon). Write your commit message and click on commit & push.
5. Now let's see the result. Go back to your GitHub repo. In the top bar, go to actions.
6. Once all the changes are made it's time to commit and push. GitHub Dev requires you to use git in VS Code. You can do that in the Source Control tab in the activity bar on the left side of the window (it looks like a branching icon). Write your commit message and click on commit & push.
7. Now let's see the result. Go back to your GitHub repo. In the top bar, go to actions.
```{figure} ./figures/Online_VS2.PNG
:name: GitHub Actions
@ -138,7 +150,6 @@ Click on the link and admire your changes:)
````
`````
``````
```````
````````
@ -656,4 +667,4 @@ Alternatively, you can also click on `Push origin` in the top bar.
``````
```````
````````
`````````
`````````