Merge pull request #217 from nfdi4plants/datahub-fork

add datahub guide "fork"
nfdi4plants · Aug 3, 2023 · 595dbbc · 595dbbc
2 parents b6f4058 + e486078
commit 595dbbc
Show file tree

Hide file tree

Showing 5 changed files with 226 additions and 0 deletions.
diff --git a/src/docs/DataHUB-Manual/datahub-fork.md b/src/docs/DataHUB-Manual/datahub-fork.md
@@ -0,0 +1,36 @@
+---
+layout: docs
+title: Forks
+date: 2023-08-03
+author:
+- name: Dominik Brilhaus
+  orcid: https://orcid.org/0000-0001-9021-3197
+  github: brilator
+add toc: true
+add support: true
+add sidebar: _sidebars/mainSidebar.md
+---
+
+The DataHUB allows to "fork" an ARC. This creates an exact copy of an ARC under a different user or group account while staying connected to the original ARC.
+
+
+1. Navigate to the ARC that you would like to fork and click "Fork" in the top-right corner (1).
+
+<img src="./../img/datahub-fork01.drawio.svg" style="width:70%;display: block;margin: 20px auto;">
+
+2. In the fork menu you can
+   - adapt the name (1) of the ARC (your fork),
+   - select a namespace (2), i.e. your user or a group name,
+   - adapt the project slug (3)
+
+:bulb: Note that these options change the display name and URL of your fork of the ARC. The original ARC stays unchanged.
+
+:bulb: The visibility level (4) and access permissions are inherited from the original ARC. 
+
+<img src="./../img/datahub-fork02.drawio.svg" style="width:80%;display: block;margin: 20px auto;">
+
+3. Once forked, you can work on your fork. 
+  - In the ARC panel you can see the adapted name that you chose for the ARC (1). 
+  - You can recognize that this is a forked ARC and navigate to the original source (2).
+
+<img src="./../img/datahub-fork03.drawio.svg" style="width:100%;display: block;margin: 20px auto;">
diff --git a/src/docs/_sidebars/mainSidebar.md b/src/docs/_sidebars/mainSidebar.md
@@ -81,6 +81,7 @@
 ### [Generate a Personal Access Token (PAT)](/docs/guides/datahub-GeneratePAT.html)
 ## [Projects Panel](/docs/DataHUB-Manual/datahub-projectsPanel.html)
 ## [ARC Panel](/docs/DataHUB-Manual/datahub-ARCPanel.html)
+### [Forks](/docs/DataHUB-Manual/datahub-fork.html)
 ### [Working with files](/docs/DataHUB-Manual/datahub-files.html)
 ### [ARC Settings](/docs/DataHUB-Manual/datahub-ARCSettings.html)
 ### [ARC Wiki](/docs/DataHUB-Manual/datahub-ARCWiki.html)

diff --git a/src/docs/img/datahub-fork01.drawio.svg b/src/docs/img/datahub-fork01.drawio.svg
diff --git a/src/docs/img/datahub-fork02.drawio.svg b/src/docs/img/datahub-fork02.drawio.svg
diff --git a/src/docs/img/datahub-fork03.drawio.svg b/src/docs/img/datahub-fork03.drawio.svg