overview page also final

This commit is contained in:
Julie Kirsch 2024-05-23 11:45:49 +02:00
parent 67b8a23751
commit 6b8c782e82
2 changed files with 54 additions and 31 deletions

View file

@ -20,22 +20,22 @@ The steps involved are as follows:
- branching
``````
``````{tab-item} ... user type 4 and 5...
``````{tab-item} ... user type 4 and 5
`````{tab-set}
````{tab-item} Open repository for first time
````{tab-item} Open repository for first time...
**... by
(a) oopening the repository locally (cloning) and
**... by <br>
(a) opening the repository locally (cloning) and <br>
(b) creating your own version (branching) or selecting existing version (checkout branch):**
- cloning
- branching / checkout branch
````
````{tab-item} Work in previously opened repository
````{tab-item} Work in previously opened repository...
**... by
(a) updating your repository (pulling) and
**... by <br>
(a) updating your repository (pulling) and <br>
(b) creating your own version (branching) or select existing version (checkout branch):**
- pulling
@ -57,12 +57,12 @@ The steps involved are as follows:
``````{tab-item} ... user type 4...
`````{tab-set}
````{tab-item} ... on a brand new version (branch)
````{tab-item} ... on a brand new version (branch)...
**... by
(a) making changes on a single / multiple file(s),
(b) selecting changes to be added to the Git-timeline (staging),
(c) adding those to the Git-timeline (committing) and
**... by <br>
(a) making changes on a single / multiple file(s), <br>
(b) selecting changes to be added to the Git-timeline (staging), <br>
(c) adding those to the Git-timeline (committing) and <br>
(d) adding those changes to GitLab/GitHub (pushing):**
- adding or making changes to file(s)
@ -70,13 +70,13 @@ The steps involved are as follows:
- committing
- pushing
````
````{tab-item} ... on an existing version (branch)
````{tab-item} ... on an existing version (branch)...
**... by
(a) regularly obtaining updates from colleagues from GitLab/GitHub (pulling),
(b) solving potential incompatible changes (merge conflicts),
(c) making changes on a single / multiple file(s),
(d) selecting changes to be added to the Git-timeline (staging),
**... by <br>
(a) regularly obtaining updates from colleagues from GitLab/GitHub (pulling), <br>
(b) solving potential incompatible changes (merge conflicts), <br>
(c) making changes on a single / multiple file(s), <br>
(d) selecting changes to be added to the Git-timeline (staging), <br>
(e) adding those to the Git-timeline (committing) and adding those changes to GitLab/GitHub (pushing):**
- pulling
@ -89,18 +89,33 @@ The steps involved are as follows:
`````
``````
``````{tab-item} ... user type 5...
... on ...
`````{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):**
````{tab-item} ... on a brand new version (branch)...
**... by <br>
(a) making changes on a single / multiple file(s), <br>
(b) checking changes locally, <br>
(c) selecting changes to be added to the Git-timeline (staging), <br>
(d) adding those to the Git-timeline (committing) and <br>
(e) adding those changes to GitLab/GitHub (pushing):**
- adding or making changes to file(s)
- checking changes locally
- staging
- committing
- pushing
````
````{tab-item} ... existing version (branch)
**... by regularly obtaining updates from colleagues from GitLab/GitHub (pulling), solving potential incompatible changes (merge conflicts), 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):**
````{tab-item} ... on an existing version (branch)...
**... by <br>
(a) regularly obtaining updates from colleagues from GitLab/GitHub (pulling), <br>
(b) solving potential incompatible changes (merge conflicts), <br>
(c) making changes on a single / multiple file(s), <br>
(d) checking changes locally, <br>
(e) selecting changes to be added to the Git-timeline (staging), <br>
(f) adding those to the Git-timeline (committing) and <br>
(g) adding those changes to GitLab/GitHub (pushing):**
- pulling
- solving merge conflicts
- adding or making changes to file(s)
@ -109,7 +124,6 @@ The steps involved are as follows:
- committing
- pushing
````
``````
```````
4. **Check changes online**

View file

@ -31,15 +31,22 @@ This will lead you to this window where you can specify all attributes we mentio
The issues in GitHub can be found in your repositery in the top bar.
<img src="figures/Issue_GitHub.PNG" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>
<figure align="center">
<img src="figures/Issue_GitHub.PNG" alt="Example Image" width="650">
</figure>
Clicking on `Issues` will open up the page with all the issues on this repositery.
<img src="figures/New_Issue_GitHub.PNG" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>
<figure align="center">
<img src="figures/New_Issue_GitHub.PNG" alt="Example Image" width="650">
</figure>
Finally, by clicking the green `New Issue` button you can create a new issue and specify all the attributes we mentioned before!
<img src="figures/New_Issue_GitHub2.PNG" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>
<figure align="center">
<img src="figures/New_Issue_GitHub2.PNG" alt="Example Image" width="650">
</figure>
```{Note}
@ -47,13 +54,15 @@ The follwing steps explain how to create a branch from a new issue. By doing thi
```
After creating the issue, the description of the issue will automatically open. On the bottom left there is an option `create a branch` (in yellow) from this issue. This will create a new branch in the repositery which you can use to solve the issue.
<img src="figures/New_Issue_GitHub3.PNG" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>
<figure align="center">
<img src="figures/New_Issue_GitHub3.PNG" alt="Example Image" width="650">
</figure>
Clicking on `create a branch` will open the following window in which you can specify the name and the repositery.
<img src="figures/New_Issue_GitHub4.PNG" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>
```
<figure align="center">
<img src="figures/New_Issue_GitHub4.PNG" alt="Example Image" width="350">
</figure>
````
`````