Skip to content

Commit

Permalink
update navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
Freymaurer committed Sep 17, 2024
1 parent a899765 commit e2a812b
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 27 deletions.
File renamed without changes
4 changes: 2 additions & 2 deletions src/components/Home/CommunityCards.astro
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import Card from '../Card.astro'
body="Find tools and services that assist you creating and managing your research data using the ARC."
/>
<Card
href="https://astro.build/themes/"
title="Support"
href="/"
title="Resources"
body="Explore tutorials, videos or find a community that can help."
/>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions src/components/Home/RDMGraphNavigation.astro
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { Color } from "../GraphNavigation.astro";
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: '#link4', text: 'Validation', angle: 180 },
{ id: 3, cx: 60, cy: 8, r: 5, href: '#link3', text: 'Continuous Integration', angle: 80 },
{ 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: '#link2', text: 'Versioning', angle: 250 },
{ id: 5, cx: 140, cy: 10, r: 5, href: URLS.INTERNAL_DEV_TOOLSTACK, text: 'Developer Toolstack', angle: 180 },
];
Expand Down
20 changes: 10 additions & 10 deletions src/components/Navbar.astro
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ import { URLS } from "../statics"
const links: Link[] = [
{href: URLS.INTERNAL_HOME, text: "Home"},
{text: "Research Community", children: [
{href: URLS.INTERNAL_COM_DATA_MANAGEMENT, text: "Data Management Principal 🚧"},
{href: URLS.INTERNAL_COM_DATA_MANAGEMENT, text: "Data Management Principle 🚧"},
{href: "/", text: "Tools and Services 🚧"},
{href: "/", text: "Support 🚧"},
{href: "/", text: "Resources 🚧"},
{text: "More", children: [
{href: URLS.INTERNAL_COM_DOCUMENTATION, text: "documentation principle 🚧"},
{href: URLS.INTERNAL_COM_ORGANIZATION, text: "organization principle 🚧"},
{href: URLS.INTERNAL_COM_DOCUMENTATION, text: "Documentation Principle"},
{href: URLS.INTERNAL_COM_ORGANIZATION, text: "Organization Principle"},
{href: "/", text: "quality control 🚧"},
{href: "/", text: "exchange & publication 🚧"},
{href: URLS.INTERNAL_COM_FAIRNESS, text: "RDM & FAIRness 🚧"},
{href: URLS.INTERNAL_COM_FAIRNESS, text: "RDM & FAIRness"},
]},
]},
{text: "RDM Community", children: [
{href: URLS.INTERNAL_DEV_DATA_MODEL, text: "ARC data model 🚧"},
{href: URLS.INTERNAL_DEV_REPRESENTATION, text: "ARC representation 🚧"},
{href: URLS.INTERNAL_DEV_DATA_MODEL, text: "ARC Data Model"},
{href: URLS.INTERNAL_DEV_REPRESENTATION, text: "ARC Representation"},
{href: "/", text: "ARC (meta)data framework 🚧"},
{text: "More", children: [
{href: URLS.INTERNAL_DEV_FDO, text: "FAIR Digital Object 🚧"},
{href: "/", text: "validation 🚧"},
{href: "/", text: "continuous Integration 🚧"},
{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_TOOLSTACK, text: "Developer Toolstack 🚧"},
]},
Expand Down
20 changes: 10 additions & 10 deletions src/pages/details/arc-hub.md → src/pages/details/arc-data-hub.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
---
layout: ../../layouts/MarkdownLayout.astro
title: 'ARCHub: Bring your ARCs to the cloud'
title: 'ARC Data Hub: Bring your ARCs to the cloud'
pubDate: 2024-09-10
description: 'The ARCHub concept applies the software development principles of CI/CD to the research data management framework provided by ARCs, making ARCs first-class citizens in the cloud.'
description: 'The ARC Data Hub concept applies the software development principles of CI/CD to the research data management framework provided by ARCs, making ARCs first-class citizens in the cloud.'
author: 'Kevin Schneider'
image:
url: 'https://docs.astro.build/assets/rose.webp'
alt: 'The Astro logo on a dark background with a pink glow.'
tags: ["validation", "quality control", "unit testing", "CI","CD", "continuous integration", "continuous deployment", "continuous quality control"]
---

The **ARCHub** concept applies the software development principles of _Continuous Integration (CI)_ and _Continuous Deployment (CD)_ to the research data management (RDM) framework provided by ARCs, making ARCs first-class citizens in the cloud.
The **ARC Data Hub** concept applies the software development principles of _Continuous Integration (CI)_ and _Continuous Deployment (CD)_ to the research data management (RDM) framework provided by ARCs, making ARCs first-class citizens in the cloud.
ARCs can be continuously validated, built, and deployed much like software.
By using CI/CD for a set of subsequently defined tasks, many collaborative cloud platforms such as GitLab, GitHub, or Bitbucket can be used to build an ARCHub.
By using CI/CD for a set of subsequently defined tasks, many collaborative cloud platforms such as GitLab, GitHub, or Bitbucket can be used to build an ARC Data Hub.

![ARCHub leverages CI/CD capabilities to build, deploy, and validate ARCs](/arc-website/archub-overview.png)
![ARC Data Hub leverages CI/CD capabilities to build, deploy, and validate ARCs](/arc-website/arc-data-hub-overview.png)

## Continuous Deployment

CD can be used to continuously deploy ARC artifacts such as metadata export formats, computational results, etc. to another environment.

ARCHubs use CD to build and deploy the [ARC-RO-Crate metadata]({{INTERNAL_DEV_REPRESENTATION_RO_CRATE}}) of each commit to a central package registry.
ARC Data Hubs use CD to build and deploy the [ARC-RO-Crate metadata]({{INTERNAL_DEV_REPRESENTATION_RO_CRATE}}) of each commit to a central package registry.
This way, both [representations of the ARC]({{INTERNAL_DEV_REPRESENTATION}}) are always in sync and accessible, deploying both a user-centric and a machine-readable view on the ARC.

![ARCHubs use CD to build and deploy the ARC-RO-Crate metadata](/arc-website/ci-cd-arc-application.png)
![ARC Data Hubs use CD to build and deploy the ARC-RO-Crate metadata](/arc-website/ci-cd-arc-application.png)

## Continuous Integration

Incremental changes on ARCs can be used to trigger _integrations_.
ARCHubs can run a user-selected set of validation packages on each commit or pull request to verify that an ARC is still _valid_ for the targets of choice after the change is done .
ARC Data Hubs can run a user-selected set of validation packages on each commit or pull request to verify that an ARC is still _valid_ for the targets of choice after the change is done .

Furthermore, the validation package output can be used to continuously inform the user about the current state of the ARC, for example by creating badges on the ARC page, much like the widely known `build and test` badges in software development.

Expand All @@ -37,8 +37,8 @@ Furthermore, the validation package output can be used to continuously inform th
Continuous Quality Control (CQC) is a combination of CI and CD that integrates external services depending on the result of ARC validation.
Successful validation can trigger downstream applications, either automatically or manually via _CQC Hooks_.

The [PLANTdataHUB]({{DATAPLANT_ARCHUB}}) serves as a reference implementation of an ARCHub, centrally hosted by the NFDI DataPLANT for the plant research community.
Beyond its core functionality as an ARCHub, it incorporates **CQC** within the data publication pipeline, ensuring that all required metadata for publication is complete and accurate.
The [PLANTdataHUB]({{DATAPLANT_ARC_HUB}}) serves as a reference implementation of an ARC Data Hub, centrally hosted by the NFDI DataPLANT for the plant research community.
Beyond its core functionality as an ARC Data Hub, it incorporates **CQC** within the data publication pipeline, ensuring that all required metadata for publication is complete and accurate.

CQC also supports submissions to various endpoint repositories, provided the corresponding validation package and downstream submission application are available.
This flexible system ensures that ARC submissions meet the necessary standards for different repositories, enabling seamless integration and data sharing across platforms.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/details/arc-fdo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: ../../layouts/MarkdownLayout.astro
title: 'FAIR Digital Objects'
title: 'ARCs are FAIR Digital Objects'
pubDate: 2024-09-13
description: 'ARCs RO-crates are FAIR Digital Objects.'
author: 'Timo Mühlhaus'
Expand Down
5 changes: 3 additions & 2 deletions src/statics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ export enum URLS {
INTERNAL_DEV_REPRESENTATION_RO_CRATE = BASE_PATH + "/details/arc-representation#arc-ro-crate",
INTERNAL_DEV_FDO = BASE_PATH + "/details/arc-fdo",
INTERNAL_DEV_TOOLSTACK= BASE_PATH + "/details/developer-toolstack",
INTERNAL_DEV_ARCHUB = BASE_PATH + "/details/arc-hub",
INTERNAL_DEV_ARC_DATA_HUB = BASE_PATH + "/details/arc-data-hub",
INTERNAL_DEV_VALIDATION = BASE_PATH + "/details/validation",

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

DATAPLANT_ARCHUB = "https://git.nfdi4plants.org",
DATAPLANT_ARC_HUB = "https://git.nfdi4plants.org",
DATAPLANT_KNOWLEDGEBASE = "https://knowledgebase.nfdi4plants.org",
}

0 comments on commit e2a812b

Please sign in to comment.