diff --git a/book/_toc.yml b/book/_toc.yml index 50cd248..b85cf05 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -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 diff --git a/book/workflows/collaboration.md b/book/workflows/collaboration.md index 5a77c45..005f498 100644 --- a/book/workflows/collaboration.md +++ b/book/workflows/collaboration.md @@ -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 \ No newline at end of file + 6. Publishing the changes to the published version of the book \ No newline at end of file diff --git a/book/workflows/figures/CloneGitHubDesktop.PNG b/book/workflows/figures/CloneGitHubDesktop.PNG new file mode 100644 index 0000000..7bf2a6a Binary files /dev/null and b/book/workflows/figures/CloneGitHubDesktop.PNG differ diff --git a/book/workflows/figures/Issue_GitHub.PNG b/book/workflows/figures/Issue_GitHub.PNG new file mode 100644 index 0000000..b75158b Binary files /dev/null and b/book/workflows/figures/Issue_GitHub.PNG differ diff --git a/book/workflows/figures/New_Issue_GitHub.PNG b/book/workflows/figures/New_Issue_GitHub.PNG new file mode 100644 index 0000000..6eeb066 Binary files /dev/null and b/book/workflows/figures/New_Issue_GitHub.PNG differ diff --git a/book/workflows/figures/New_Issue_GitHub2.PNG b/book/workflows/figures/New_Issue_GitHub2.PNG new file mode 100644 index 0000000..a55dae0 Binary files /dev/null and b/book/workflows/figures/New_Issue_GitHub2.PNG differ diff --git a/book/workflows/milestones_issues.md b/book/workflows/milestones_issues.md index 1c5bdf4..e543f4d 100644 --- a/book/workflows/milestones_issues.md +++ b/book/workflows/milestones_issues.md @@ -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. New Issue
-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! New Issue
```` -````{tab-item} Issues in GitHub -... +````{tab-item} GitHub + +The issues in GitHub can be found in your repositery in the top bar. + +New Issue
+ +Clicking on `Issues` will open up the page with all the issues on this repositery. + +New Issue
+ +Finally, by clicking the green `New Issue` button you can create a new issue and specify all the attributes we mentioned before! + +New Issue
```` ````` diff --git a/book/workflows/access_control_permissions.md b/book/workflows/permissions.md similarity index 100% rename from book/workflows/access_control_permissions.md rename to book/workflows/permissions.md diff --git a/book/workflows/repositories.md b/book/workflows/repositories.md index 44cc0d3..f33d7ec 100644 --- a/book/workflows/repositories.md +++ b/book/workflows/repositories.md @@ -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 ... ```` `````