this is an old commit

This commit is contained in:
Julie Kirsch 2024-04-20 16:16:03 +02:00
parent 4a16c8e83d
commit 9e3c415b59
9 changed files with 60 additions and 18 deletions

View file

@ -21,6 +21,7 @@ parts:
sections:
- file: workflows/milestones_issues
- file: workflows/repositories
- file: workflows/permissions
- file: workflows/branches
- file: workflows/edit_book
- file: workflows/publish

View file

@ -1,15 +1,15 @@
# Collaborative book-editing using Git
As previously mentioned there are multiple platforms that can host Git repositories which are extremely useful for collaboration on text-based files. Here we will elaborate on two: GitLab and GitHub both in the online environment and locally.
As previously mentioned there are multiple platforms that can host Git repositories which are extremely useful for collaboration on text-based files. Here we will elaborate on two: GitLab and GitHub both in the online environment and locally on your device.
Globally, the steps involved are as follows:
1. Define issue to work on
1. Define an issue to work on
2. Open the files of the repository online or clone the repository to work on it locally
3. Create a branch for your changes
4. Edit the book by:
- Pulling remote changes from others
- Staging your changes
- Commit a collection of changes
- Committing a collection of changes
- If working on a repository locally: pushing your changes
5. Reviewing and merging changes in a merge request
6. Publish changes to published version of book
6. Publishing the changes to the published version of the book

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

View file

@ -11,20 +11,33 @@ An issue is built up of the following attributes:
Every team member can create issues when they think of a task that would improve the book.
`````{tab-set}
````{tab-item} Issues in GitLab
The following tabs explain where the Issues can be found in GitLab and GitHub.
The issues in GitLab can be found on this page:
`````{tab-set}
````{tab-item} GitLab
The issues in GitLab can be found in your repositery in the left bar.
<img src="figures/Issues.png" alt="New Issue" width="1000" style="display:block; margin-left:auto; margin-right:auto;"> <br>
You can create an issue by clicking on the blue `New Issue` button in the top right corner.
You can create an issue by clicking on the blue `New Issue` button in the top right corner. This will lead you to this window where you can specify all attributes we mentioned before!
<img src="figures/New_Issue_GitLab.png" alt="New Issue" width="600" style="display:block; margin-left:auto; margin-right:auto;"> <br>
````
````{tab-item} Issues in GitHub
...
````{tab-item} GitHub
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>
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>
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>
````
`````

View file

@ -1,15 +1,36 @@
# Open files online / clone files
We have previously introduced the notions of using Git in the online environment (remote) or locally. All the (markdown) files that make up the book are contained on the remote repository on GitLab or GitHub. This could be on an open repository on `gitlab.com` or `github.com`. In the context of creating educational books for students at TU Delft, the repository will most likely be located on `gitlab.tudelft.nl`.
If you'd like to work on your book locally, you need to clone your book.
If you'd like to work on your book locally (on your device, perhaps using Jupyter Lab or VS Code), you need to clone your repositery from the remote to your device. In familiar words, this means you need to make a copy of your book on your laptop.
### Cloning a repository
You can clone a repositery from GitLab and GitHub using GitHub Desktop or you can clone it with Git in VS Code.
`````{tab-set}
````{tab-item} Cloning repository from GitLab
````{tab-item} Clone from GitLab using GitHub Desktop
Here's how you do it with VS Code:
1. On GitLab, go to the repository of your book. Click on the blue button that says "Clone" or "Code", and copy the link under "Clone with SSH".
```{figure} ../images/gitlab-clone.png
:name: gitlab-clone
The cloning menu.
```
2. Navigate to GitHub Desktop (which you've previously installed using [this tutorial](/book/installation-and-setup/git-setup_local.md)).
3. Click on `File` in the top menu.
4. Click on `Clone Repositery`. You should see the following window appear.
```{figure} ../figures/CloneGitHubDesktop.png
:name: CloneGitHubDesktop
Cloning in GitHub Desktop.
```
5. Paste the link you've just copied and define the location on your device.
````
````{tab-item} Clone from GitLab using GitHub Desktop
1. On GitLab, go to the repository of your book. Click on the blue button that says "Clone" ({numref}`gitlab-clone`), and copy the link under "Clone with SSH".
```{figure} ../images/gitlab-clone.png
@ -17,13 +38,20 @@ Here's how you do it with VS Code:
The cloning menu.
```
2. Navigate to GitHub Desktop (which you've previously installed using [this tutorial](/book/installation-and-setup/git-setup_local.md)).
3. Click on `File` in the top menu.
4. Click on `Clone Repositery`. You should see the following window appear.
```{figure} ../figures/CloneGitHubDesktop.png
:name: CloneGitHubDesktop
Cloning in GitHub Desktop.
```
5. Paste the link you've just copied and define the location on your device.
````
````{tab-item} Cloning repository from GitHub
...
````
````{tab-item} Cloning repository from GitHub using GitHub Desktop
````{tab-item} Cloning repository with Git in VS Code
...
````
`````