Merge pull request #341 from akirbis/main

ARCmanager manual v1 for DataPLANT knowledge base

src/docs/ARCmanager-manual/how_to.md

@@ -0,0 +1,29 @@
+---
+layout: docs
+title: How to use the ARCmanager
+author:
+- name: Alexander Kirbis
+  github: https://github.com/akirbis
+  orcid: https://orcid.org/0000-0002-5667-3103
+add toc: true
+add sidebar: _sidebars/mainSidebar.md
+status: published
+date: 2024-01-08
+---
+
+Using the ARCmanager does not require any prior software setup or similar. However, a basic understanding of the [ARC concept](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/implementation/AnnotatedResearchContext.html) and other DataPLANT services, in particular the [DataHUBs](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/DataHUB-Manual/index.html), is beneficial.
+
+To get started, visit the [ARCmanager domain](https://nfdi4plants.de/arcmanager/app/index.html) with a web browser of your choice.
+
+On the left side, select a DataHUB of your choice and click on the 'Login' button. You will be forwarded to the login page of the selected DataHUB. After entering your credentials, you have to confirm that the ARCmanager service is allowed to access and modify your ARCs on this DataHUB.
+
+<p float="center">
+    <img src="./img/001.png" width="300" />
+    <img src="./img/002.png" width="436" />
+</p>
+
+You will then be redirected to the ARCmanager webpage again. Now, that you are logged in, you can load all publicly available ARCs and the ARCs that are owned by you (highlighted in yellow). You can view details of your ARCs, edit files, add new studies or assays, or edit metadata annotation sheets. Clicking on the 'New ARC' button on the left side will guide you through the process of creating a new ARC.
+
+![w:800](./img/003.png)
+
+A more detailed user guide will follow soon. In the meantime, we encourage users to experiment with the web service. You don't need to be afraid to mess up your ARCs, since the version control feature of all DataHUBs allows undoing all changes that were made through the ARCmanager. On the same note, we have intentionally not included a 'Delete ARC' feature for the time being to prevent all possibilities of data loss. If you want to delete a test ARC or similar, this is best done through the homepage of the corresponding DataHUB.

src/docs/ARCmanager-manual/index.md

@@ -0,0 +1,41 @@
+---
+layout: docs
+title: ARCmanager manual
+author:
+- name: Alexander Kirbis
+  github: https://github.com/akirbis
+  orcid: https://orcid.org/0000-0002-5667-3103
+add toc: false
+add sidebar: _sidebars/mainSidebar.md
+status: published
+date: 2024-01-08
+---
+
+Welcome to the ARCmanager manual!
+
+Here, you can find detailed information about the ARCmanager web service.
+
+For further details, please visit our sub pages:
+
+1. [What is the ARCmanager?](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ARCmanager-manual/intro.html)
+2. [How to use the ARCmanager](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ARCmanager-manual/how_to.html)
+
+## What is the ARCmanager?
+
+The ARCmanager is a web service that allows DataPLANT users to create and modify ARCs in a web browser environment. Edits done with the ARCmanager will be directly applied to the copy of your ARC on the respective DataHUB.
+
+The primary purpose of the ARCmanager is to create new ARCs and edit existing ones. A particular focus is on the administrative metadata associated with ARCs, but we are currently exploring solutions to provide the function to upload large experimental datasets as well.
+
+-----------------------
+
+:bulb: IMPORTANT NOTE
+
+The ARCmanager web service is currently in development. The service can be unavailable for short time periods and unintended behavior of the service can occur. We are constantly working on improving the service and appreciate any bug reports and constructive feedback.
+
+If you encounter any issues or have suggestions how to improve the service, please consider opening a new issue in one of the project related github repositories:
+
+https://github.com/nfdi4plants/arcmanager_frontend
+
+https://github.com/nfdi4plants/arcmanager_backend
+
+-------------------------

src/docs/ARCmanager-manual/intro.md

@@ -0,0 +1,18 @@
+---
+layout: docs
+title: What is the ARCmanager?
+author:
+- name: Alexander Kirbis
+  github: https://github.com/akirbis
+  orcid: https://orcid.org/0000-0002-5667-3103
+add toc: true
+add sidebar: _sidebars/mainSidebar.md
+status: published
+date: 2024-01-08
+---
+
+The ARCmanager is a web service that allows DataPLANT users to create and modify ARCs in a web browser environment. Edits done with the ARCmanager will be directly applied to the copy of your ARC on the respective DataHUB.
+
+While the [ARC Commander](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ArcCommanderManual/index.html) provides a command line interface (CLI) to create and modify ARCs, and the [ARCitect](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ARCitect-Manual/index.html) is a desktop application to perform similar tasks with a graphical user interface (GUI), the ARCmanager provides an easily accessible web interface. 
+
+The primary purpose of the ARCmanager is to create new ARCs and edit existing ones. A particular focus is on the administrative metadata associated with ARCs, but we are currently exploring solutions to provide the function to upload large experimental datasets as well. In the mean time large data files are best uploaded by using one of the other two aforementioned services. 

src/docs/_sidebars/mainSidebar.md

@@ -61,6 +61,10 @@
 ## [Installation - Linux](/docs/ARCitect-Manual/arcitect_installation_linux.html)
 ## [QuickStart](/docs/guides/arcitect_QuickStart.html)
 
+# [ARCmanager Manual](/docs/ARCmanager-manual/index.html)
+## [What is the ARCmanager?](/docs/ARCmanager-manual/intro.html)
+## [How to use the ARCmanager](/docs/ARCmanager-manual/how_to.html)
+
 # [Swate Manual](/docs/SwateManual/index.html)
 ## [Swate Installation](/docs/SwateManual/Docs01-Installing-Swate.html)
 ### [Excel Browser](/docs/SwateManual/swate_installation_browser.html)