Skip to content

Commit

Permalink
Merge pull request #60 from nfdi4plants/git
Browse files Browse the repository at this point in the history
Git
  • Loading branch information
HLWeil authored Sep 19, 2024
2 parents 372f91b + 2616a40 commit e722436
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 2 deletions.
Binary file added public/git-collaboration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/git-fairification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/components/Home/RDMGraphNavigation.astro
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const circles = [
{ id: 1, cx: 8, cy: 25, r: 5, href: URLS.INTERNAL_DEV_FDO, text: 'FAIR Digital Object', angle: 20 },
{ id: 2, cx: 30, cy: 40, r: 5, href: URLS.INTERNAL_DEV_VALIDATION, text: 'Validation', angle: 180 },
{ id: 3, cx: 60, cy: 8, r: 5, href: URLS.INTERNAL_DEV_ARC_DATA_HUB, text: 'ARC Data Hub', angle: 80 },
{ id: 4, cx: 90, cy: 40, r: 5, href: '#', text: 'Versioning', angle: 250 },
{ id: 4, cx: 90, cy: 40, r: 5, href: URLS.INTERNAL_DEV_VERSIONING, text: 'Versioning', angle: 250 },
{ id: 5, cx: 140, cy: 10, r: 5, href: URLS.INTERNAL_DEV_TOOLSTACK, text: 'Developer Toolstack', angle: 180 },
];
---
Expand Down
2 changes: 1 addition & 1 deletion src/components/Navbar.astro
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const links: Link[] = [
{href: URLS.INTERNAL_DEV_FDO, text: "FAIR Digital Object"},
{href: URLS.INTERNAL_DEV_VALIDATION, text: "Validation"},
{href: URLS.INTERNAL_DEV_ARC_DATA_HUB, text: "ARC Data Hub"},
{href: "#", text: "versioning 🚧"},
{href: URLS.INTERNAL_DEV_VERSIONING, text: "Versioning"},
{href: URLS.INTERNAL_DEV_TOOLSTACK, text: "Developer Toolstack"},
]},
]},
Expand Down
25 changes: 25 additions & 0 deletions src/pages/details/versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
layout: ../../layouts/MarkdownLayout.astro
title: 'Versioning'
pubDate: 2024-09-18
description: 'ARCs are not static FDOs, but can be continuously and collaboratively FAIRified, supported by Git versioning.'
author: 'Heinrich Lukas Weil'
image:
tags: ["Git", "FAIR Digital Object"]
---

Applying the FAIR principles onto a dataset requires ticking numerous different checkmarks. For many experimental life-cycles, this FAIRification process is triggered when publication of the research draws near. But this comes with a plethora of potential problems. Most importantly, these publications can only provide a single, *immutable* snapshot of the research.

## Immutable yet evolving

In reality, research is a continuous process both preceeding and succeeding the publication, i.e. an evolving sequence of snapshots, including intermediate or negative results. Therefore, a method is needed to allow applying the FAIR principles incrementally, accompanying the whole research cycle. For this, ARCs inherit a well established concept from Software Development for making the process of collection, annotation, and analysis of data more dynamic, namely versioning. For this, all ARCs are also Git repositories.

![Git Fairification](/arc-website/git-fairification.png)

Using Git allows for the ARC to grow together with the experiment, possibly even across multiple publications. Besides this, ARCs can be shared across any Git-based platform. With Git being this wide-spread, there exist numerous hosting solutions, both publicly available and on-premise.

As research is becoming increasingly multi-disciplinary, collaboration is usually a given. This collaboration should also extend to the process of fostering the ARC, as most information about an area of research can be provided by the expert conducting it. Git has well-established capabilities and workflows to allow both parallel and sequential collaboration, ensuring sanity of information and provenance of the contributor.

![Git Collaboration](/arc-website/git-collaboration.png)

Data is an integral part of ARCs and Data size can vary vastly accross different scientific domains. In order to handle large files, which can be problematic, Git LFS is used in ARCs. By this extension, the standard Git operations can be used a usual, with additional LFS capabilities being available.
17 changes: 17 additions & 0 deletions src/pages/dictionary/git-lfs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: ../../layouts/MarkdownLayout.astro
title: 'Git LFS'
pubDate: 2024-09-18
description: 'Extension of git version control system, which allows handling of large files.'
author: 'Heinrich Lukas Weil'
image:
url: 'https://docs.astro.build/assets/rose.webp'
alt: 'The Astro logo on a dark background with a pink glow.'
tags: ["tools", "git", "data", "versioning"]
keywords: ["Git LFS"]
url: "git-lfs"
---

# Git **L**arge **F**ile **S**ystem

Find out more about Git LFS on the [official website](https://git-lfs.com/).
17 changes: 17 additions & 0 deletions src/pages/dictionary/git.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: ../../layouts/MarkdownLayout.astro
title: 'Git'
pubDate: 2024-09-18
description: 'Version control system, which keeps track of repositories by saving comparable snapshots called commits.'
author: 'Heinrich Lukas Weil'
image:
url: 'https://docs.astro.build/assets/rose.webp'
alt: 'The Astro logo on a dark background with a pink glow.'
tags: ["tools", "git", "versioning"]
keywords: ["Git"]
url: "git"
---

# Git

Find out more about Git on the [official website](https://git-scm.com/).
1 change: 1 addition & 0 deletions src/statics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export enum URLS {
INTERNAL_DEV_TOOLSTACK= BASE_PATH + "details/developer-toolstack",
INTERNAL_DEV_ARC_DATA_HUB = BASE_PATH + "details/arc-data-hub",
INTERNAL_DEV_VALIDATION = BASE_PATH + "details/validation",
INTERNAL_DEV_VERSIONING = BASE_PATH + "details/versioning",

GITHUB_REPO = "https://github.com/nfdi4plants/arc-website",

Expand Down

0 comments on commit e722436

Please sign in to comment.