From 821087b0385de644111f3cf4083c0041a4e55d89 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:02:39 +0200 Subject: [PATCH 01/20] styling and formulation --- source/content/remote_services/index.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/content/remote_services/index.md b/source/content/remote_services/index.md index a1fcb9e..7185ff9 100644 --- a/source/content/remote_services/index.md +++ b/source/content/remote_services/index.md @@ -1,7 +1,7 @@ # Remote Services {% if page %} -What is often called **origin** in , and sometimes simply referred to as the _remote location or device_ can refer to anything from as single-board computer to a massive cloud service. +What is often called **origin** in , and sometimes simply referred to as the _remote location_ or _device_ can refer to anything from as single-board computer up to a massive cloud service. In fact, with the popularity of the service of offering a repositories' **origin** has become an economically relevant business with service providers extending considerably the list of the provided features beyond the already rich functionalities , the version control system, includes. @@ -12,16 +12,17 @@ Thus Remote Services could be defined as follows: Platforms that host repositories, allowing developers to store, manage, and collaborate on their code projects over the internet. ``` {% if page %} -As we discussed in Part 1, is a distributed version control system (VCS) that manages and tracks change in codebases. - is not to be confused with **GitHub** and **GitLab**, or similar, which, in turn, are remote hosting web-based platforms that use to offer services to store and collaborate on code remotely. +As we discussed in Part 1, is a distributed version control system (VCS) that manages and tracks changes in codebases. -Remote services like **GitHub** or **GitLab** offer a range of features that extend beyond basic functionalities, making project management, collaborations and automation that much easier. + is not to be confused with **GitHub**, **GitLab**, or similar, which, in turn, are remote hosting web-based platforms that use to offer services to store and collaborate on code remotely. + +Remote services like **GitHub** or **GitLab** offer a range of features that extend beyond basic functionalities, making project management, collaborations and automation much easier. In this section, we will go over some of the key features of -based remote services and tools that are particularly useful for project management. {% else %} :::{card} ≠ remote services, like **GitHub** or **GitLab** -> = version control system (VCS) to manage and track coding changes +> = version control system (VCS) to manage and track code changes > -based remote services (e.g. **GitHub**, **GitLab**) = web-based platforms that **offer additional features** to store and facilitate collaborative coding projects, extending tools offered by . ::: From d7a56e0c4ef7605af2360f052bf9d1fc0c1f2bb5 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:03:16 +0200 Subject: [PATCH 02/20] self-explanatory title. Shortened table due to size limit in slides. --- source/content/remote_services/list.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/content/remote_services/list.md b/source/content/remote_services/list.md index 6dd1557..cc77521 100644 --- a/source/content/remote_services/list.md +++ b/source/content/remote_services/list.md @@ -1,4 +1,4 @@ -### Non-Exhaustive Overview +### Non-Exhaustive Overview of Hosting Services | Service Name | Description | |--------------------|-----------------------------------------------------------------------------| @@ -12,6 +12,6 @@ | **[GitHub](https://github.com)** | A widely used platform for hosting repositories{% if page %} with social coding features and CI/CD through GitHub Actions{% endif %}. | | **[GitLab](https://gitlab.com)** | A widely used platform for hosting repositories{% if page %} offering repository hosting, CI/CD, issue tracking, and DevOps tools{% endif %}. | | **[GitKraken](https://www.gitkraken.com)** | {% if slide %}Primarily a client that also offers hosting.{% else %}Primarily a client, GitKraken also offers hosting through its GitKraken Boards feature.{% endif %} | -| **[Gogs](https://gogs.io)** | A self-hosted service similar to Gitea{% if page %}, designed to be simple and efficient{% endif %}. | | **[Launchpad](https://launchpad.net)** | {% if slide %}Developed by Canonical, primarily used for open-source projects.{% else %}A platform developed by Canonical for hosting repositories, primarily used for open-source projects.{% endif %} | | **[SourceForge](https://sourceforge.net)** | An older platform providing repository hosting{% if page %} along with project management tools and issue tracking{% endif %}. | + \ No newline at end of file From 1466d7d0c10b5a876538276195032f87f364c711 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:08:46 +0200 Subject: [PATCH 03/20] replaced logos with icons --- source/content/popular_remotes/overview_popular_remotes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/content/popular_remotes/overview_popular_remotes.md b/source/content/popular_remotes/overview_popular_remotes.md index 275a362..0842f45 100644 --- a/source/content/popular_remotes/overview_popular_remotes.md +++ b/source/content/popular_remotes/overview_popular_remotes.md @@ -10,12 +10,12 @@ They allow multiple users to work on the same project simultaneously, track chan | **Remote Service** | **Founded** | **Acquired/Owned by** | **Popularity** | **Key Features** | **Costs** | |--------------------|-------------|-----------------------|----------------|------------------|-----------| -| **GitHub** ![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png) | 2008 | Microsoft (2018) | Widely used by open-source communities and enterprises.
Known for its user-friendly interface and extensive community support. | - **Repository hosting**
- **Pull requests**
- **Issues and bug tracking**
- **Wikis**
- GitHub Actions for CI/CD
- Project boards | Free for public repositories, paid plans for private repositories and additional features. | -| **GitLab** ![GitLab Logo](https://about.gitlab.com/images/press/logo/png/gitlab-icon-rgb.png) | 2011 | - | Popular among developers and enterprises.
Known for its open-source nature and flexibility. | - **Repository hosting**
- **Merge requests**
- **Issues and bug tracking**
- **Wikis**
- **Integrated CI/CD**
- Web IDE
- Workspaces | Free tier, paid plans for additional features and support. | +| **GitHub** | 2008 | Microsoft (2018) | Widely used by open-source communities and enterprises.
Known for its user-friendly interface and extensive community support. | - **Repository hosting**
- **Pull requests**
- **Issues and bug tracking**
- **Wikis**
- GitHub Actions for CI/CD
- Project boards | Free for public repositories, paid plans for private repositories and additional features. | +| **GitLab** | 2011 | - | Popular among developers and enterprises.
Known for its open-source nature and flexibility. | - **Repository hosting**
- **Merge requests**
- **Issues and bug tracking**
- **Wikis**
- **Integrated CI/CD**
- Web IDE
- Workspaces | Free tier, paid plans for additional features and support. | {% else %} -| **Aspect** | **GitHub** | **GitLab** | +| **Aspect** | **GitHub** | **GitLab** | |------------|------------|------------| | **Repository Hosting** | Yes | Yes | | **Pull Requests/Merge Requests** | Pull Requests | Merge Requests | From 2b3f05eefce37f2606f2d1b64480c57966442b28 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:15:26 +0200 Subject: [PATCH 04/20] sidenote about MS aquisition of GH --- source/content/popular_remotes/github.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/source/content/popular_remotes/github.md b/source/content/popular_remotes/github.md index 352d458..6a183f4 100644 --- a/source/content/popular_remotes/github.md +++ b/source/content/popular_remotes/github.md @@ -1,6 +1,10 @@ -## GitHub +## GitHub -GitHub is a leading platform for hosting and managing code repositories, enabling collaboration, issue tracking, and CI/CD workflows. Founded in 2008 and acquired by Microsoft in 2018, it is known for its user-friendly interface and extensive community support. +GitHub is a leading platform for hosting and managing code repositories, enabling collaboration, issue tracking, and CI/CD workflows. Founded in 2008 and acquired by Microsoft in 2018{% if page %}[^sn1]{% endif %}, it is known for its user-friendly interface and extensive community support. + +{% if page %} +[^sn1]: Before the acquisition, GitHub was an open-source platform, and the acquisition raised concerns about the platform's future direction and lead to an exodus of users to other platforms like GitLab. +{% endif %} **Pros:** - User-friendly interface From 8fcc83b0eb80d01227bfebb3b6c0e7bc0ed86505 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:16:45 +0200 Subject: [PATCH 05/20] icon added --- source/content/popular_remotes/gitlab.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/content/popular_remotes/gitlab.md b/source/content/popular_remotes/gitlab.md index 9bae225..af270b1 100644 --- a/source/content/popular_remotes/gitlab.md +++ b/source/content/popular_remotes/gitlab.md @@ -1,4 +1,4 @@ -## GitLab +## GitLab GitLab is a popular, open-source platform for hosting and managing code repositories, offering comprehensive DevOps features for collaboration, issue tracking, and CI/CD workflows. Founded in 2011, GitLab is compared to GitHub fully open-source and provides a similar feature set that supports the entire software development lifecycle but has a stronger focus on self-hosted and on-premise installations. From 92a8dc039f615387d459e6b1f51071229b32bc9a Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:17:48 +0200 Subject: [PATCH 06/20] more specific title --- source/content/popular_remotes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/content/popular_remotes/index.md b/source/content/popular_remotes/index.md index 2428bcf..eb0dcab 100644 --- a/source/content/popular_remotes/index.md +++ b/source/content/popular_remotes/index.md @@ -26,7 +26,7 @@ ``` -# Remote Services at the University +# Remote Services at the University of Zurich ```{include} ./remote_services_at_uzh_imathGitLab.md ``` ```{include} ./remote_services_at_uzh_uzhGitLab.md From d333cc71510e3386a3cf40d3dcca39574daebabb Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:19:19 +0200 Subject: [PATCH 07/20] typos --- .../remote_services_at_uzh_uzhGithub.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/source/content/popular_remotes/remote_services_at_uzh_uzhGithub.md b/source/content/popular_remotes/remote_services_at_uzh_uzhGithub.md index 4e65854..e12ea9a 100644 --- a/source/content/popular_remotes/remote_services_at_uzh_uzhGithub.md +++ b/source/content/popular_remotes/remote_services_at_uzh_uzhGithub.md @@ -1,8 +1,11 @@ ## UZH GitHub -UZH members can use their UZH email address to sign up for a GitHub account. This account can be used for both private and public repositories. GitHub offers free plans for public repositories and paid plans for private repositories and additional features. +UZH members can use their UZH email address to sign up for a GitHub account. +This account can be used for both private and public repositories. GitHub offers free plans for public repositories and paid plans for private repositories and additional features. -UZH has no official GitHub Enterprise license for the entire university. However, some departments or research groups may have their own licenses. Please check with your IT department or supervisor for more information. +UZH has *no* official GitHub Enterprise license for the entire university. +However, some departments or research groups may have their own licenses. Please check with your IT department or supervisor for more information. # GitHub Education -The UZH itself is accepted by GitHub as an educational -institution. Any user with a UZH email address can get verfied as at [github.com/education](https://github.com/education) and get access to the GitHub Student Developer Pack. This pack includes free access to various tools and services for students and educators. +The UZH itself is accepted by GitHub as an educational institution. +Any user with a UZH email address can get verfied as at [github.com/education](https://github.com/education) and get access to the GitHub Student Developer Pack. +This pack includes free access to various tools and services for students and educators. From 5c0918499a2b301a9ba53cb12b53992d865f4769 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:40:16 +0200 Subject: [PATCH 08/20] typos --- source/content/remote_service_features/index.md | 4 ++-- source/content/remote_service_features/web_interface.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/content/remote_service_features/index.md b/source/content/remote_service_features/index.md index d45bd37..6769366 100644 --- a/source/content/remote_service_features/index.md +++ b/source/content/remote_service_features/index.md @@ -1,8 +1,8 @@ ## Remote Features -The portfolio of tools different remote services offer varies from service provider to service provider. +The portfolio of tools, that different remote services offer, varies from service provider to service provider. -However, some features are rather uinversally present{%if page %} and can be rougly described as follows:{% endif %} +However, some features are rather uinversally present{%if page %} and can be roughly described as follows:{% endif %} {% if slide %} diff --git a/source/content/remote_service_features/web_interface.md b/source/content/remote_service_features/web_interface.md index 07a4f98..41307b4 100644 --- a/source/content/remote_service_features/web_interface.md +++ b/source/content/remote_service_features/web_interface.md @@ -1,7 +1,7 @@ ### Web Interface {% if page %} -Most features remotes offer are accessible via a web interface, which exposes not just ther remote specific features but also offers visualizations for specific functions. +Most features remote hosting platforms offer, are accessible via a web interface, which exposes not just their specific features but also offers visualizations for specific functions. As such, the web interface porvides: {% endif %} @@ -9,7 +9,7 @@ As such, the web interface porvides: Access to remote features and visualization of a variety of 's own features ``` -Regarding visualizations for features, we provide some specific links to these views for our **Weekend-Out** exercise repo. that resides both [on **GitHub**](https://github.com/t4d-gmbh/Weekend-Out) and [on **GitLab**](https://github.com/t4d-gmbh/Weekend-Out). +Regarding visualizations for features, we provide some specific links to these views for our **Weekend-Out** exercise repository that resides both [on **GitHub**](https://github.com/t4d-gmbh/Weekend-Out) and [on **GitLab**](https://github.com/t4d-gmbh/Weekend-Out). | Feature | GitLab Link | GitHub Link | |--------------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| From 4377f6fc583de1437f2195c731a06b6295c226cb Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 18:42:37 +0200 Subject: [PATCH 09/20] typos and extended with IdP --- source/content/remote_service_features/access.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/content/remote_service_features/access.md b/source/content/remote_service_features/access.md index cac6c1b..47e7411 100644 --- a/source/content/remote_service_features/access.md +++ b/source/content/remote_service_features/access.md @@ -1,8 +1,8 @@ ### Access Control {% if page %} -This is a crucial feature remote services provide and is handled somewhat somewhat differently between remotes, unfortunately. +This is a crucial feature remote services provide and is handled somewhat somewhat differently between remote service providers, unfortunately. -We will discuss this feature in some more detail in the section [Oranizing Projects](../organizing_and_more/index.md#organizing-projects) but in short: +We will discuss this feature in some more detail in the section [Organizing Projects](../organizing_and_more/index.md#organizing-projects) but in short: {% endif %} Remote services like GitLab and GitHub, do not just allow repository owners to give access to a repository they host, but they offer: @@ -11,3 +11,4 @@ Remote services like GitLab and ) or Pull Request () are formal request by a developer to have their code changes merged from one branch into another branch +{% if page %} ``` +{% endif %} + +{% if page %} :::{admonition} {octicon}`issue-opened;0.8em` {octicon}`arrow-right` {octicon}`git-pull-request;0.8em` :class: note, margin {octicon}`git-pull-request;0.8em` Merge/Pull Requests typically relate to one or serveral {octicon}`issue-opened;0.8em` Issues. ::: -{% if page %} + In contrast to Issues that focus on documenting any kind of task that needs to be addressed, Merge/Pull requests are designed to document actual changes in a repository. However, this leads to a rather obvious relation between Issues and Merge/Pull Requests: {% endif %} - +{% if page %} :::{admonition} {octicon}`git-pull-request-draft` Drafts are a thing! :class: tip, margin Many remote services know the concept of a _draft_ Merge/Pull request. With a _draft_ Merge/Pull Request you might create the request even much before the implementation is completed. +This can be useful to group related issues and discuss the implementation with other team members early on. ::: +{% endif %} + | Property | Description | |--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Source Branch** | {% if slide %}{octicon}`git-branch` Branch containing changes{% else %}The branch containing the new changes that will be merged into the target branch (e.g., main or develop).{% endif %} | | **Target Branch** | {% if slide %}{octicon}`git-branch` Branch into which changes should be introduced{% else %}The branch where the changes are merged into, typically the main or develop branch.{% endif %} | -| **Description** | {% if slide %}**Title** and a short **description** that outlines what is implemented and how.{% else %}Each Merge/Pull Request has a title and a brief description outlining the changes made in the branch. It can also contain specific keywords ([](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) or [](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)), such as the introduction to close a specific issue once the request is accepted.{% endif %} | +| **Description** | {% if slide %}**Title** and a short **description** that outlines what is implemented and how.{% else %}Each Merge/Pull Request has a title and a brief description outlining the changes made in the branch. It can also contain specific keywords ([](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) or [](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)), such as to close a specific issue once the request is accepted.{% endif %} | | **Assignees** | {% if slide %}A designated **responsible for the implementation** of the changes.{% else %}Merge/Pull Request can be assigned to specific team members to clarify responsibilities and facilitate project management.{% endif %} | | **Reviewers** | {% if slide %}Person(s) responsible for overseeing the introduction of changes{% else %}One or several members of the repository assigned to review the changes and provide feedback. Typically, a reviewer should be very familiar with the parts of the target branch that are affected by the changes.{% endif %} | | **State** | {% if slide %}Either {octicon}`git-pull-request` **opened**, {octicon}`git-merge` **merged** or {octicon}`git-pull-request-closed` **closed**{% else %}To track progress on an Merge/Pull Request, generally it can have three states {octicon}`git-pull-request` “open” (still to be merged), {octicon}`git-merge` **merged** (the request has been accepted and the source branch was merged into the target branch) an {octicon}`git-pull-request-closed` “closed” (the request was denied).{% endif %} | | **Labels** | {% if slide %}A set of arbitrary labels{% else %}Issues can be categorized using labels, e.g., “bug”, “documentation”, etc., to help organize and prioritize work.{% endif %} | -| **News Feed** | {% if slide %}A **chat like activity feed** that allows commenting{% else %}Issues provide an activity or news feed, that displays any related changes and that anyone with can access and write comments to offer insights, feedback, and exchange ideas on how to resolve an issue.{% endif %} | +| **News Feed** | {% if slide %}A **chat like activity feed** that allows commenting{% else %}Issues provide an activity or news feed, that displays any related changes and that anyone can access and write comments to offer insights, feedback, and exchange ideas on how to resolve an issue.{% endif %} | | **Milestone** | {% if slide %}Affiliation to a {octicon}`milestone;0.8em` Milestone{% else %}Identical to issues, Merge/Pull Requests can be grouped under milestones and be integrated into an overarching planning, even between repositories for some remote services.{% endif %} | {% if page %} In a collaborative project, it is a useful tool for: -- Review code changes before merging -- Discuss changes and suggest improvements -- Testing code to ensure changes don’t break the project or the overall workflow. -- Approve code changes or workflow (by one or several developers). +- **Review** code changes before merging +- **Discuss** changes and suggest improvements +- **Testing** code to ensure changes don’t break the project or the overall workflow. +- **Approve** code changes or workflow (by one or several developers). From 1efff19f8404e42108f13320e53dfc18701c01f1 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:01:51 +0200 Subject: [PATCH 12/20] extended definition of issue --- .../remote_service_features/collaboration_tools/issues.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/content/remote_service_features/collaboration_tools/issues.md b/source/content/remote_service_features/collaboration_tools/issues.md index ee10fe0..c91dec2 100644 --- a/source/content/remote_service_features/collaboration_tools/issues.md +++ b/source/content/remote_service_features/collaboration_tools/issues.md @@ -3,7 +3,7 @@ (_or **![issue](./icons/issue.svg) Issues**_ for ) ```{epigraph} -Allow to document and track tasks, bugs and any kind of work that needs to be addressed in a repository. +Allow to document and track tasks, bugs, thoughts, questions, and any kind of work that needs to be addressed in a repository. ``` {% if page %} An issue allows to document all planned changes, discovered bugs, questions related to the repository, etc. @@ -30,5 +30,5 @@ Generally, any problem, question, or proposition that needs to be addressed can | **Assignees** | {% if slide %}A designated **responsible for managing** this issue.{% else %}Issues can be assigned to specific team members to clarify tasks and responsibilities and facilitate project management.{% endif %} | | **State** | {% if slide %}Either {octicon}`issue-opened` **opened** or {octicon}`issue-closed` **closed**{% else %}To track progress on an issue, generally they can have two states {octicon}`issue-opened` “open” (still to be resolved) and {octicon}`issue-closed` “closed” (issue has been resolved).{% endif %} | | **Labels** | {% if slide %}A set of arbitrary labels{% else %}Issues can be categorized using labels, e.g., “bug”, “documentation”, etc., to help organize and prioritize work.{% endif %} | -| **News Feed** | {% if slide %}A **chat like activity feed** that allows commenting{% else %}Issues provide an activity or news feed, that displays any related changes and that anyone with can access and write comments to offer insights, feedback, and exchange ideas on how to resolve an issue.{% endif %} | +| **News Feed** | {% if slide %}A **chat like activity feed** that allows commenting{% else %}Issues provide an activity or news feed, that displays any related changes (e.g. commits) and that anyone with can access and write comments to offer insights, feedback, and exchange ideas on how to resolve an issue.{% endif %} | | **Milestone** | {% if slide %}Affiliation to a {octicon}`milestone;0.8em` Milestone{% else %}Issues can be grouped under milestones and be integrated into an overarching planning, even between repositories for some remote services.{% endif %} | From 602ca608e5bf1320479a1c538e7214102309f270 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:09:06 +0200 Subject: [PATCH 13/20] labels vs. tags on slides --- .../remote_service_features/collaboration_tools/labels.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/content/remote_service_features/collaboration_tools/labels.md b/source/content/remote_service_features/collaboration_tools/labels.md index 73b43fc..a8914e4 100644 --- a/source/content/remote_service_features/collaboration_tools/labels.md +++ b/source/content/remote_service_features/collaboration_tools/labels.md @@ -6,9 +6,11 @@ Allow to categorize and organize Issues and Merge/Pull Requests in a repository, {% if page %} Labels are a great help for prioritizing, categorizing and navigate through Issues and Merge/Pull Requests. -On some remotes Labels can be reused between repositories leading to a consistent labeling between repositories. +On some remote service providers, Labels can be reused between repositories leading to a consistent labeling between repositories. -One thing that should be noted, is that {octicon}`tag;0.8em` Labels do not exist in and so they have absolutely noting in common with {octicon}`tag;0.8em` Tags in . +One thing that should be noted, is that {octicon}`tag;0.8em` Labels do not exist in and so they have absolutely nothing in common with {octicon}`tag;0.8em` Tags in . +{% else %} + {octicon}`tag;0.8em` Labels {octicon}`tag;0.8em` Tags! {% endif %} :::{admonition} Create scoped Labels From b1e1249a6ffd2fd67d0b4f4fd2d74a702ffbfd4d Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:17:44 +0200 Subject: [PATCH 14/20] typos --- .../collaboration_tools/activity_tracking.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/source/content/remote_service_features/collaboration_tools/activity_tracking.md b/source/content/remote_service_features/collaboration_tools/activity_tracking.md index c528e80..2a891f0 100644 --- a/source/content/remote_service_features/collaboration_tools/activity_tracking.md +++ b/source/content/remote_service_features/collaboration_tools/activity_tracking.md @@ -3,19 +3,19 @@ :::{admonition} A {octicon}`git-pull-request;0.8em` News Feed {math}`\neq` history :class: warning, margin -Activity-tracking is a feature of remote service platforms {%if page %}such as **GitHub** and **GitLab** that offer, {% endif %}and not a concept in itself. +Activity-tracking is a feature of remote service platforms {%if page %}such as **GitHub** and **GitLab**, {% endif %}and not a concept itself. "News Feeds" might contain parts of the history, but not vice-versa. ::: {% if slide %} -GitHub, GitLab, and others perform activity tracking, providing a full list of changes that includes a full history of what happened, when it happened, and why it happened. +GitHub, GitLab, and others perform activity tracking and provide a full list of changes that includes a full history of what happened, when it happened, and why it happened. {% else %} -One of the key services offered by GitHub, GitLab, and others is tracking and providing a full record in an organised way of all the changes beyond the commits history provided in Git. -More than just keeping a list of changes, it includes a full history of what happened, when it happened, and why it happened. +One of the key services offered by GitHub, GitLab, and others is tracking and providing a full record in an organised way of all the changes beyond the commits history provided in . +It's much more than just keeping a list of changes, it includes a full history of what happened, when it happened, and why it happened. Tracking activities is available both for {octicon}`issue-opened;0.8em` Issues and {octicon}`git-pull-request;0.8em` Merge/Pull Requests and is reported in the attached "News Feed" that can also be used for commenting. Despite the automated activity tracking it is also possible to manually create links between Issues and/or Pull/Merge Requests simply by pasting their URL as a comment in some News Feed. -By means of this automated tracking the complete life-cycle is documented which can drastically facilitate collaboration and documentation, as these "News Feeds" effectively turn into a digital logbook. +By means of this automated tracking, the complete life-cycle is documented which can drastically facilitate collaboration and documentation, as these "News Feeds" effectively turn into a digital logbook. {% endif %} @@ -29,16 +29,16 @@ Key advantages: - Why it changed through issue tracking and pull requests: - Who changed it {% endif %} -1. **Accountability and Responsibility**: by tracking who made changes and why makes it addressing problems easier and faster +1. **Accountability and Responsibility**: by tracking who made changes and why, it makes addressing problems easier and faster. 1. **Collaboration and Communication**: the full history of changes ensures everyone is on the same page{% if page %}, even in teams working remotely or in different time zones. -The Pull/Merge Requests system encourages discussions and reviews within a team or a wider community{% endif %}. +The Pull/Merge Request system encourages discussions and reviews within a team or a wider community{% endif %}. -1. **Continuous learning and preventing mistakes**: a full history or every issue, change, and discussion, new users or future develops can look back and learn why certain decisions were made{% if page %}, what worked and what didn’t, or how similar problem were solved, which in turn allows for better informed decision-making in the future{% endif %}. +1. **Continuous learning and preventing mistakes**: a full history or every issue, change, and discussion, new users or future developers can look back and learn why certain decisions were made{% if page %}, what worked and what didn’t, or how similar problem were solved, which in turn allows for better informed decision-making in the future{% endif %}. -1. **Gather Contextual Information**: extending the with contextual information facilitates the identification of a previous healthy state or breaking changes in dependencies{% if page %} thus making it easier to recover from mistakes, quickly identify or even prevent bug introduced external changes{% endif %}. +1. **Gather Contextual Information**: extending with contextual information facilitates the identification of a previous healthy state or breaking changes in dependencies{% if page %} thus making it easier to recover from mistakes, quickly identify or even prevent bugs introduced by external changes{% endif %}. -1. **Efficiency and Trust-Building**: keep track of an open discussion directly where the changes are made makes it easier to find information and builds trust{%if page %} (vs. long-chains of e-mails and endless meetings){% endif %}. +1. **Efficiency and Trust-Building**: keep track of an open discussion directly where the changes are made, makes it easier to find information and builds trust{%if page %} (vs. long-chains of e-mails and endless meetings){% endif %}. {% if slide %} From b0f2e892c23669f072ad924e11414cfd32fdcb04 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:25:19 +0200 Subject: [PATCH 15/20] typos --- .../project_management/feature_branch_reload/index.md | 2 +- .../project_management/feature_branch_reload/workflow.md | 4 ++-- .../content/project_management/git_plus_remote_tools.md | 8 ++++---- source/content/project_management/index.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/source/content/project_management/feature_branch_reload/index.md b/source/content/project_management/feature_branch_reload/index.md index e6ef991..2c085f0 100644 --- a/source/content/project_management/feature_branch_reload/index.md +++ b/source/content/project_management/feature_branch_reload/index.md @@ -1,6 +1,6 @@ ## Feature Branch Approach - _reloaded_ {% if page %} -Now that we know some of the [Collaboration Tools](./../../remote_service_features/collaboration_tools/index.md#collaboration-tools) remotes services provide we can revise the [✨Feature✨ Branch Approach](https://t4d-gmbh.github.io/working-with-git/content/feature_branch/index.html) from our course [working-with-git](https://t4d-gmbh.github.io/working-with-git/). +Now that we know some of the [Collaboration Tools](./../../remote_service_features/collaboration_tools/index.md#collaboration-tools) remotes services provide, we can revise the [✨Feature✨ Branch Approach](https://t4d-gmbh.github.io/working-with-git/content/feature_branch/index.html) from our course [working-with-git](https://t4d-gmbh.github.io/working-with-git/). Let us quickly recall that a "Feature Branch" is a branch dedicated for the implementation of a distinct functionality, attribute, or similar and it should be intuitively clear that a collaborative context requires some form of documentation for the feature itself and ideally for the process of its implementation, as well. {% else %} diff --git a/source/content/project_management/feature_branch_reload/workflow.md b/source/content/project_management/feature_branch_reload/workflow.md index fd1164a..644e711 100644 --- a/source/content/project_management/feature_branch_reload/workflow.md +++ b/source/content/project_management/feature_branch_reload/workflow.md @@ -7,8 +7,8 @@ Allows to perform steps **2** and **3** in a combined manner. {% if page %}##### {% endif %}1. **Create an Issue** 📝{% if slide %} Define and plan feature{% endif %} {% if page %} - **Identify the Feature**: Start by identifying the feature you want to develop. -- **Check for similar Issues**: It is always a good practice check for existing Issues, no need to create duplicates if an identical or similar Issue already exists. -- **Create an Issue**: Include details: +- **Check for similar Issues**: It is always a good practice check for existing Issues; there's no need to create duplicates if an identical or similar Issue already exists. +- **Formulate the Issue**: Include details: - Description of the feature - Acceptance criteria - Any relevant design mockups or specifications diff --git a/source/content/project_management/git_plus_remote_tools.md b/source/content/project_management/git_plus_remote_tools.md index b4e3962..03d55f6 100644 --- a/source/content/project_management/git_plus_remote_tools.md +++ b/source/content/project_management/git_plus_remote_tools.md @@ -3,7 +3,7 @@ {% if page %} With we posses a powerful tool to structure how we develop the content of a repository. Tools like Issues and Merge/Pull Request, provided by remote services, allow us to extensively document and track activities around any sort of plans, ideas, issues (not an Issue!), questions and suggestions. -What we are still missing is to learn how events and actions in relate to events and actions within these remote tools, and vice-versa. +What we are still missing is how events and actions in relate to events and actions within these remote tools, and vice-versa. As a start, let's simply clarify that: {% endif %} @@ -13,10 +13,10 @@ Some remote services can trigger events and actions in **GitHub** and **GitLab** there are many such triggers and it is not the goal here to provide a list of them. However, we would like to point out, that these triggers generally aim to synchronize the life-cycle of typical workflows. -For example, pushing a new branch to the remote server will trigger the suggestion to create a Merge/Pull Request. Or merging one branch into another will close any open Merge/Pull Requests that has the one branch as source branch and the other as target branch. +For example, pushing a new branch to the remote server will trigger the suggestion to create a Merge/Pull Request. Or merging one branch into another will close any open Merge/Pull Requests that has the branch as source branch and the other as target branch. -Even though remote services implement triggers in both directions, the underlying purpose of such triggers it clearly to position tools like Issues and Merge/Pull Requests as interfaces capable to reflect events and abstract some operations. +Even though remote services implement triggers in both directions, the underlying purpose of such triggers is clearly to position tools like Issues and Merge/Pull Requests as interfaces capable to reflect events and abstract some operations. {% endif %} ```{epigraph} -In doing so remote services integrate typical workflows, like creating or merging a branch, into project management workflows performed with their collaboration tools. +In doing so, remote services integrate typical workflows, like creating or merging a branch, into project management workflows performed with their collaboration tools. ``` diff --git a/source/content/project_management/index.md b/source/content/project_management/index.md index 120ba74..0b2b598 100644 --- a/source/content/project_management/index.md +++ b/source/content/project_management/index.md @@ -3,7 +3,7 @@ ```{epigraph} The process of planning, executing and closing a project within a defined timeline and budged. ``` -In this course we will focus on transcribing this very general definition into the context of and its remote services, more precisedly **GitHub** and **GitLab**. +In this course we will focus on transcribing this very general definition into the context of and its remote services, more precisely **GitHub** and **GitLab**. {% if slide %} From ec5857e978248209eac8263dcf0631e487776977 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:25:43 +0200 Subject: [PATCH 16/20] extended with reporting a bug in an issue --- .../content/project_management/feature_branch_reload/workflow.md | 1 + 1 file changed, 1 insertion(+) diff --git a/source/content/project_management/feature_branch_reload/workflow.md b/source/content/project_management/feature_branch_reload/workflow.md index 644e711..2a3add2 100644 --- a/source/content/project_management/feature_branch_reload/workflow.md +++ b/source/content/project_management/feature_branch_reload/workflow.md @@ -13,6 +13,7 @@ Allows to perform steps **2** and **3** in a combined manner. - Acceptance criteria - Any relevant design mockups or specifications - Priority and estimated effort + - If it is a bug, include steps to reproduce and state the expected behavior {% endif %} {% if page %}##### {% endif %}2. **Create a Feature Branch** 🌿{% if slide %} Branch from healthy reference{% endif%} From c038c9a8ddc90f19591ede9dcc5a82501192660f Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:29:47 +0200 Subject: [PATCH 17/20] typos --- .../project_management/feature_branch_reload/workflow.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/content/project_management/feature_branch_reload/workflow.md b/source/content/project_management/feature_branch_reload/workflow.md index 2a3add2..05c5627 100644 --- a/source/content/project_management/feature_branch_reload/workflow.md +++ b/source/content/project_management/feature_branch_reload/workflow.md @@ -38,9 +38,9 @@ Allows to perform steps **2** and **3** in a combined manner. {% if page %}##### {% endif %}3. **Create a Merge/Pull Request** 🔄{% if slide %} Push branch to remote and link to Issue (e.g. "Closes #123"){% endif %} {% if page %} - **Push the Branch**: Once the feature is complete and tested, push the feature branch to the remote repository. -- **Open a Merge Request**: Create a merge request (MR) or pull request (PR) in your version control system (e.g., GitHub, GitLab, Bitbucket). In the MR/PR: +- **Formulate a Merge/Pull Request**: Create a merge request (MR) or pull request (PR) on GitHub, GitLab, etc. In the MR/PR: - Reference the original issue (e.g., "Closes #123") to link the feature to the issue. - - Provide a description of the changes made and any relevant context. + - Provide a description of the changes that you made and any relevant context. - Specify any additional reviewers or stakeholders. :::{note} A common suggestion is to create a Merge/Pull Request **after having implemented** the feature (i.e. after [5. **Test the Feature**](#test-the-feature)). From b606697164678672381969609e4da3407ee69d76 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Wed, 23 Oct 2024 19:34:31 +0200 Subject: [PATCH 18/20] typos --- source/content/contributing/step_by_step.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/content/contributing/step_by_step.md b/source/content/contributing/step_by_step.md index 71751e7..5e9ea7f 100644 --- a/source/content/contributing/step_by_step.md +++ b/source/content/contributing/step_by_step.md @@ -4,7 +4,7 @@ {% else %} - Browse existing Issues - {octicon}`issue-opened;0.8em` open and {octicon}`issue-closed;0.8em` closed ones - to see if the same or a similar Issue was already created. - If your Issue exists already, check for related Merge/Pull Requests and if they implement what you had in mind. - If not, scip the next step (i.e. don't create a new {octicon}`issue-opened;0.8em` Issue) and simply proceed with step 3. **Read Documentation**. + If not, skip the next step (i.e. don't create a new {octicon}`issue-opened;0.8em` Issue) and simply proceed with step 3. **Read Documentation**. {% endif %} {% if page %}##### {% endif %}2. **Open an {octicon}`issue-opened;0.8em` Issues** 📝{% if slide %} Explain why some work needs to be done. @@ -31,7 +31,7 @@ For smaller changes you might directly work on the healthy reference (i.e. **`main`**) of the forked repository. Bigger changes should be implemented in a separate branch following the feature branch approach, for example. - Follow the project's coding style and guidelines. - - Make sure the branch you implement the changes in remains up to date with the target branch from to repository. + - Make sure the branch on which you implement the changes, remains up to date with the target branch from to repository. - Test and document your changes. {% endif %} @@ -48,11 +48,11 @@ {% else %} - Engage with project maintainers and other contributors during the review process. - Be open to feedback and make any necessary revisions. - - Respect the maintainers decisions and adaptations, if you are not happy with them you can alwasy keep your forked repository and maintain it on your own! + - Respect the maintainers decisions and adaptations, if you are not happy with them you can always keep your forked repository and maintain it on your own! {% endif %} {% if page %}#### {% endif %}8. 🌟 **Stay Engaged** 🌟{% if slide %} {% else %} - - Once the Merge/Pull Request is merged or closed, feel free to delete your fork of the repository again. + - Once the Merge/Pull Request is merged or closed, feel free to delete your fork of the repository. This avoids confusion about which repository is the most up-to-date. - Continue to contribute to the project by helping with other issues or discussions. {% endif %} From b4163cf896c67199b6c5351ede0115fcd880a8f3 Mon Sep 17 00:00:00 2001 From: "Jonas I. Liechti" Date: Wed, 23 Oct 2024 20:33:56 +0200 Subject: [PATCH 19/20] Closes #24 - fixing urls for WO on GL --- .../content/remote_service_features/web_interface.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/content/remote_service_features/web_interface.md b/source/content/remote_service_features/web_interface.md index 41307b4..2af5656 100644 --- a/source/content/remote_service_features/web_interface.md +++ b/source/content/remote_service_features/web_interface.md @@ -13,8 +13,8 @@ Regarding visualizations for features, we provide som | Feature | GitLab Link | GitHub Link | |--------------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| -| **Current State** | [{octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/weekend-out) | [{octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out) | -| **Commits** | [{octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/weekend-out/-/commits/main) | [{octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/commits/main/) | -| **Branches** | [{octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/weekend-out/-/branches) | [{octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/branches) | -| **History Overview**| [{octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/weekend-out/-/network/main) | [{octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/network) | -| **Tags** | [{octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/weekend-out/-/tags) | [{octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/tags) +| **Current State** | [ {octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/teaching/gitws/weekend-out) | [ {octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out) | +| **Commits** | [ {octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/teaching/gitws/weekend-out/-/commits/main) | [ {octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/commits/main/) | +| **Branches** | [ {octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/teaching/gitws/weekend-out/-/branches) | [ {octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/branches) | +| **History Overview**| [ {octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/teaching/gitws/weekend-out/-/network/main) | [ {octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/network) | +| **Tags** | [ {octicon}`link-external;0.8em`](https://gitlab.com/t4d-gmbh/teaching/gitws/weekend-out/-/tags) | [ {octicon}`link-external;0.8em`](https://github.com/t4d-gmbh/Weekend-Out/tags) From a9ab787f1f2a1ca5a9f3abea8f4bd2bb5b4c7c18 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Thu, 24 Oct 2024 08:12:11 +0200 Subject: [PATCH 20/20] fixed one more url for WO on GL --- source/content/remote_service_features/web_interface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/content/remote_service_features/web_interface.md b/source/content/remote_service_features/web_interface.md index 2af5656..0783025 100644 --- a/source/content/remote_service_features/web_interface.md +++ b/source/content/remote_service_features/web_interface.md @@ -9,7 +9,7 @@ As such, the web interface porvides: Access to remote features and visualization of a variety of 's own features ``` -Regarding visualizations for features, we provide some specific links to these views for our **Weekend-Out** exercise repository that resides both [on **GitHub**](https://github.com/t4d-gmbh/Weekend-Out) and [on **GitLab**](https://github.com/t4d-gmbh/Weekend-Out). +Regarding visualizations for features, we provide some specific links to these views for our **Weekend-Out** exercise repository that resides both [on **GitHub**](https://github.com/t4d-gmbh/Weekend-Out) and [on **GitLab**](https://gitlab.com/t4d-gmbh/teaching/gitws/weekend-out). | Feature | GitLab Link | GitHub Link | |--------------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|